@codingame/monaco-vscode-chat-service-override 28.4.1 → 29.1.0

package/vscode/src/vs/platform/agentHost/common/state/protocol/state.d.ts

@@ -0,0 +1,723 @@
+/** A URI string (e.g. `agenthost:/root` or `copilot:/<uuid>`). */
+export type URI = string;
+/**
+ * A string that may optionally be rendered as Markdown.
+ *
+ * - A plain `string` is rendered as-is (no Markdown processing).
+ * - An object with `{ markdown: string }` is rendered with Markdown formatting.
+ */
+export type StringOrMarkdown = string | {
+    markdown: string;
+};
+/**
+ * Describes a protected resource's authentication requirements using
+ * [RFC 9728](https://datatracker.ietf.org/doc/html/rfc9728) (OAuth 2.0
+ * Protected Resource Metadata) semantics.
+ *
+ * Field names use snake_case to match the RFC 9728 JSON format.
+ *
+ * @category Authentication
+ * @see {@link https://datatracker.ietf.org/doc/html/rfc9728 | RFC 9728}
+ */
+export interface IProtectedResourceMetadata {
+    /**
+     * REQUIRED. The protected resource's resource identifier, a URL using the
+     * `https` scheme with no fragment component (e.g. `"https://api.github.com"`).
+     */
+    resource: string;
+    /** OPTIONAL. Human-readable name of the protected resource. */
+    resource_name?: string;
+    /** OPTIONAL. JSON array of OAuth authorization server identifier URLs. */
+    authorization_servers?: string[];
+    /** OPTIONAL. URL of the protected resource's JWK Set document. */
+    jwks_uri?: string;
+    /** RECOMMENDED. JSON array of OAuth 2.0 scope values used in authorization requests. */
+    scopes_supported?: string[];
+    /** OPTIONAL. JSON array of Bearer Token presentation methods supported. */
+    bearer_methods_supported?: string[];
+    /** OPTIONAL. JSON array of JWS signing algorithms supported. */
+    resource_signing_alg_values_supported?: string[];
+    /** OPTIONAL. JSON array of JWE encryption algorithms (alg) supported. */
+    resource_encryption_alg_values_supported?: string[];
+    /** OPTIONAL. JSON array of JWE encryption algorithms (enc) supported. */
+    resource_encryption_enc_values_supported?: string[];
+    /** OPTIONAL. URL of human-readable documentation for the resource. */
+    resource_documentation?: string;
+    /** OPTIONAL. URL of the resource's data-usage policy. */
+    resource_policy_uri?: string;
+    /** OPTIONAL. URL of the resource's terms of service. */
+    resource_tos_uri?: string;
+    /**
+     * AHP extension. Whether authentication is required for this resource.
+     *
+     * - `true` (default) — the agent cannot be used without a valid token.
+     *   The server SHOULD return `AuthRequired` (`-32007`) if the client
+     *   attempts to use the agent without authenticating.
+     * - `false` — the agent works without authentication but MAY offer
+     *   enhanced capabilities when a token is provided.
+     *
+     * Clients SHOULD treat an absent field the same as `true`.
+     */
+    required?: boolean;
+}
+/**
+ * Policy configuration state for a model.
+ *
+ * @category Root State
+ */
+export declare enum PolicyState {
+    Enabled = "enabled",
+    Disabled = "disabled",
+    Unconfigured = "unconfigured"
+}
+/**
+ * Global state shared with every client subscribed to `agenthost:/root`.
+ *
+ * @category Root State
+ */
+export interface IRootState {
+    /** Available agent backends and their models */
+    agents: IAgentInfo[];
+    /** Number of active (non-disposed) sessions on the server */
+    activeSessions?: number;
+}
+/**
+ * @category Root State
+ */
+export interface IAgentInfo {
+    /** Agent provider ID (e.g. `'copilot'`) */
+    provider: string;
+    /** Human-readable name */
+    displayName: string;
+    /** Description string */
+    description: string;
+    /** Available models for this agent */
+    models: ISessionModelInfo[];
+    /**
+     * Protected resources this agent requires authentication for.
+     *
+     * Each entry describes an OAuth 2.0 protected resource using
+     * [RFC 9728](https://datatracker.ietf.org/doc/html/rfc9728) semantics.
+     * Clients should obtain tokens from the declared `authorization_servers`
+     * and push them via the `authenticate` command before creating sessions
+     * with this agent.
+     *
+     * @see {@link /specification/authentication | Authentication}
+     */
+    protectedResources?: IProtectedResourceMetadata[];
+}
+/**
+ * @category Root State
+ */
+export interface ISessionModelInfo {
+    /** Model identifier */
+    id: string;
+    /** Provider this model belongs to */
+    provider: string;
+    /** Human-readable model name */
+    name: string;
+    /** Maximum context window size */
+    maxContextWindow?: number;
+    /** Whether the model supports vision */
+    supportsVision?: boolean;
+    /** Policy configuration state */
+    policyState?: PolicyState;
+}
+/**
+ * Session initialization state.
+ *
+ * @category Session State
+ */
+export declare enum SessionLifecycle {
+    Creating = "creating",
+    Ready = "ready",
+    CreationFailed = "creationFailed"
+}
+/**
+ * Current session status.
+ *
+ * @category Session State
+ */
+export declare enum SessionStatus {
+    Idle = "idle",
+    InProgress = "in-progress",
+    Error = "error"
+}
+/**
+ * Full state for a single session, loaded when a client subscribes to the session's URI.
+ *
+ * @category Session State
+ */
+export interface ISessionState {
+    /** Lightweight session metadata */
+    summary: ISessionSummary;
+    /** Session initialization state */
+    lifecycle: SessionLifecycle;
+    /** Error details if creation failed */
+    creationError?: IErrorInfo;
+    /** Tools provided by the server (agent host) for this session */
+    serverTools?: IToolDefinition[];
+    /** The client currently providing tools and interactive capabilities to this session */
+    activeClient?: ISessionActiveClient;
+    /** The working directory URI for this session */
+    workingDirectory?: URI;
+    /** Completed turns */
+    turns: ITurn[];
+    /** Currently in-progress turn */
+    activeTurn?: IActiveTurn;
+}
+/**
+ * The client currently providing tools and interactive capabilities to a session.
+ *
+ * Only one client may be active per session at a time. The server SHOULD
+ * automatically unset the active client if that client disconnects.
+ *
+ * @category Session State
+ */
+export interface ISessionActiveClient {
+    /** Client identifier (matches `clientId` from `initialize`) */
+    clientId: string;
+    /** Human-readable client name (e.g. `"VS Code"`) */
+    displayName?: string;
+    /** Tools this client provides to the session */
+    tools: IToolDefinition[];
+}
+/**
+ * @category Session State
+ */
+export interface ISessionSummary {
+    /** Session URI */
+    resource: URI;
+    /** Agent provider ID */
+    provider: string;
+    /** Session title */
+    title: string;
+    /** Current session status */
+    status: SessionStatus;
+    /** Creation timestamp */
+    createdAt: number;
+    /** Last modification timestamp */
+    modifiedAt: number;
+    /** Currently selected model */
+    model?: string;
+    /** The working directory URI for this session */
+    workingDirectory?: URI;
+}
+/**
+ * How a turn ended.
+ *
+ * @category Turn Types
+ */
+export declare enum TurnState {
+    Complete = "complete",
+    Cancelled = "cancelled",
+    Error = "error"
+}
+/**
+ * Type of a message attachment.
+ *
+ * @category Turn Types
+ */
+export declare enum AttachmentType {
+    File = "file",
+    Directory = "directory",
+    Selection = "selection"
+}
+/**
+ * A completed request/response cycle.
+ *
+ * @category Turn Types
+ */
+export interface ITurn {
+    /** Turn identifier */
+    id: string;
+    /** The user's input */
+    userMessage: IUserMessage;
+    /** Final response text (captured from streaming) */
+    responseText: string;
+    /** Structured response content */
+    responseParts: IResponsePart[];
+    /** Tool invocations in terminal states (completed or cancelled) */
+    toolCalls: (IToolCallCompletedState | IToolCallCancelledState)[];
+    /** Token usage info */
+    usage: IUsageInfo | undefined;
+    /** How the turn ended */
+    state: TurnState;
+    /** Error details if state is `'error'` */
+    error?: IErrorInfo;
+}
+/**
+ * An in-progress turn — the assistant is actively streaming.
+ *
+ * @category Turn Types
+ */
+export interface IActiveTurn {
+    /** Turn identifier */
+    id: string;
+    /** The user's input */
+    userMessage: IUserMessage;
+    /** Accumulated streaming response text */
+    streamingText: string;
+    /** Structured response content so far */
+    responseParts: IResponsePart[];
+    /** Active tool invocations keyed by tool call ID */
+    toolCalls: Record<string, IToolCallState>;
+    /** Pending permission requests keyed by request ID */
+    pendingPermissions: Record<string, IPermissionRequest>;
+    /** Accumulated reasoning/thinking text */
+    reasoning: string;
+    /** Token usage info */
+    usage: IUsageInfo | undefined;
+}
+/**
+ * @category Turn Types
+ */
+export interface IUserMessage {
+    /** Message text */
+    text: string;
+    /** File/selection attachments */
+    attachments?: IMessageAttachment[];
+}
+/**
+ * @category Turn Types
+ */
+export interface IMessageAttachment {
+    /** Attachment type */
+    type: AttachmentType;
+    /** File/directory path */
+    path: string;
+    /** Display name */
+    displayName?: string;
+}
+/**
+ * Discriminant for response part types.
+ *
+ * @category Response Parts
+ */
+export declare enum ResponsePartKind {
+    Markdown = "markdown",
+    ContentRef = "contentRef"
+}
+/**
+ * @category Response Parts
+ */
+export interface IMarkdownResponsePart {
+    /** Discriminant */
+    kind: ResponsePartKind.Markdown;
+    /** Markdown content */
+    content: string;
+}
+/**
+ * A reference to large content stored outside the state tree.
+ *
+ * @category Response Parts
+ */
+export interface IContentRef {
+    /** Discriminant */
+    kind: ResponsePartKind.ContentRef;
+    /** Content URI */
+    uri: string;
+    /** Approximate size in bytes */
+    sizeHint?: number;
+    /** Content MIME type */
+    contentType?: string;
+}
+/**
+ * @category Response Parts
+ */
+export type IResponsePart = IMarkdownResponsePart | IContentRef;
+/**
+ * Status of a tool call in the lifecycle state machine.
+ *
+ * @category Tool Call Types
+ */
+export declare enum ToolCallStatus {
+    Streaming = "streaming",
+    PendingConfirmation = "pending-confirmation",
+    Running = "running",
+    PendingResultConfirmation = "pending-result-confirmation",
+    Completed = "completed",
+    Cancelled = "cancelled"
+}
+/**
+ * How a tool call was confirmed for execution.
+ *
+ * - `NotNeeded` — No confirmation required (auto-approved)
+ * - `UserAction` — User explicitly approved
+ * - `Setting` — Approved by a persistent user setting
+ *
+ * @category Tool Call Types
+ */
+export declare enum ToolCallConfirmationReason {
+    NotNeeded = "not-needed",
+    UserAction = "user-action",
+    Setting = "setting"
+}
+/**
+ * Why a tool call was cancelled.
+ *
+ * @category Tool Call Types
+ */
+export declare enum ToolCallCancellationReason {
+    Denied = "denied",
+    Skipped = "skipped",
+    ResultDenied = "result-denied"
+}
+/**
+ * Metadata common to all tool call states.
+ *
+ * @category Tool Call Types
+ * @remarks
+ * Fields like `toolName` carry agent-specific identifiers on the wire despite the
+ * agent-agnostic design principle. These exist for debugging and logging purposes.
+ * A future version may move these to a separate diagnostic channel or namespace them
+ * more clearly.
+ */
+interface IToolCallBase {
+    /** Unique tool call identifier */
+    toolCallId: string;
+    /** Internal tool name (for debugging/logging) */
+    toolName: string;
+    /** Human-readable tool name */
+    displayName: string;
+    /**
+     * If this tool is provided by a client, the `clientId` of the owning client.
+     * Absent for server-side tools.
+     *
+     * When set, the identified client is responsible for executing the tool and
+     * dispatching `session/toolCallComplete` with the result.
+     */
+    toolClientId?: string;
+    /**
+     * Additional provider-specific metadata for this tool call.
+     *
+     * Clients MAY look for well-known keys here to provide enhanced UI.
+     * For example, a `ptyTerminal` key with `{ input: string; output: string }`
+     * indicates the tool operated on a terminal (both `input` and `output` may
+     * contain escape sequences).
+     */
+    _meta?: Record<string, unknown>;
+}
+/**
+ * Properties available once tool call parameters are fully received.
+ *
+ * @category Tool Call Types
+ */
+interface IToolCallParameterFields {
+    /** Message describing what the tool will do */
+    invocationMessage: StringOrMarkdown;
+    /** Raw tool input */
+    toolInput?: string;
+}
+/**
+ * Tool execution result details, available after execution completes.
+ *
+ * @category Tool Call Types
+ */
+export interface IToolCallResult {
+    /** Whether the tool succeeded */
+    success: boolean;
+    /** Past-tense description of what the tool did */
+    pastTenseMessage: StringOrMarkdown;
+    /**
+     * Unstructured result content blocks.
+     *
+     * This mirrors the `content` field of MCP `CallToolResult`.
+     */
+    content?: IToolResultContent[];
+    /**
+     * Optional structured result object.
+     *
+     * This mirrors the `structuredContent` field of MCP `CallToolResult`.
+     */
+    structuredContent?: Record<string, unknown>;
+    /** Error details if the tool failed */
+    error?: {
+        message: string;
+        code?: string;
+    };
+}
+/**
+ * LM is streaming the tool call parameters.
+ *
+ * @category Tool Call Types
+ */
+export interface IToolCallStreamingState extends IToolCallBase {
+    status: ToolCallStatus.Streaming;
+    /** Partial parameters accumulated so far */
+    partialInput?: string;
+    /** Progress message shown while parameters are streaming */
+    invocationMessage?: StringOrMarkdown;
+}
+/**
+ * Parameters are complete, waiting for client to confirm execution.
+ *
+ * @category Tool Call Types
+ */
+export interface IToolCallPendingConfirmationState extends IToolCallBase, IToolCallParameterFields {
+    status: ToolCallStatus.PendingConfirmation;
+}
+/**
+ * Tool is actively executing.
+ *
+ * @category Tool Call Types
+ */
+export interface IToolCallRunningState extends IToolCallBase, IToolCallParameterFields {
+    status: ToolCallStatus.Running;
+    /** How the tool was confirmed for execution */
+    confirmed: ToolCallConfirmationReason;
+}
+/**
+ * Tool finished executing, waiting for client to approve the result.
+ *
+ * @category Tool Call Types
+ */
+export interface IToolCallPendingResultConfirmationState extends IToolCallBase, IToolCallParameterFields, IToolCallResult {
+    status: ToolCallStatus.PendingResultConfirmation;
+    /** How the tool was confirmed for execution */
+    confirmed: ToolCallConfirmationReason;
+}
+/**
+ * Tool completed successfully or with an error.
+ *
+ * @category Tool Call Types
+ */
+export interface IToolCallCompletedState extends IToolCallBase, IToolCallParameterFields, IToolCallResult {
+    status: ToolCallStatus.Completed;
+    /** How the tool was confirmed for execution */
+    confirmed: ToolCallConfirmationReason;
+}
+/**
+ * Tool call was cancelled before execution.
+ *
+ * @category Tool Call Types
+ */
+export interface IToolCallCancelledState extends IToolCallBase, IToolCallParameterFields {
+    status: ToolCallStatus.Cancelled;
+    /** Why the tool was cancelled */
+    reason: ToolCallCancellationReason;
+    /** Optional message explaining the cancellation */
+    reasonMessage?: StringOrMarkdown;
+    /** What the user suggested doing instead */
+    userSuggestion?: IUserMessage;
+}
+/**
+ * Discriminated union of all tool call lifecycle states.
+ *
+ * See the [state model guide](/guide/state-model.html#tool-call-lifecycle)
+ * for the full state machine diagram.
+ *
+ * @category Tool Call Types
+ */
+export type IToolCallState = IToolCallStreamingState | IToolCallPendingConfirmationState | IToolCallRunningState | IToolCallPendingResultConfirmationState | IToolCallCompletedState | IToolCallCancelledState;
+/**
+ * Describes a tool available in a session, provided by either the server or the active client.
+ *
+ * This type mirrors the MCP `Tool` type from the Model Context Protocol specification
+ * (2025-11-25 draft) and will continue to track it.
+ *
+ * @category Tool Definition Types
+ */
+export interface IToolDefinition {
+    /** Unique tool identifier */
+    name: string;
+    /** Human-readable display name */
+    title?: string;
+    /** Description of what the tool does */
+    description?: string;
+    /**
+     * JSON Schema defining the expected input parameters.
+     *
+     * Optional because client-provided tools may not have formal schemas.
+     * Mirrors MCP `Tool.inputSchema`.
+     */
+    inputSchema?: {
+        type: "object";
+        properties?: Record<string, object>;
+        required?: string[];
+    };
+    /**
+     * JSON Schema defining the structure of the tool's output.
+     *
+     * Mirrors MCP `Tool.outputSchema`.
+     */
+    outputSchema?: {
+        type: "object";
+        properties?: Record<string, object>;
+        required?: string[];
+    };
+    /** Behavioral hints about the tool. All properties are advisory. */
+    annotations?: IToolAnnotations;
+    /**
+     * Additional provider-specific metadata.
+     *
+     * Mirrors the MCP `_meta` convention.
+     */
+    _meta?: Record<string, unknown>;
+}
+/**
+ * Behavioral hints about a tool. All properties are advisory and not
+ * guaranteed to faithfully describe tool behavior.
+ *
+ * Mirrors MCP `ToolAnnotations` from the Model Context Protocol specification.
+ *
+ * @category Tool Definition Types
+ */
+export interface IToolAnnotations {
+    /** Alternate human-readable title */
+    title?: string;
+    /** Tool does not modify its environment (default: false) */
+    readOnlyHint?: boolean;
+    /** Tool may perform destructive updates (default: true) */
+    destructiveHint?: boolean;
+    /** Repeated calls with the same arguments have no additional effect (default: false) */
+    idempotentHint?: boolean;
+    /** Tool may interact with external entities (default: true) */
+    openWorldHint?: boolean;
+}
+/**
+ * Discriminant for tool result content types.
+ *
+ * @category Tool Result Content
+ */
+export declare enum ToolResultContentType {
+    Text = "text",
+    Binary = "binary",
+    FileEdit = "fileEdit"
+}
+/**
+ * Text content in a tool result.
+ *
+ * Mirrors MCP `TextContent`.
+ *
+ * @category Tool Result Content
+ */
+export interface IToolResultTextContent {
+    type: ToolResultContentType.Text;
+    /** The text content */
+    text: string;
+}
+/**
+ * Base64-encoded binary content in a tool result.
+ *
+ * Mirrors MCP `ImageContent` but generalized to any binary content type.
+ *
+ * @category Tool Result Content
+ */
+export interface IToolResultBinaryContent {
+    type: ToolResultContentType.Binary;
+    /** Base64-encoded data */
+    data: string;
+    /** Content type (e.g. `"image/png"`, `"application/pdf"`) */
+    contentType: string;
+}
+/**
+ * Describes a file modification performed by a tool.
+ *
+ * Clients can use the `beforeURI`/`afterURI` pair to render a diff view.
+ *
+ * @category Tool Result Content
+ */
+export interface IToolResultFileEditContent {
+    type: ToolResultContentType.FileEdit;
+    /** URI of the file content before the edit */
+    beforeURI: URI;
+    /** URI of the file content after the edit */
+    afterURI: URI;
+    /** Optional diff display metadata */
+    diff?: {
+        /** Number of items added (e.g., lines for text files, cells for notebooks) */
+        added?: number;
+        /** Number of items removed (e.g., lines for text files, cells for notebooks) */
+        removed?: number;
+    };
+}
+/**
+ * Content block in a tool result.
+ *
+ * Mirrors the content blocks in MCP `CallToolResult.content`, plus
+ * `IContentRef` for lazy-loading large results and `IToolResultFileEditContent`
+ * for file edit diffs (AHP extensions).
+ *
+ * @category Tool Result Content
+ */
+export type IToolResultContent = IToolResultTextContent | IToolResultBinaryContent | IToolResultFileEditContent | IContentRef;
+/**
+ * Type of permission requested.
+ *
+ * @category Permission Types
+ */
+export declare enum PermissionKind {
+    Shell = "shell",
+    Write = "write",
+    Mcp = "mcp",
+    Read = "read",
+    Url = "url"
+}
+/**
+ * @category Permission Types
+ * @remarks
+ * Fields like `serverName`, `toolName`, and `rawRequest` carry agent-specific
+ * identifiers on the wire despite the agent-agnostic design principle. These exist
+ * for debugging and logging purposes.
+ * @todo @connor4312, split this up into well-separated union types
+ */
+export interface IPermissionRequest {
+    /** Unique request identifier */
+    requestId: string;
+    /** Type of permission */
+    permissionKind: PermissionKind;
+    /** Associated tool call */
+    toolCallId?: string;
+    /** File/directory path */
+    path?: string;
+    /** Full command to execute */
+    fullCommandText?: string;
+    /** What the tool intends to do */
+    intention?: string;
+    /** MCP server name */
+    serverName?: string;
+    /** Tool requesting permission */
+    toolName?: string;
+    /** Raw request data */
+    rawRequest?: string;
+}
+/**
+ * @category Common Types
+ */
+export interface IUsageInfo {
+    /** Input tokens consumed */
+    inputTokens?: number;
+    /** Output tokens generated */
+    outputTokens?: number;
+    /** Model used */
+    model?: string;
+    /** Tokens read from cache */
+    cacheReadTokens?: number;
+}
+/**
+ * @category Common Types
+ */
+export interface IErrorInfo {
+    /** Error type identifier */
+    errorType: string;
+    /** Human-readable error message */
+    message: string;
+    /** Stack trace */
+    stack?: string;
+}
+/**
+ * A point-in-time snapshot of a subscribed resource's state, returned by
+ * `initialize`, `reconnect`, and `subscribe`.
+ *
+ * @category Common Types
+ */
+export interface ISnapshot {
+    /** The subscribed resource URI (e.g. `agenthost:/root` or `copilot:/<uuid>`) */
+    resource: URI;
+    /** The current state of the resource */
+    state: IRootState | ISessionState;
+    /** The `serverSeq` at which this snapshot was taken. Subsequent actions will have `serverSeq > fromSeq`. */
+    fromSeq: number;
+}
+export {};