Type Alias ClientCapabilities

Capabilities supported by the client.

Advertised during initialization to inform the agent about available features and methods.

See protocol docs: Client Capabilities

type ClientCapabilities = {
    fs?: FileSystemCapabilities;
    terminal?: boolean;
    session?: ClientSessionCapabilities | null;
    plan?: PlanCapabilities | null;
    auth?: AuthCapabilities;
    elicitation?: ElicitationCapabilities | null;
    nes?: ClientNesCapabilities | null;
    positionEncodings?: PositionEncodingKind[];
    _meta?: { [key: string]: unknown } | null;
}

Index

Properties

fs? terminal? session? plan? auth? elicitation? nes? positionEncodings? _meta?

Properties

`Optional`fs

fs?: FileSystemCapabilities

File system capabilities supported by the client. Determines which file operations the agent can request.

`Optional`terminal

terminal?: boolean

Whether the Client support all terminal* methods.

`Optional`session

session?: ClientSessionCapabilities | null

Session-related capabilities supported by the client.

Optional. Omitted or null both mean the client does not advertise any session-related extensions.

`Optional` `Experimental`plan

plan?: PlanCapabilities | null

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Whether the client supports plan_update and plan_removed session updates.

Optional. Omitted or null both mean the client does not advertise support. Supplying {} means the client can receive both update types.

`Optional` `Experimental`auth

auth?: AuthCapabilities

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Authentication capabilities supported by the client. Determines which authentication method types the agent may include in its InitializeResponse.

`Optional` `Experimental`elicitation

elicitation?: ElicitationCapabilities | null

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

Elicitation capabilities supported by the client. Determines which elicitation modes the agent may use.

Optional. Omitted or null both mean the client does not advertise elicitation support.

`Optional` `Experimental`nes

nes?: ClientNesCapabilities | null

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

NES (Next Edit Suggestions) capabilities supported by the client.

Optional. Omitted or null both mean the client does not advertise any NES suggestion-kind extensions.

`Optional` `Experimental`positionEncodings

positionEncodings?: PositionEncodingKind[]

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

The position encodings supported by the client, in order of preference.

`Optional`_meta

_meta?: { [key: string]: unknown } | null

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT make assumptions about values at these keys.

See protocol docs: Extensibility