Class AgentContext`Experimental`

Experimental draft ACP v2 context passed to agent-side handlers.

Agents use this context to call client-side ACP methods while handling requests such as session/prompt.

Hierarchy

AcpContext
- AgentContext

Index

Accessors

initialized requestId

Methods

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

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:994

Methods

request

request<Method extends ClientRequestMethod>(
    method: Method,
    params: ClientRequestParamsByMethod[Method],
    options?: SendRequestOptions,
): Promise<ClientRequestResponsesByMethod[Method]>
Experimental
Sends a request to the client 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 ClientRequestMethod
Parameters
- method: Method
- params: ClientRequestParamsByMethod[Method]
- Optionaloptions: SendRequestOptions
Returns Promise<ClientRequestResponsesByMethod[Method]>
- Defined in v2/acp.ts:1055
request<Response = unknown, Params = unknown>(
    method: `_${string}`,
    params?: Params,
    options?: SendRequestOptions,
): Promise<Response>
Experimental
Sends a request to the client 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:1060
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 client 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/acp.ts:1065

notify

notify<Method extends ClientNotificationMethod>(
method: Method,
params: ClientNotificationParamsByMethod[Method],
): Promise<void>
Experimental
Sends a notification to the client 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 ClientNotificationMethod
Parameters
- method: Method
- params: ClientNotificationParamsByMethod[Method]
Returns Promise<void>
- Defined in v2/acp.ts:1100
notify(
method: "$/cancel_request",
params: CancelRequestNotification,
): Promise<void>
Experimental
Sends a notification to the client 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/acp.ts:1104
notify<Params = unknown>(method: `_${string}`, params?: Params): Promise<void>
Experimental
Sends a notification to the client 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:1108
notify<Params = unknown, const Method extends string = never>(
method: UnrecognizedMethod<Method>,
params?: Params,
): Promise<void>
Experimental
Sends a notification to the client 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/acp.ts:1112

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 | "initialize"
                | "session/new"
                | "session/set_config_option"
                | "session/prompt"
                | "session/cancel"
                | "session/list"
                | "session/delete"
                | "session/resume"
                | "session/close"
                | "session/request_permission"
                | "session/update"
                | "elicitation/create"
                | "elicitation/complete"
                | "$/cancel_request"
                | "providers/list"
                | "providers/set"
                | "providers/disable"
                | "mcp/message"
                | "session/fork"
                | "auth/login"
                | "auth/logout"
                    ? any[any] extends ClientBatchEntry<never> ? any[any] : never
                    : any[any]
            : never
    },
): Promise<BatchOutputs<Entries>>
Experimental
Sends requests and notifications to the client 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 | "initialize"
              | "session/new"
              | "session/set_config_option"
              | "session/prompt"
              | "session/cancel"
              | "session/list"
              | "session/delete"
              | "session/resume"
              | "session/close"
              | "session/request_permission"
              | "session/update"
              | "elicitation/create"
              | "elicitation/complete"
              | "$/cancel_request"
              | "providers/list"
              | "providers/set"
              | "providers/disable"
              | "mcp/message"
              | "session/fork"
              | "auth/login"
              | "auth/logout"
                  ? any[any] extends ClientBatchEntry<never> ? any[any] : never
                  : any[any]
          : never
  }
Returns Promise<BatchOutputs<Entries>>
- Defined in v2/acp.ts:1131

Class AgentContext`Experimental`

Hierarchy

Index

Accessors

Methods

Accessors

initialized

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

requestId

Returns JsonRpcId | undefined

Methods

request

Type Parameters

Parameters

Returns Promise<ClientRequestResponsesByMethod[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 AgentContextExperimental

Hierarchy

Index

Accessors

Methods

Accessors

initialized

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

requestId

Returns JsonRpcId | undefined

Methods

request

Type Parameters

Parameters

Returns Promise<ClientRequestResponsesByMethod[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 AgentContext`Experimental`