@codingame/monaco-vscode-chat-service-override 37.1.0 → 37.2.0

package/vscode/src/vs/workbench/contrib/chat/common/tools/languageModelToolsContribution.js

@@ -0,0 +1,518 @@
+
+import { __decorate, __param } from '@codingame/monaco-vscode-api/external/tslib/tslib.es6';
+import { isFalsyOrEmpty } from '@codingame/monaco-vscode-api/vscode/vs/base/common/arrays';
+import { Codicon } from '@codingame/monaco-vscode-api/vscode/vs/base/common/codicons';
+import { MarkdownString } from '@codingame/monaco-vscode-api/vscode/vs/base/common/htmlContent';
+import { DisposableMap, DisposableStore, Disposable } from '@codingame/monaco-vscode-api/vscode/vs/base/common/lifecycle';
+import '@codingame/monaco-vscode-api/vscode/vs/base/common/observableInternal/index';
+import { joinPath } from '@codingame/monaco-vscode-api/vscode/vs/base/common/resources';
+import { isFalsyOrWhitespace } from '@codingame/monaco-vscode-api/vscode/vs/base/common/strings';
+import { ThemeIcon } from '@codingame/monaco-vscode-api/vscode/vs/base/common/themables';
+import { localize } from '@codingame/monaco-vscode-api/vscode/vs/nls';
+import { ContextKeyExpr } from '@codingame/monaco-vscode-api/vscode/vs/platform/contextkey/common/contextkey';
+import { ExtensionIdentifier } from '@codingame/monaco-vscode-api/vscode/vs/platform/extensions/common/extensions';
+import { SyncDescriptor } from '@codingame/monaco-vscode-api/vscode/vs/platform/instantiation/common/descriptors';
+import { IProductService } from '@codingame/monaco-vscode-api/vscode/vs/platform/product/common/productService.service';
+import { Registry } from '@codingame/monaco-vscode-api/vscode/vs/platform/registry/common/platform';
+import { Extensions } from '@codingame/monaco-vscode-api/vscode/vs/workbench/services/extensionManagement/common/extensionFeatures';
+import { isProposedApiEnabled } from '@codingame/monaco-vscode-api/vscode/vs/workbench/services/extensions/common/extensions';
+import { ExtensionsRegistry } from '@codingame/monaco-vscode-api/vscode/vs/workbench/services/extensions/common/extensionsRegistry';
+import { ToolDataSource } from '@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/common/tools/languageModelToolsService';
+import { ILanguageModelToolsService } from '@codingame/monaco-vscode-api/vscode/vs/workbench/contrib/chat/common/tools/languageModelToolsService.service';
+import { toolsParametersSchemaSchemaId } from './languageModelToolsParametersSchema.js';
+import { transaction } from '@codingame/monaco-vscode-api/vscode/vs/base/common/observableInternal/transaction';
+
+const languageModelToolsExtensionPoint = ExtensionsRegistry.registerExtensionPoint({
+    extensionPoint: "languageModelTools",
+    activationEventsGenerator: function*(contributions) {
+        for (const contrib of contributions) {
+            yield `onLanguageModelTool:${contrib.name}`;
+        }
+    },
+    jsonSchema: {
+        description: ( localize(
+            10903,
+            "Contributes a tool that can be invoked by a language model in a chat session, or from a standalone command. Registered tools can be used by all extensions."
+        )),
+        type: "array",
+        items: {
+            additionalProperties: false,
+            type: "object",
+            defaultSnippets: [{
+                body: {
+                    name: "${1}",
+                    modelDescription: "${2}",
+                    inputSchema: {
+                        type: "object",
+                        properties: {
+                            "${3:name}": {
+                                type: "string",
+                                description: "${4:description}"
+                            }
+                        }
+                    }
+                }
+            }],
+            required: ["name", "displayName", "modelDescription"],
+            properties: {
+                name: {
+                    description: ( localize(
+                        10904,
+                        "A unique name for this tool. This name must be a globally unique identifier, and is also used as a name when presenting this tool to a language model."
+                    )),
+                    type: "string",
+                    pattern: "^(?!copilot_|vscode_)[\\w-]+$"
+                },
+                toolReferenceName: {
+                    markdownDescription: ( localize(
+                        10905,
+                        "If {0} is enabled for this tool, the user may use '#' with this name to invoke the tool in a query. Otherwise, the name is not required. Name must not contain whitespace.",
+                        "`canBeReferencedInPrompt`"
+                    )),
+                    type: "string",
+                    pattern: "^[\\w-]+$"
+                },
+                displayName: {
+                    description: ( localize(
+                        10906,
+                        "A human-readable name for this tool that may be used to describe it in the UI."
+                    )),
+                    type: "string"
+                },
+                userDescription: {
+                    description: ( localize(10907, "A description of this tool that may be shown to the user.")),
+                    type: "string"
+                },
+                modelDescription: {
+                    description: ( localize(
+                        10908,
+                        "A description of this tool that may be used by a language model to select it."
+                    )),
+                    type: "string"
+                },
+                inputSchema: {
+                    description: ( localize(
+                        10909,
+                        "A JSON schema for the input this tool accepts. The input must be an object at the top level. A particular language model may not support all JSON schema features. See the documentation for the language model family you are using for more information."
+                    )),
+                    $ref: toolsParametersSchemaSchemaId
+                },
+                canBeReferencedInPrompt: {
+                    markdownDescription: ( localize(
+                        10910,
+                        "If true, this tool shows up as an attachment that the user can add manually to their request. Chat participants will receive the tool in {0}.",
+                        "`ChatRequest#toolReferences`"
+                    )),
+                    type: "boolean"
+                },
+                icon: {
+                    markdownDescription: ( localize(
+                        10911,
+                        "An icon that represents this tool. Either a file path, an object with file paths for dark and light themes, or a theme icon reference, like \"\\$(zap)\""
+                    )),
+                    anyOf: [{
+                        type: "string"
+                    }, {
+                        type: "object",
+                        properties: {
+                            light: {
+                                description: ( localize(10912, "Icon path when a light theme is used")),
+                                type: "string"
+                            },
+                            dark: {
+                                description: ( localize(10913, "Icon path when a dark theme is used")),
+                                type: "string"
+                            }
+                        }
+                    }]
+                },
+                when: {
+                    markdownDescription: ( localize(
+                        10914,
+                        "Condition which must be true for this tool to be enabled. Note that a tool may still be invoked by another extension even when its `when` condition is false."
+                    )),
+                    type: "string"
+                },
+                tags: {
+                    description: ( localize(
+                        10915,
+                        "A set of tags that roughly describe the tool's capabilities. A tool user may use these to filter the set of tools to just ones that are relevant for the task at hand, or they may want to pick a tag that can be used to identify just the tools contributed by this extension."
+                    )),
+                    type: "array",
+                    items: {
+                        type: "string",
+                        pattern: "^(?!copilot_|vscode_)"
+                    }
+                }
+            }
+        }
+    }
+});
+const languageModelToolSetsExtensionPoint = ExtensionsRegistry.registerExtensionPoint({
+    extensionPoint: "languageModelToolSets",
+    deps: [languageModelToolsExtensionPoint],
+    jsonSchema: {
+        description: ( localize(
+            10916,
+            "Contributes a set of language model tools that can be used together."
+        )),
+        type: "array",
+        items: {
+            additionalProperties: false,
+            type: "object",
+            defaultSnippets: [{
+                body: {
+                    name: "${1}",
+                    description: "${2}",
+                    tools: ["${3}"]
+                }
+            }],
+            required: ["name", "description", "tools"],
+            properties: {
+                name: {
+                    description: ( localize(
+                        10917,
+                        "A name for this tool set. Used as reference and should not contain whitespace."
+                    )),
+                    type: "string",
+                    pattern: "^[\\w-]+$"
+                },
+                description: {
+                    description: ( localize(10918, "A description of this tool set.")),
+                    type: "string"
+                },
+                icon: {
+                    markdownDescription: ( localize(10919, "An icon that represents this tool set, like {0}", "`$(zap)`")),
+                    type: "string"
+                },
+                tools: {
+                    markdownDescription: ( localize(
+                        10920,
+                        "A list of tools or tool sets to include in this tool set. Cannot be empty and must reference tools by their `toolReferenceName`."
+                    )),
+                    type: "array",
+                    minItems: 1,
+                    items: {
+                        type: "string"
+                    }
+                }
+            }
+        }
+    }
+});
+function toToolKey(extensionIdentifier, toolName) {
+    return `${extensionIdentifier.value}/${toolName}`;
+}
+function toToolSetKey(extensionIdentifier, toolName) {
+    return `toolset:${extensionIdentifier.value}/${toolName}`;
+}
+function toSyntheticToolSetKey(extensionIdentifier) {
+    return `synthetic-toolset:${extensionIdentifier.value}`;
+}
+let LanguageModelToolsExtensionPointHandler = class LanguageModelToolsExtensionPointHandler {
+    static {
+        this.ID = "workbench.contrib.toolsExtensionPointHandler";
+    }
+    constructor(productService, languageModelToolsService) {
+        this._registrationDisposables = ( new DisposableMap());
+        languageModelToolsExtensionPoint.setHandler((_extensions, delta) => {
+            for (const extension of delta.added) {
+                const successfullyRegisteredTools = [];
+                let extensionSource;
+                for (const rawTool of extension.value) {
+                    if (!rawTool.name || !rawTool.modelDescription || !rawTool.displayName) {
+                        extension.collector.error(
+                            `Extension '${extension.description.identifier.value}' CANNOT register tool without name, modelDescription, and displayName: ${JSON.stringify(rawTool)}`
+                        );
+                        continue;
+                    }
+                    if (!rawTool.name.match(/^[\w-]+$/)) {
+                        extension.collector.error(
+                            `Extension '${extension.description.identifier.value}' CANNOT register tool with invalid id: ${rawTool.name}. The id must match /^[\\w-]+$/.`
+                        );
+                        continue;
+                    }
+                    if (rawTool.canBeReferencedInPrompt && !rawTool.toolReferenceName) {
+                        extension.collector.error(
+                            `Extension '${extension.description.identifier.value}' CANNOT register tool with 'canBeReferencedInPrompt' set without a 'toolReferenceName': ${JSON.stringify(rawTool)}`
+                        );
+                        continue;
+                    }
+                    if ((rawTool.name.startsWith("copilot_") || rawTool.name.startsWith("vscode_")) && !isProposedApiEnabled(extension.description, "chatParticipantPrivate")) {
+                        extension.collector.error(
+                            `Extension '${extension.description.identifier.value}' CANNOT register tool with name starting with "vscode_" or "copilot_"`
+                        );
+                        continue;
+                    }
+                    if (rawTool.tags?.some(tag => tag.startsWith("copilot_") || tag.startsWith("vscode_")) && !isProposedApiEnabled(extension.description, "chatParticipantPrivate")) {
+                        extension.collector.error(
+                            `Extension '${extension.description.identifier.value}' CANNOT register tool with tags starting with "vscode_" or "copilot_"`
+                        );
+                    }
+                    if (rawTool.legacyToolReferenceFullNames && !isProposedApiEnabled(extension.description, "chatParticipantPrivate")) {
+                        extension.collector.error(
+                            `Extension '${extension.description.identifier.value}' CANNOT use 'legacyToolReferenceFullNames' without the 'chatParticipantPrivate' API proposal enabled`
+                        );
+                        continue;
+                    }
+                    const rawIcon = rawTool.icon;
+                    let icon;
+                    if (typeof rawIcon === "string") {
+                        icon = ThemeIcon.fromString(rawIcon) ?? {
+                            dark: joinPath(extension.description.extensionLocation, rawIcon),
+                            light: joinPath(extension.description.extensionLocation, rawIcon)
+                        };
+                    } else if (rawIcon) {
+                        icon = {
+                            dark: joinPath(extension.description.extensionLocation, rawIcon.dark),
+                            light: joinPath(extension.description.extensionLocation, rawIcon.light)
+                        };
+                    }
+                    const isBuiltinTool = productService.defaultChatAgent?.chatExtensionId ? ExtensionIdentifier.equals(
+                        extension.description.identifier,
+                        productService.defaultChatAgent.chatExtensionId
+                    ) : isProposedApiEnabled(extension.description, "chatParticipantPrivate");
+                    const source = isBuiltinTool ? ToolDataSource.Internal : {
+                        type: "extension",
+                        label: extension.description.displayName ?? extension.description.name,
+                        extensionId: extension.description.identifier
+                    };
+                    const tool = {
+                        ...rawTool,
+                        source,
+                        inputSchema: rawTool.inputSchema,
+                        id: rawTool.name,
+                        icon,
+                        when: rawTool.when ? ContextKeyExpr.deserialize(rawTool.when) : undefined,
+                        alwaysDisplayInputOutput: !isBuiltinTool
+                    };
+                    try {
+                        const disposable = languageModelToolsService.registerToolData(tool);
+                        this._registrationDisposables.set(toToolKey(extension.description.identifier, rawTool.name), disposable);
+                        successfullyRegisteredTools.push(tool);
+                        extensionSource ??= source;
+                    } catch (e) {
+                        extension.collector.error(`Failed to register tool '${rawTool.name}': ${e}`);
+                    }
+                }
+                const hasOwnToolSets = !isFalsyOrEmpty(extension.description.contributes?.languageModelToolSets);
+                if (!hasOwnToolSets && extensionSource?.type === "extension" && successfullyRegisteredTools.length > 0) {
+                    const syntheticKey = toSyntheticToolSetKey(extension.description.identifier);
+                    const toolSet = languageModelToolsService.createToolSet(extensionSource, syntheticKey, extension.description.identifier.value, {
+                        icon: Codicon.extensions,
+                        description: extension.description.displayName ?? extension.description.name,
+                        hiddenInToolsPicker: true
+                    });
+                    const store = ( new DisposableStore());
+                    store.add(toolSet);
+                    transaction(tx => {
+                        for (const t of successfullyRegisteredTools) {
+                            store.add(toolSet.addTool(t, tx));
+                        }
+                    });
+                    this._registrationDisposables.set(syntheticKey, store);
+                }
+            }
+            for (const extension of delta.removed) {
+                this._registrationDisposables.deleteAndDispose(toSyntheticToolSetKey(extension.description.identifier));
+                for (const tool of extension.value) {
+                    this._registrationDisposables.deleteAndDispose(toToolKey(extension.description.identifier, tool.name));
+                }
+            }
+        });
+        languageModelToolSetsExtensionPoint.setHandler((_extensions, delta) => {
+            for (const extension of delta.added) {
+                if (!isProposedApiEnabled(extension.description, "contribLanguageModelToolSets")) {
+                    extension.collector.error(
+                        `Extension '${extension.description.identifier.value}' CANNOT register language model tools because the 'contribLanguageModelToolSets' API proposal is not enabled.`
+                    );
+                    continue;
+                }
+                const isBuiltinTool = productService.defaultChatAgent?.chatExtensionId ? ExtensionIdentifier.equals(
+                    extension.description.identifier,
+                    productService.defaultChatAgent.chatExtensionId
+                ) : isProposedApiEnabled(extension.description, "chatParticipantPrivate");
+                const source = isBuiltinTool ? ToolDataSource.Internal : {
+                    type: "extension",
+                    label: extension.description.displayName ?? extension.description.name,
+                    extensionId: extension.description.identifier
+                };
+                for (const toolSet of extension.value) {
+                    if (isFalsyOrWhitespace(toolSet.name)) {
+                        extension.collector.error(`Tool set '${toolSet.name}' CANNOT have an empty name`);
+                        continue;
+                    }
+                    if (toolSet.legacyFullNames && !isProposedApiEnabled(extension.description, "contribLanguageModelToolSets")) {
+                        extension.collector.error(
+                            `Tool set '${toolSet.name}' CANNOT use 'legacyFullNames' without the 'contribLanguageModelToolSets' API proposal enabled`
+                        );
+                        continue;
+                    }
+                    if (isFalsyOrEmpty(toolSet.tools)) {
+                        extension.collector.error(`Tool set '${toolSet.name}' CANNOT have an empty tools array`);
+                        continue;
+                    }
+                    const tools = [];
+                    const toolSets = [];
+                    const missingToolNames = [];
+                    for (const toolName of toolSet.tools) {
+                        const toolObj = languageModelToolsService.getToolByName(toolName);
+                        if (toolObj) {
+                            tools.push(toolObj);
+                            continue;
+                        }
+                        const toolSetObj = languageModelToolsService.getToolSetByName(toolName);
+                        if (toolSetObj) {
+                            toolSets.push(toolSetObj);
+                            continue;
+                        }
+                        missingToolNames.push(toolName);
+                    }
+                    if (toolSets.length === 0 && tools.length === 0) {
+                        extension.collector.error(
+                            `Tool set '${toolSet.name}' CANNOT have an empty tools array (none of the tools were found)`
+                        );
+                        continue;
+                    }
+                    const store = ( new DisposableStore());
+                    const referenceName = toolSet.referenceName ?? toolSet.name;
+                    const existingToolSet = languageModelToolsService.getToolSetByName(referenceName);
+                    const mergeExisting = isBuiltinTool && existingToolSet?.source === ToolDataSource.Internal;
+                    let obj;
+                    if (mergeExisting) {
+                        obj = existingToolSet;
+                    } else {
+                        obj = languageModelToolsService.createToolSet(
+                            source,
+                            toToolSetKey(extension.description.identifier, toolSet.name),
+                            referenceName,
+                            {
+                                icon: toolSet.icon ? ThemeIcon.fromString(toolSet.icon) : undefined,
+                                description: toolSet.description,
+                                legacyFullNames: toolSet.legacyFullNames,
+                                deprecated: source.type !== "extension"
+                            }
+                        );
+                    }
+                    transaction(tx => {
+                        if (!mergeExisting) {
+                            store.add(obj);
+                        }
+                        tools.forEach(tool => store.add(obj.addTool(tool, tx)));
+                        toolSets.forEach(toolSet => store.add(obj.addToolSet(toolSet, tx)));
+                    });
+                    if (missingToolNames.length > 0) {
+                        const pending = ( new Set(missingToolNames));
+                        const listener = store.add(languageModelToolsService.onDidChangeTools(() => {
+                            for (const toolName of pending) {
+                                const toolObj = languageModelToolsService.getToolByName(toolName);
+                                if (toolObj) {
+                                    store.add(obj.addTool(toolObj));
+                                    pending.delete(toolName);
+                                } else {
+                                    const toolSetObj = languageModelToolsService.getToolSetByName(toolName);
+                                    if (toolSetObj) {
+                                        store.add(obj.addToolSet(toolSetObj));
+                                        pending.delete(toolName);
+                                    }
+                                }
+                            }
+                            if (pending.size === 0) {
+                                store.delete(listener);
+                            }
+                        }));
+                    }
+                    this._registrationDisposables.set(toToolSetKey(extension.description.identifier, toolSet.name), store);
+                }
+            }
+            for (const extension of delta.removed) {
+                for (const toolSet of extension.value) {
+                    this._registrationDisposables.deleteAndDispose(toToolSetKey(extension.description.identifier, toolSet.name));
+                }
+            }
+        });
+    }
+};
+LanguageModelToolsExtensionPointHandler = ( __decorate([( __param(0, IProductService)), ( __param(1, ILanguageModelToolsService))], LanguageModelToolsExtensionPointHandler));
+class LanguageModelToolDataRenderer extends Disposable {
+    constructor() {
+        super(...arguments);
+        this.type = "table";
+    }
+    shouldRender(manifest) {
+        return !!manifest.contributes?.languageModelTools;
+    }
+    render(manifest) {
+        const contribs = manifest.contributes?.languageModelTools ?? [];
+        if (!contribs.length) {
+            return {
+                data: {
+                    headers: [],
+                    rows: []
+                },
+                dispose: () => {}
+            };
+        }
+        const headers = [( localize(10921, "Name")), ( localize(10922, "Display Name")), ( localize(10923, "Description"))];
+        const rows = ( contribs.map(t => {
+            return [( new MarkdownString(`\`${t.name}\``)), t.displayName, t.userDescription ?? t.modelDescription];
+        }));
+        return {
+            data: {
+                headers,
+                rows
+            },
+            dispose: () => {}
+        };
+    }
+}
+( Registry.as(Extensions.ExtensionFeaturesRegistry)).registerExtensionFeature({
+    id: "languageModelTools",
+    label: ( localize(10924, "Language Model Tools")),
+    access: {
+        canToggle: false
+    },
+    renderer: ( new SyncDescriptor(LanguageModelToolDataRenderer))
+});
+class LanguageModelToolSetDataRenderer extends Disposable {
+    constructor() {
+        super(...arguments);
+        this.type = "table";
+    }
+    shouldRender(manifest) {
+        return !!manifest.contributes?.languageModelToolSets;
+    }
+    render(manifest) {
+        const contribs = manifest.contributes?.languageModelToolSets ?? [];
+        if (!contribs.length) {
+            return {
+                data: {
+                    headers: [],
+                    rows: []
+                },
+                dispose: () => {}
+            };
+        }
+        const headers = [( localize(10925, "Name")), ( localize(10926, "Reference Name")), ( localize(10927, "Tools")), ( localize(10928, "Description"))];
+        const rows = ( contribs.map(t => {
+            return [( new MarkdownString(`\`${t.name}\``)), t.referenceName ? ( new MarkdownString(`\`#${t.referenceName}\``)) : "none", t.tools.join(", "), t.description];
+        }));
+        return {
+            data: {
+                headers,
+                rows
+            },
+            dispose: () => {}
+        };
+    }
+}
+( Registry.as(Extensions.ExtensionFeaturesRegistry)).registerExtensionFeature({
+    id: "languageModelToolSets",
+    label: ( localize(10929, "Language Model Tool Sets")),
+    access: {
+        canToggle: false
+    },
+    renderer: ( new SyncDescriptor(LanguageModelToolSetDataRenderer))
+});
+
+export { LanguageModelToolsExtensionPointHandler, toToolSetKey };

package/vscode/src/vs/workbench/contrib/chat/common/tools/languageModelToolsParametersSchema.d.ts

@@ -0,0 +1,6 @@
+/**
+ * A schema for parametersSchema
+ * This is a subset of https://json-schema.org/draft-07/schema to capture what is actually supported by language models for tools, mainly, that they must be an object at the top level.
+ * Possibly it can be whittled down some more based on which attributes are supported by language models.
+ */
+export declare const toolsParametersSchemaSchemaId = "vscode://schemas/toolsParameters";