Add Dev Proxy MCP Server. Closes #244

Closes #244

Author: garrytrinder

CHANGELOG.md

@@ -37,6 +37,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Command: `dev-proxy-toolkit.restart` - Restart Dev Proxy
 - Snippets: `devproxy-plugin-typespec-generator` - TypeSpecGeneratorPlugin instance
 - Snippets: `devproxy-plugin-typespec-generator-config` - TypeSpecGeneratorPlugin config section
+- MCP Server: Dev Proxy
 
 ### Changed:
 

README.md

@@ -55,6 +55,11 @@ Shown when the active document is a Dev Proxy configuration file
 - Start recording
 - Stop recording
 
+### MCP Server
+
+- Find Dev Proxy documentation
+- Get the installed Dev Proxy version
+
 ### Notifications
 
 - Not installed

package-lock.json

@@ -1,4 +1,7 @@
 {
+  "enabledApiProposals": [
+    "mcpConfigurationProvider"
+  ],
   "name": "dev-proxy-toolkit",
   "displayName": "Dev Proxy Toolkit",
   "description": "Makes it easy to create and update Dev Proxy configuration files.",
@@ -119,6 +122,12 @@
         }
       ]
     },
+    "modelContextServerCollections": [
+      {
+        "id": "devproxymcp",
+        "label": "Dev Proxy"
+      }
+    ],
     "snippets": [
       {
         "language": "json",
@@ -189,6 +198,7 @@
     "@types/vscode": "^1.89.0",
     "@typescript-eslint/eslint-plugin": "^6.21.0",
     "@typescript-eslint/parser": "^6.21.0",
+    "@vscode/dts": "^0.4.1",
     "@vscode/test-cli": "^0.0.10",
     "@vscode/test-electron": "^2.4.1",
     "copy-webpack-plugin": "^12.0.2",
@@ -203,4 +213,4 @@
   "dependencies": {
     "json-to-ast": "^2.1.0"
   }
-}
+}

package.json

@@ -7,20 +7,23 @@ import { createStatusBar, statusBarLoop, updateStatusBar } from './statusbar';
 import { registerCodeActions } from './codeactions';
 import { updateGlobalState } from './state';
 import { VersionPreference } from './enums';
+import { registerMcpServer } from './mcp';
 
 export const activate = async (context: vscode.ExtensionContext): Promise<vscode.ExtensionContext> => {
+
   const configuration = vscode.workspace.getConfiguration('dev-proxy-toolkit');
   const versionPreference = configuration.get('version') as VersionPreference;
-
+  
   const statusBar = createStatusBar(context);
   await updateGlobalState(context, versionPreference);
-
+  
   const collection = vscode.languages.createDiagnosticCollection('dev-proxy-toolkit');
-
+  
   registerDocumentListeners(context, collection);
   registerCodeActions(context);
   registerCodeLens(context);
   registerCommands(context, configuration);
+  registerMcpServer(context);
 
   const notification = handleStartNotification(context);
   processNotification(notification);

src/extension.ts

@@ -0,0 +1,24 @@
+import * as vscode from 'vscode';
+
+export const registerMcpServer = (context: vscode.ExtensionContext) => {
+
+    const didChangeEmitter = new vscode.EventEmitter<void>();
+
+    context.subscriptions.push(vscode.lm.registerMcpConfigurationProvider('devproxymcp', {
+        onDidChange: didChangeEmitter.event,
+        provideMcpServerDefinitions: async () => {
+            const server: vscode.McpStdioServerDefinition =
+            {
+                label: "Dev Proxy",
+                command: "npx",
+                args: [
+                    "-y",
+                    "@devproxy/mcp"
+                ],
+                env: {}
+            };
+
+            return [server];
+        }
+    }));
+};

src/mcp.ts

@@ -0,0 +1,137 @@
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+declare module 'vscode' {
+
+	// https://github.com/microsoft/vscode/issues/243522
+
+	/**
+	 * McpStdioServerDefinition represents an MCP server available by running
+	 * a local process and listening to its stdin and stdout streams.
+	 */
+	export class McpStdioServerDefinition {
+		/**
+		 * The human-readable name of the server.
+		 */
+		label: string;
+
+		/**
+		 * The working directory used to start the server.
+		 */
+		cwd?: Uri;
+
+		/**
+		 * The command used to start the server. Node.js-based servers may use
+		 * `process.execPath` to use the editor's version of Node.js to run the script.
+		 */
+		command: string;
+		/**
+		 * Additional command-line arguments passed to the server.
+		 */
+		args: string[];
+
+		/**
+		 * Optional additional environment information for the server. Variables
+		 * in this environment will overwrite or remove (if null) the default
+		 * environment variables.
+		 */
+		env: Record<string, string | number | null>;
+
+		/**
+		 * Optional version identification for the server. If this changes, the
+		 * editor will indicate that tools have changed and prompt to refresh them.
+		 */
+		version?: string;
+
+		/**
+		 * @param label The human-readable name of the server.
+		 * @param command The command used to start the server.
+		 * @param args Additional command-line arguments passed to the server.
+		 * @param env Optional additional environment information for the server.
+		 * @param version Optional version identification for the server.
+		 */
+		constructor(label: string, command: string, args?: string[], env?: Record<string, string | number | null>, version?: string);
+	}
+
+	/**
+	 * McpHttpServerDefinition represents an MCP server available using the
+	 * Streamable HTTP transport.
+	 */
+	export class McpHttpServerDefinition {
+		/**
+		 * The human-readable name of the server.
+		 */
+		label: string;
+
+		/**
+		 * The URI of the server. The editor will make a POST request to this URI
+		 * to begin each session.
+		 */
+		uri: Uri;
+
+		/**
+		 * Optional additional heads included with each request to the server.
+		 */
+		headers: Record<string, string>;
+
+		/**
+		 * Optional version identification for the server. If this changes, the
+		 * editor will indicate that tools have changed and prompt to refresh them.
+		 */
+		version?: string;
+
+		/**
+		 * @param label The human-readable name of the server.
+		 * @param uri The URI of the server.
+		 * @param headers Optional additional heads included with each request to the server.
+		 */
+		constructor(label: string, uri: Uri, headers?: Record<string, string>, version?: string);
+	}
+
+	export type McpServerDefinition = McpStdioServerDefinition | McpHttpServerDefinition;
+
+	/**
+	 * A type that can provide server configurations. This may only be used in
+	 * conjunction with `contributes.modelContextServerCollections` in the
+	 * extension's package.json.
+	 *
+	 * To allow the editor to cache available servers, extensions should register
+	 * this before `activate()` resolves.
+	 */
+	export interface McpConfigurationProvider<T extends McpServerDefinition = McpServerDefinition> {
+		/**
+		 * Optional event fired to signal that the set of available servers has changed.
+		 */
+		onDidChange?: Event<void>;
+
+		/**
+		 * Provides available MCP servers. The editor will call this method eagerly
+		 * to ensure the availability of servers for the language model, and so
+		 * extensions should not take actions which would require user
+		 * interaction, such as authentication.
+		 *
+		 * @param token A cancellation token.
+		 * @returns An array of MCP available MCP servers
+		 */
+		provideMcpServerDefinitions(token: CancellationToken): ProviderResult<T[]>;
+
+		/**
+		 * This function will be called when the editor needs to start MCP server.
+		 * At this point, the extension may take any actions which may require user
+		 * interaction, such as authentication.
+		 *
+		 * The extension may return undefined on error to indicate that the server
+		 * should not be started.
+		 *
+		 * @param server The MCP server to resolve
+		 * @param token A cancellation token.
+		 * @returns The given, resolved server or thenable that resolves to such.
+		 */
+		resolveMcpServerDefinition?(server: T, token: CancellationToken): ProviderResult<T>;
+	}
+
+	namespace lm {
+		export function registerMcpConfigurationProvider(id: string, provider: McpConfigurationProvider): Disposable;
+	}
+}