Class ConnectRuntimeTool

Tool for connecting runtimes to notebooks. Implements VS Code's LanguageModelTool interface for Copilot integration.

Connects runtime to notebook for code execution:

Uses active notebook if URI not specified
Uses most recent runtime if name not specified
Silently connects without user prompts

Implements

LanguageModelTool<IConnectRuntimeParameters>

Index

Constructors

Methods

invoke prepareInvocation

Constructors

constructor

new ConnectRuntimeTool(): ConnectRuntimeTool
Returns ConnectRuntimeTool

Methods

invoke

invoke(
options: LanguageModelToolInvocationOptions<IConnectRuntimeParameters>,
_token: CancellationToken,
): Promise<LanguageModelToolResult>
Executes the tool - connects runtime to notebook. Returns connection status.
Parameters
- options: LanguageModelToolInvocationOptions<IConnectRuntimeParameters>
- _token: CancellationToken
Returns Promise<LanguageModelToolResult>
Implementation of vscode.LanguageModelTool.invoke
- Defined in src/tools/connectRuntime.ts:63

prepareInvocation

prepareInvocation(
    options: LanguageModelToolInvocationPrepareOptions<
        IConnectRuntimeParameters,
    >,
    _token: CancellationToken,
): Promise<
    {
        confirmationMessages: { message: MarkdownString; title: string };
        invocationMessage: string;
    },
>
Prepares the tool invocation with user-facing messages. Called before the tool executes to show confirmation dialog.
Parameters
- options: LanguageModelToolInvocationPrepareOptions<IConnectRuntimeParameters>
- _token: CancellationToken
Returns Promise<
    {
        confirmationMessages: { message: MarkdownString; title: string };
        invocationMessage: string;
    },
>
Implementation of vscode.LanguageModelTool.prepareInvocation
- Defined in src/tools/connectRuntime.ts:42