Class VSCodeToolAdapter<TParams>

VS Code Tool Adapter

This adapter bridges VS Code's LanguageModelTool interface to our platform-agnostic core operations. It handles:

Document resolution from parameters or active editor
Context building (document handle, SDK, auth)
Confirmation dialog generation
Result formatting for VS Code

Type Parameters

TParams

Implements

LanguageModelTool<TParams>

Index

Constructors

constructor

new VSCodeToolAdapter<TParams>(
definition: ToolDefinition,
operation: ToolOperation<TParams, unknown>,
): VSCodeToolAdapter<TParams>
Type Parameters
- TParams
Parameters
- definition: ToolDefinition
- operation: ToolOperation<TParams, unknown>
Returns VSCodeToolAdapter<TParams>
- Defined in src/tools/core/toolAdapter.ts:42

Properties

`Private` `Readonly`definition

definition: ToolDefinition

`Private` `Readonly`operation

operation: ToolOperation<TParams, unknown>

Methods

`Private`buildCreateDocumentExtras

buildCreateDocumentExtras(): Record<string, unknown>
Builds extras for create operations (createNotebook, createLexical) with VS Code-specific logic

Returns Record<string, unknown>
- Defined in src/tools/core/toolAdapter.ts:224

`Private`buildDefaultExtras

buildDefaultExtras(): Record<string, unknown>
Builds default extras for non-createNotebook tools

Returns Record<string, unknown>
- Defined in src/tools/core/toolAdapter.ts:315

`Private`buildExecutionContext

buildExecutionContext(params: TParams): Promise<ToolExecutionContext>
Builds the execution context for the operation
Parameters
- params: TParams
Returns Promise<ToolExecutionContext>
- Defined in src/tools/core/toolAdapter.ts:146

`Private`executeVSCodeCommand

executeVSCodeCommand<T>(operationName: string, args: unknown): Promise<T>
Executes operation by sending message to active webview Uses the Runner pattern: extension → webview message → DefaultExecutor
Type Parameters
- T
Parameters
- operationName: string
- args: unknown
Returns Promise<T>
- Defined in src/tools/core/toolAdapter.ts:584

`Private`formatResult

formatResult(result: unknown): LanguageModelToolResult
Formats operation result for VS Code
Parameters
- result: unknown
Returns LanguageModelToolResult
- Defined in src/tools/core/toolAdapter.ts:551

invoke

invoke(
options: LanguageModelToolInvocationOptions<TParams>,
_token: CancellationToken,
): Promise<LanguageModelToolResult>
Executes the tool by delegating to the core operation
Parameters
- options: LanguageModelToolInvocationOptions<TParams>
- _token: CancellationToken
Returns Promise<LanguageModelToolResult>
Implementation of vscode.LanguageModelTool.invoke
- Defined in src/tools/core/toolAdapter.ts:82

`Private`openNotebook

openNotebook(uriString: string): Promise<void>
Open a notebook document in the editor Handles both local (file://) and cloud (datalayer://) schemes Always uses the Datalayer notebook editor
Parameters
- uriString: string
Returns Promise<void>
- Defined in src/tools/core/toolAdapter.ts:414

prepareInvocation

prepareInvocation(
    options: LanguageModelToolInvocationPrepareOptions<TParams>,
    _token: CancellationToken,
): Promise<
    {
        confirmationMessages: { message: MarkdownString; title: string };
        invocationMessage: string;
    },
>
Prepares the tool invocation with user-facing messages
Parameters
- options: LanguageModelToolInvocationPrepareOptions<TParams>
- _token: CancellationToken
Returns Promise<
    {
        confirmationMessages: { message: MarkdownString; title: string };
        invocationMessage: string;
    },
>
Implementation of vscode.LanguageModelTool.prepareInvocation
- Defined in src/tools/core/toolAdapter.ts:50

`Private`promptForLocation

promptForLocation(spaceName?: string): Promise<"local" | "cloud">
Prompts user to choose notebook location when intent is ambiguous (VS Code-specific UI)
Parameters
- OptionalspaceName: string
Returns Promise<"local" | "cloud">
- Defined in src/tools/core/toolAdapter.ts:359

`Private`resolveLexicalId

resolveLexicalId(params: TParams): Promise<string>
Resolves Lexical document ID from parameters or active editor
Parameters
- params: TParams
Returns Promise<string>
- Defined in src/tools/core/toolAdapter.ts:477

`Private`resolveMessage

resolveMessage(
    messageFn: (params: TParams) => string,
    params: TParams,
    fallback: string,
): string
Resolves a message by calling the message function with params
Parameters
- messageFn: (params: TParams) => string
- params: TParams
- fallback: string
Returns string
- Defined in src/tools/core/toolAdapter.ts:671

`Private`resolveNotebookId

resolveNotebookId(params: TParams): Promise<string>
Resolves notebook ID from parameters or active editor
Parameters
- params: TParams
Returns Promise<string>
- Defined in src/tools/core/toolAdapter.ts:428

Class VSCodeToolAdapter<TParams>

Type Parameters

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VSCodeToolAdapter<TParams>

Properties

Private Readonlydefinition

Private Readonlyoperation

Methods

PrivatebuildCreateDocumentExtras

Returns Record<string, unknown>

PrivatebuildDefaultExtras

Returns Record<string, unknown>

PrivatebuildExecutionContext

Parameters

Returns Promise<ToolExecutionContext>

PrivateexecuteVSCodeCommand

Type Parameters

Parameters

Returns Promise<T>

PrivateformatResult

Parameters

Returns LanguageModelToolResult

invoke

Parameters

Returns Promise<LanguageModelToolResult>

PrivateopenNotebook

Parameters

Returns Promise<void>

prepareInvocation

Parameters

Returns Promise< { confirmationMessages: { message: MarkdownString; title: string }; invocationMessage: string; },>

PrivatepromptForLocation

Parameters

Returns Promise<"local" | "cloud">

PrivateresolveLexicalId

Parameters

Returns Promise<string>

PrivateresolveMessage

Parameters

Returns string

PrivateresolveNotebookId

Parameters

Returns Promise<string>

Settings

On This Page

`Private` `Readonly`definition

`Private` `Readonly`operation

`Private`buildCreateDocumentExtras

`Private`buildDefaultExtras

`Private`buildExecutionContext

`Private`executeVSCodeCommand

`Private`formatResult

`Private`openNotebook

Returns Promise<
{
confirmationMessages: { message: MarkdownString; title: string };
invocationMessage: string;
},
>

`Private`promptForLocation

`Private`resolveLexicalId

`Private`resolveMessage

`Private`resolveNotebookId