Class ClientContext`Experimental`

Experimental draft ACP v2 context used by clients to call agent-side ACP methods.

connectWith passes a ClientContext to the callback. Client handlers also receive one as ctx.agent when they need to call back into the agent.

Hierarchy

AcpContext
- ClientContext

Index

Accessors

Methods

buildSession request notify batch

Accessors

requestId

get requestId(): JsonRpcId | undefined
Experimental
JSON-RPC id of the request currently being handled.

This is undefined for notification handlers and for contexts created outside an inbound request, such as connect(...) and connectWith(...).

Returns JsonRpcId | undefined
Inherited from AcpContext.requestId
- Defined in v2/acp.ts:412

Methods

buildSession

buildSession(cwd: string): SessionBuilder
Experimental
Creates a builder for starting and observing an ACP session.

Pass an absolute path for the common case where only cwd is needed, or pass a full NewSessionRequest when you need MCP servers, _meta, or additional session fields.
Parameters
- cwd: string
Returns SessionBuilder
- Defined in v2/acp.ts:573
buildSession(request: NewSessionRequest): SessionBuilder
Experimental
Creates a builder for starting and observing an ACP session.

Pass an absolute path for the common case where only cwd is needed, or pass a full NewSessionRequest when you need MCP servers, _meta, or additional session fields.
Parameters
- request: NewSessionRequest
Returns SessionBuilder
- Defined in v2/acp.ts:574

request

request<Method extends AgentRequestMethod>(
    method: Method,
    params: AgentRequestParamsByMethod[Method],
    options?: SendRequestOptions,
): Promise<AgentRequestResponsesByMethod[Method]>
Experimental
Sends a request to the agent by ACP method name.

Built-in method literals infer their params and response types. Custom methods can specify their response and params types with generics.
Type Parameters
- Method extends AgentRequestMethod
Parameters
- method: Method
- params: AgentRequestParamsByMethod[Method]
- Optionaloptions: SendRequestOptions
Returns Promise<AgentRequestResponsesByMethod[Method]>
- Defined in v2/acp.ts:652
request<Response = unknown, Params = unknown>(
    method: string,
    params?: Params,
    options?: SendRequestOptions,
): Promise<Response>
Experimental
Sends a request to the agent by ACP method name.

Built-in method literals infer their params and response types. Custom methods can specify their response and params types with generics.
Type Parameters
- Response = unknown
- Params = unknown
Parameters
- method: string
- Optionalparams: Params
- Optionaloptions: SendRequestOptions
Returns Promise<Response>
- Defined in v2/acp.ts:657

notify

notify<Method extends AgentNotificationMethod>(
method: Method,
params: AgentNotificationParamsByMethod[Method],
): Promise<void>
Experimental
Sends a notification to the agent by ACP method name.

Built-in method literals infer their params type. Custom notifications can specify their params type with a generic.
Type Parameters
- Method extends AgentNotificationMethod
Parameters
- method: Method
- params: AgentNotificationParamsByMethod[Method]
Returns Promise<void>
- Defined in v2/acp.ts:683
notify<Params = unknown>(method: string, params?: Params): Promise<void>
Experimental
Sends a notification to the agent by ACP method name.

Built-in method literals infer their params type. Custom notifications can specify their params type with a generic.
Type Parameters
- Params = unknown
Parameters
- method: string
- Optionalparams: Params
Returns Promise<void>
- Defined in v2/acp.ts:687

batch

batch<const Entries extends readonly BatchEntry[]>(
entries: Entries & { "0": BatchEntry },
): Promise<BatchOutputs<Entries>>
Experimental
Sends requests and notifications to the agent as one JSON-RPC batch.
Type Parameters
- const Entries extends readonly BatchEntry[]
Parameters
- entries: Entries & { "0": BatchEntry }
Returns Promise<BatchOutputs<Entries>>
- Defined in v2/acp.ts:701