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

initialized requestId

Methods

buildSession request notify batch

Accessors

initialized

get initialized(): Promise<
Readonly<{ request: InitializeRequest; response: InitializeResponse }>,
>
Experimental
Validated initialize exchange, once this connection is initialized.

Returns Promise<Readonly<{ request: InitializeRequest; response: InitializeResponse }>>
Inherited from AcpContext.initialized
- Defined in v2/stable/acp.ts:919

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/stable/acp.ts:932

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/stable/acp.ts:1134
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/stable/acp.ts:1135

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/stable/acp.ts:1178
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/stable/acp.ts:1183
request<
    Response = unknown,
    Params = unknown,
    const Method extends string = never,
>(
    method: UnrecognizedMethod<Method>,
    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
- const Method extends string = never
Parameters
- method: UnrecognizedMethod<Method>
- Optionalparams: Params
- Optionaloptions: SendRequestOptions
Returns Promise<Response>
- Defined in v2/stable/acp.ts:1188

notify

notify<Method extends "session/cancel">(
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 "session/cancel"
Parameters
- method: Method
- params: AgentNotificationParamsByMethod[Method]
Returns Promise<void>
- Defined in v2/stable/acp.ts:1252
notify(
method: "$/cancel_request",
params: CancelRequestNotification,
): 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.
Parameters
- method: "$/cancel_request"
- params: CancelRequestNotification
Returns Promise<void>
- Defined in v2/stable/acp.ts:1256
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/stable/acp.ts:1260
notify<Params = unknown, const Method extends string = never>(
method: UnrecognizedMethod<Method>,
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
- const Method extends string = never
Parameters
- method: UnrecognizedMethod<Method>
- Optionalparams: Params
Returns Promise<void>
- Defined in v2/stable/acp.ts:1264

batch

batch<const Entries extends readonly BatchEntry[]>(
    entries: Entries & { "0": BatchEntry } & {
        [Index in string | number | symbol]: Entries[Index] extends BatchEntry
            ? string extends any[any]["method"]
                ? any[any]
                : any[any]["method"] extends | "session/cancel"
                | "$/cancel_request"
                | AgentRequestMethod
                | ClientRequestMethod
                | ClientNotificationMethod
                    ? any[any] extends AgentBatchEntry<never> ? any[any] : never
                    : any[any]
            : never
    },
): 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 } & {
      [Index in string | number | symbol]: Entries[Index] extends BatchEntry
          ? string extends any[any]["method"]
              ? any[any]
              : any[any]["method"] extends | "session/cancel"
              | "$/cancel_request"
              | AgentRequestMethod
              | ClientRequestMethod
              | ClientNotificationMethod
                  ? any[any] extends AgentBatchEntry<never> ? any[any] : never
                  : any[any]
          : never
  }
Returns Promise<BatchOutputs<Entries>>
- Defined in v2/stable/acp.ts:1282

Class ClientContextExperimental

Hierarchy

Index

Accessors

Methods

Accessors

initialized

Returns Promise<Readonly<{ request: InitializeRequest; response: InitializeResponse }>>

requestId

Returns JsonRpcId | undefined

Methods

buildSession

Parameters

Returns SessionBuilder

Parameters

Returns SessionBuilder

request

Type Parameters

Parameters

Returns Promise<AgentRequestResponsesByMethod[Method]>

Type Parameters

Parameters

Returns Promise<Response>

Type Parameters

Parameters

Returns Promise<Response>

notify

Type Parameters

Parameters

Returns Promise<void>

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<void>

batch

Type Parameters

Parameters

Returns Promise<BatchOutputs<Entries>>

Settings

On This Page

Class ClientContext`Experimental`