@theia/ai-mcp 1.57.0-next.37

package/src/browser/mcp-frontend-application-contribution.ts

@@ -0,0 +1,141 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+import { FrontendApplicationContribution, PreferenceProvider, PreferenceService } from '@theia/core/lib/browser';
+import { inject, injectable } from '@theia/core/shared/inversify';
+import { MCPServerDescription, MCPServerManager } from '../common';
+import { MCP_SERVERS_PREF } from './mcp-preferences';
+import { JSONObject } from '@theia/core/shared/@phosphor/coreutils';
+
+interface MCPServersPreferenceValue {
+    command: string;
+    args?: string[];
+    env?: { [key: string]: string };
+};
+
+interface MCPServersPreference {
+    [name: string]: MCPServersPreferenceValue
+};
+
+namespace MCPServersPreference {
+    export function isValue(obj: unknown): obj is MCPServersPreferenceValue {
+        return !!obj && typeof obj === 'object' &&
+            'command' in obj && typeof obj.command === 'string' &&
+            (!('args' in obj) || Array.isArray(obj.args) && obj.args.every(arg => typeof arg === 'string')) &&
+            (!('env' in obj) || !!obj.env && typeof obj.env === 'object' && Object.values(obj.env).every(value => typeof value === 'string'));
+    }
+}
+
+function filterValidValues(servers: unknown): MCPServersPreference {
+    const result: MCPServersPreference = {};
+    if (!servers || typeof servers !== 'object') {
+        return result;
+    }
+    for (const [name, value] of Object.entries(servers)) {
+        if (typeof name === 'string' && MCPServersPreference.isValue(value)) {
+            result[name] = value;
+        }
+    }
+    return result;
+}
+
+@injectable()
+export class McpFrontendApplicationContribution implements FrontendApplicationContribution {
+
+    @inject(PreferenceService)
+    protected preferenceService: PreferenceService;
+
+    @inject(MCPServerManager)
+    protected manager: MCPServerManager;
+
+    protected prevServers: Map<string, MCPServerDescription> = new Map();
+
+    onStart(): void {
+        this.preferenceService.ready.then(() => {
+            const servers = filterValidValues(this.preferenceService.get(
+                MCP_SERVERS_PREF,
+                {}
+            ));
+            this.syncServers(servers);
+            this.prevServers = this.convertToMap(servers);
+
+            this.preferenceService.onPreferenceChanged(event => {
+                if (event.preferenceName === MCP_SERVERS_PREF) {
+                    this.handleServerChanges(filterValidValues(event.newValue));
+                }
+            });
+        });
+    }
+
+    protected handleServerChanges(newServers: MCPServersPreference): void {
+        const oldServers = this.prevServers;
+        const updatedServers = this.convertToMap(newServers);
+
+        for (const [name] of oldServers) {
+            if (!updatedServers.has(name)) {
+                this.manager.removeServer(name);
+            }
+        }
+
+        for (const [name, description] of updatedServers) {
+            const oldDescription = oldServers.get(name);
+            let diff = false;
+            try {
+                // We know that that the descriptions are actual JSONObjects as we construct them ourselves
+                if (!oldDescription || !PreferenceProvider.deepEqual(oldDescription as unknown as JSONObject, description as unknown as JSONObject)) {
+                    diff = true;
+                }
+            } catch (e) {
+                // In some cases the deepEqual function throws an error, so we fall back to assuming that there is a difference
+                // This seems to happen in cases where the objects are structured differently, e.g. whole sub-objects are missing
+                console.debug('Failed to compare MCP server descriptions, assuming a difference', e);
+                diff = true;
+            }
+            if (diff) {
+                this.manager.addOrUpdateServer(description);
+            }
+        }
+
+        this.prevServers = updatedServers;
+    }
+
+    protected syncServers(servers: MCPServersPreference): void {
+        const updatedServers = this.convertToMap(servers);
+
+        for (const [, description] of updatedServers) {
+            this.manager.addOrUpdateServer(description);
+        }
+
+        for (const [name] of this.prevServers) {
+            if (!updatedServers.has(name)) {
+                this.manager.removeServer(name);
+            }
+        }
+
+        this.prevServers = updatedServers;
+    }
+
+    protected convertToMap(servers: MCPServersPreference): Map<string, MCPServerDescription> {
+        const map = new Map<string, MCPServerDescription>();
+        Object.entries(servers).forEach(([name, description]) => {
+            map.set(name, {
+                name,
+                ...description,
+                env: description.env || undefined
+            });
+        });
+        return map;
+    }
+}

package/src/browser/mcp-frontend-module.ts

@@ -0,0 +1,33 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { CommandContribution } from '@theia/core';
+import { ContainerModule } from '@theia/core/shared/inversify';
+import { MCPCommandContribution } from './mcp-command-contribution';
+import { FrontendApplicationContribution, PreferenceContribution, RemoteConnectionProvider, ServiceConnectionProvider } from '@theia/core/lib/browser';
+import { MCPServerManager, MCPServerManagerPath } from '../common/mcp-server-manager';
+import { McpServersPreferenceSchema } from './mcp-preferences';
+import { McpFrontendApplicationContribution } from './mcp-frontend-application-contribution';
+
+export default new ContainerModule(bind => {
+    bind(PreferenceContribution).toConstantValue({ schema: McpServersPreferenceSchema });
+    bind(FrontendApplicationContribution).to(McpFrontendApplicationContribution).inSingletonScope();
+    bind(CommandContribution).to(MCPCommandContribution);
+    bind(MCPServerManager).toDynamicValue(ctx => {
+        const connection = ctx.container.get<ServiceConnectionProvider>(RemoteConnectionProvider);
+        return connection.createProxy<MCPServerManager>(MCPServerManagerPath);
+    }).inSingletonScope();
+});

package/src/browser/mcp-preferences.ts

@@ -0,0 +1,83 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { PreferenceSchema } from '@theia/core/lib/browser/preferences/preference-contribution';
+
+export const MCP_SERVERS_PREF = 'ai-features.mcp.mcpServers';
+
+export const McpServersPreferenceSchema: PreferenceSchema = {
+    type: 'object',
+    properties: {
+        [MCP_SERVERS_PREF]: {
+            type: 'object',
+            title: 'MCP Servers Configuration',
+            markdownDescription: 'Configure MCP servers with command, arguments and optionally environment variables. Each server is identified by a unique key, such as\
+            "brave-search" or "filesystem".\
+            To start a server, use the "MCP: Start MCP Server" command, which enables you to select the desired server.\
+            To stop a server, use the "MCP: Stop MCP Server" command.\
+            \n\
+            Example configuration:\n\
+            ```\
+            {\n\
+              "brave-search": {\n\
+                "command": "npx",\n\
+                "args": [\n\
+                  "-y",\n\
+                  "@modelcontextprotocol/server-brave-search"\n\
+                ],\n\
+                "env": {\n\
+                  "BRAVE_API_KEY": "YOUR_API_KEY"\n\
+                }\n\
+              },\n\
+              "filesystem": {\n\
+                "command": "npx",\n\
+                "args": ["-y", "@modelcontextprotocol/server-filesystem", "/Users/YOUR_USERNAME/Desktop"],\n\
+                "env": {\n\
+                  "CUSTOM_ENV_VAR": "custom-value"\n\
+                }\n\
+              }\n\
+            }\
+            ```',
+            additionalProperties: {
+                type: 'object',
+                properties: {
+                    command: {
+                        type: 'string',
+                        title: 'Command to execute the MCP server',
+                        markdownDescription: 'The command used to start the MCP server, e.g., "uvx" or "npx".'
+                    },
+                    args: {
+                        type: 'array',
+                        title: 'Arguments for the command',
+                        markdownDescription: 'An array of arguments to pass to the command.',
+                        items: {
+                            type: 'string'
+                        }
+                    },
+                    env: {
+                        type: 'object',
+                        title: 'Environment variables',
+                        markdownDescription: 'Optional environment variables to set for the server, such as an API key.',
+                        additionalProperties: {
+                            type: 'string'
+                        }
+                    }
+                },
+                required: ['command', 'args']
+            }
+        }
+    }
+};

package/src/common/index.ts

@@ -0,0 +1,16 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+export * from './mcp-server-manager';

package/src/common/mcp-server-manager.ts

@@ -0,0 +1,58 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import type { Client } from '@modelcontextprotocol/sdk/client/index';
+
+export interface MCPServer {
+    callTool(toolName: string, arg_string: string): ReturnType<Client['callTool']>;
+    getTools(): ReturnType<Client['listTools']>;
+}
+
+export interface MCPServerManager {
+    callTool(serverName: string, toolName: string, arg_string: string): ReturnType<MCPServer['callTool']>;
+    removeServer(name: string): void;
+    addOrUpdateServer(description: MCPServerDescription): void;
+    getTools(serverName: string): ReturnType<MCPServer['getTools']>
+    getServerNames(): Promise<string[]>;
+    startServer(serverName: string): Promise<void>;
+    stopServer(serverName: string): Promise<void>;
+    getStartedServers(): Promise<string[]>;
+}
+
+export interface MCPServerDescription {
+    /**
+     * The unique name of the MCP server.
+     */
+    name: string;
+
+    /**
+     * The command to execute the MCP server.
+     */
+    command: string;
+
+    /**
+     * An array of arguments to pass to the command.
+     */
+    args?: string[];
+
+    /**
+     * Optional environment variables to set when starting the server.
+     */
+    env?: { [key: string]: string };
+}
+
+export const MCPServerManager = Symbol('MCPServerManager');
+export const MCPServerManagerPath = '/services/mcpservermanager';

package/src/node/mcp-backend-module.ts

@@ -0,0 +1,31 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+import { ContainerModule } from '@theia/core/shared/inversify';
+import { ConnectionHandler, RpcConnectionHandler } from '@theia/core';
+import { MCPServerManagerImpl } from './mcp-server-manager-impl';
+import { MCPServerManager, MCPServerManagerPath } from '../common/mcp-server-manager';
+
+export default new ContainerModule(bind => {
+    bind(MCPServerManager).to(MCPServerManagerImpl).inSingletonScope();
+    bind(ConnectionHandler).toDynamicValue(ctx => new RpcConnectionHandler(
+        MCPServerManagerPath,
+        () => {
+            const service = ctx.container.get<MCPServerManager>(MCPServerManager);
+            return service;
+        }
+    )).inSingletonScope();
+});

package/src/node/mcp-server-manager-impl.ts

@@ -0,0 +1,93 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+import { injectable } from '@theia/core/shared/inversify';
+import { MCPServerDescription, MCPServerManager } from '../common/mcp-server-manager';
+import { MCPServer } from './mcp-server';
+
+@injectable()
+export class MCPServerManagerImpl implements MCPServerManager {
+
+    protected servers: Map<string, MCPServer> = new Map();
+
+    async stopServer(serverName: string): Promise<void> {
+        const server = this.servers.get(serverName);
+        if (!server) {
+            throw new Error(`MCP server "${serverName}" not found.`);
+        }
+        server.stop();
+        console.log(`MCP server "${serverName}" stopped.`);
+    }
+
+    async getStartedServers(): Promise<string[]> {
+        const startedServers: string[] = [];
+        for (const [name, server] of this.servers.entries()) {
+            if (server.isStarted()) {
+                startedServers.push(name);
+            }
+        }
+        return startedServers;
+    }
+
+    callTool(serverName: string, toolName: string, arg_string: string): ReturnType<MCPServer['callTool']> {
+        const server = this.servers.get(serverName);
+        if (!server) {
+            throw new Error(`MCP server "${toolName}" not found.`);
+        }
+        return server.callTool(toolName, arg_string);
+    }
+
+    async startServer(serverName: string): Promise<void> {
+        const server = this.servers.get(serverName);
+        if (!server) {
+            throw new Error(`MCP server "${serverName}" not found.`);
+        }
+        await server.start();
+    }
+    async getServerNames(): Promise<string[]> {
+        return Array.from(this.servers.keys());
+    }
+
+    public async getTools(serverName: string): ReturnType<MCPServer['getTools']> {
+        const server = this.servers.get(serverName);
+        if (!server) {
+            throw new Error(`MCP server "${serverName}" not found.`);
+        }
+        return server.getTools();
+
+    }
+
+    addOrUpdateServer(description: MCPServerDescription): void {
+        const { name, command, args, env } = description;
+        const existingServer = this.servers.get(name);
+
+        if (existingServer) {
+            existingServer.update(command, args, env);
+        } else {
+            const newServer = new MCPServer(name, command, args, env);
+            this.servers.set(name, newServer);
+        }
+    }
+
+    removeServer(name: string): void {
+        const server = this.servers.get(name);
+        if (server) {
+            server.stop();
+            this.servers.delete(name);
+        } else {
+            console.warn(`MCP server "${name}" not found.`);
+        }
+    }
+}

package/src/node/mcp-server.ts

@@ -0,0 +1,111 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+import { StdioClientTransport } from '@modelcontextprotocol/sdk/client/stdio';
+import { Client } from '@modelcontextprotocol/sdk/client/index.js';
+
+export class MCPServer {
+    private name: string;
+    private command: string;
+    private args?: string[];
+    private client: Client;
+    private env?: { [key: string]: string };
+    private started: boolean = false;
+
+    constructor(name: string, command: string, args?: string[], env?: Record<string, string>) {
+        this.name = name;
+        this.command = command;
+        this.args = args;
+        this.env = env;
+    }
+
+    isStarted(): boolean {
+        return this.started;
+    }
+
+    async start(): Promise<void> {
+        if (this.started) {
+            return;
+        }
+        console.log(`Starting server "${this.name}" with command: ${this.command} and args: ${this.args?.join(' ')} and env: ${JSON.stringify(this.env)}`);
+        // Filter process.env to exclude undefined values
+        const sanitizedEnv: Record<string, string> = Object.fromEntries(
+            Object.entries(process.env).filter((entry): entry is [string, string] => entry[1] !== undefined)
+        );
+
+        const mergedEnv: Record<string, string> = {
+            ...sanitizedEnv,
+            ...(this.env || {})
+        };
+        const transport = new StdioClientTransport({
+            command: this.command,
+            args: this.args,
+            env: mergedEnv,
+        });
+        transport.onerror = error => {
+            console.error('Error: ' + error);
+        };
+
+        this.client = new Client({
+            name: 'theia-client',
+            version: '1.0.0',
+        }, {
+            capabilities: {}
+        });
+        this.client.onerror = error => {
+            console.error('Error in MCP client: ' + error);
+        };
+
+        await this.client.connect(transport);
+        this.started = true;
+    }
+
+    async callTool(toolName: string, arg_string: string): ReturnType<Client['callTool']> {
+        let args;
+        try {
+            args = JSON.parse(arg_string);
+        } catch (error) {
+            console.error(
+                `Failed to parse arguments for calling tool "${toolName}" in MCP server "${this.name}" with command "${this.command}".
+                Invalid JSON: ${arg_string}`,
+                error
+            );
+        }
+        const params = {
+            name: toolName,
+            arguments: args,
+        };
+        return this.client.callTool(params);
+    }
+
+    async getTools(): ReturnType<Client['listTools']> {
+        return this.client.listTools();
+    }
+
+    update(command: string, args?: string[], env?: { [key: string]: string }): void {
+        this.command = command;
+        this.args = args;
+        this.env = env;
+    }
+
+    stop(): void {
+        if (!this.started || !this.client) {
+            return;
+        }
+        console.log(`Stopping MCP server "${this.name}"`);
+        this.client.close();
+        this.started = false;
+    }
+}

package/src/package.spec.ts

@@ -0,0 +1,28 @@
+// *****************************************************************************
+// Copyright (C) 2024 EclipseSource GmbH and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+
+/* note: this bogus test file is required so that
+   we are able to run mocha unit tests on this
+   package, without having any actual unit tests in it.
+   This way a coverage report will be generated,
+   showing 0% coverage, instead of no report.
+   This file can be removed once we have real unit
+   tests in place. */
+
+describe('ai-mcp package', () => {
+
+    it('support code coverage statistics', () => true);
+});