ProtocolsAPI
Defined in: namespaces-core-plugins.ts:595
Host-managed supervised subprocesses with stdio / jsonrpc-stdio framing and MCP / LSP wrappers (fn-96). Sidecars run as native non-sandboxed processes (Independent/Developer ID distribution only).
fn-96
Methods
Section titled “Methods”registerSidecar()
Section titled “registerSidecar()”registerSidecar(
definition):Promise<string>
Defined in: namespaces-core-plugins.ts:597
Registers a sidecar definition. Returns definitionId. [sidecars.definition.register]
Parameters
Section titled “Parameters”definition
Section titled “definition”Returns
Section titled “Returns”Promise<string>
unregisterSidecar()
Section titled “unregisterSidecar()”unregisterSidecar(
definitionId):Promise<void>
Defined in: namespaces-core-plugins.ts:599
Unregisters a sidecar definition.
Parameters
Section titled “Parameters”definitionId
Section titled “definitionId”string
Returns
Section titled “Returns”Promise<void>
getSidecar()
Section titled “getSidecar()”getSidecar(
definitionId):Promise<AnyJSONValue>
Defined in: namespaces-core-plugins.ts:601
Gets a sidecar snapshot, or null (unified anti-enum read gate).
Parameters
Section titled “Parameters”definitionId
Section titled “definitionId”string
Returns
Section titled “Returns”Promise<AnyJSONValue>
call()
Section titled “call()”call(
sidecarId,method,params,options?):Promise<AnyJSONValue>
Defined in: namespaces-core-plugins.ts:603
Calls a sidecar method. [sidecars.instance.start]
Parameters
Section titled “Parameters”sidecarId
Section titled “sidecarId”string
method
Section titled “method”string
params
Section titled “params”options?
Section titled “options?”Returns
Section titled “Returns”Promise<AnyJSONValue>
callStreaming()
Section titled “callStreaming()”callStreaming(
sidecarId,method,params,onChunk,options?):Promise<AnyJSONValue>
Defined in: namespaces-core-plugins.ts:605
Streaming call — onChunk fires per chunk; promise resolves with the final result.
Parameters
Section titled “Parameters”sidecarId
Section titled “sidecarId”string
method
Section titled “method”string
params
Section titled “params”onChunk
Section titled “onChunk”(chunk) => void
options?
Section titled “options?”Returns
Section titled “Returns”Promise<AnyJSONValue>
subscribe()
Section titled “subscribe()”subscribe(
sidecarId,eventName,handler):Promise<{subscriptionToken:string; }>
Defined in: namespaces-core-plugins.ts:607
Subscribes to a sidecar event.
Parameters
Section titled “Parameters”sidecarId
Section titled “sidecarId”string
eventName
Section titled “eventName”string
handler
Section titled “handler”(event) => void
Returns
Section titled “Returns”Promise<{ subscriptionToken: string; }>
unsubscribe()
Section titled “unsubscribe()”unsubscribe(
subscriptionToken):Promise<void>
Defined in: namespaces-core-plugins.ts:609
Cancels a sidecar event subscription.
Parameters
Section titled “Parameters”subscriptionToken
Section titled “subscriptionToken”string
Returns
Section titled “Returns”Promise<void>