Class CreateRemoteLexicalTool

Tool for creating Lexical documents in the CLOUD (Datalayer spaces). Implements VS Code's LanguageModelTool interface for Copilot integration.

IMPORTANT: Use this tool ONLY when user explicitly says "remote" or "cloud" or "Datalayer space". Do NOT use this for general lexical document creation - use CreateLocalLexicalTool for local documents.

Key behavior:

Creates lexical document in CLOUD (Datalayer platform, not local disk)
Requires authentication
Opens with Datalayer Lexical Editor
Uses default (Personal) space if not specified
Syncs across devices

Copilot will intelligently:

Extract lexical_name from user's request (e.g., "meeting notes" → "meeting-notes.lexical")
Generate description from context (e.g., "for team collaboration")
Default to "Personal" space if space_name not specified

Implements

LanguageModelTool<ICreateRemoteLexicalParameters>

Index

Constructors

constructor

Methods

invoke prepareInvocation

Constructors

constructor

new CreateRemoteLexicalTool(): CreateRemoteLexicalTool
Returns CreateRemoteLexicalTool

Methods

invoke

invoke(
    options: LanguageModelToolInvocationOptions<
        ICreateRemoteLexicalParameters,
    >,
    _token: CancellationToken,
): Promise<LanguageModelToolResult>
Executes the tool - creates a remote lexical document in the specified Datalayer space. Returns the document URI for opening in the editor.
Parameters
- options: LanguageModelToolInvocationOptions<ICreateRemoteLexicalParameters>
- _token: CancellationToken
Returns Promise<LanguageModelToolResult>
Implementation of vscode.LanguageModelTool.invoke
- Defined in src/tools/createRemoteLexical.ts:80

prepareInvocation

prepareInvocation(
    options: LanguageModelToolInvocationPrepareOptions<
        ICreateRemoteLexicalParameters,
    >,
    _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<ICreateRemoteLexicalParameters>
- _token: CancellationToken
Returns Promise<
    {
        confirmationMessages: { message: MarkdownString; title: string };
        invocationMessage: string;
    },
>
Implementation of vscode.LanguageModelTool.prepareInvocation
- Defined in src/tools/createRemoteLexical.ts:59

Class CreateRemoteLexicalTool

Implements

Index

Constructors

Methods

Constructors

constructor

Returns CreateRemoteLexicalTool

Methods

invoke

Parameters

Returns Promise<LanguageModelToolResult>

prepareInvocation

Parameters

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

Settings

On This Page

Class CreateRemoteLexicalTool

Implements

Index

Constructors

Methods

Constructors

constructor

Returns CreateRemoteLexicalTool

Methods

invoke

Parameters

Returns Promise<LanguageModelToolResult>

prepareInvocation

Parameters

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

Settings

On This Page

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