Merge pull request #88 from Automattic/vscode-mcp-provider

Add VS Code workspace MCP configuration

Author: chubes4

assets/vscode/icon.png

@@ -1,21 +1,29 @@
 # WordPress Studio for VS Code
 
-This is the smallest useful VS Code extension scaffold generated by Build with WordPress. It does not publish anything to the Marketplace from this repository.
+This VS Code extension integrates WordPress Studio MCP with the current workspace by writing VS Code's supported `.vscode/mcp.json` configuration shape. It does not publish anything to the Marketplace from this repository.
 
 ## What it includes
 
 - `package.json` with VS Code extension metadata and command contributions.
-- `extension.js` with thin commands to check whether `studio` is available and to show or copy the bundled MCP config.
+- `extension.js` with commands to validate Studio availability, show/copy the bundled MCP config, and merge the WordPress Studio MCP servers into the open workspace.
 - `mcp.json` with `wordpress-studio` and `wordpress-telemetry` server entries.
 - `skills/` as reference Build with WordPress playbooks for editor users and future extension behavior.
 
+## MCP integration
+
+VS Code supports workspace MCP configuration through `.vscode/mcp.json` with a top-level `servers` object. The `WordPress Studio: Configure Workspace MCP` command creates or updates that file in the open workspace, preserves unrelated server entries, and prompts before replacing an existing managed WordPress server that differs from the bundled configuration.
+
+The extension targets VS Code `^1.95.0`. The published `@types/vscode@1.95.0` API surface does not include `contributes.mcpServerDefinitionProviders` or `vscode.lm.registerMcpServerDefinitionProvider`, so this package does not register an extension-owned MCP provider yet. When this package raises its VS Code engine to a version with stable MCP provider APIs, the file-write command can be complemented with provider registration.
+
 ## Marketplace placeholder
 
 The manifest uses the Visual Studio Marketplace publisher `automattic`. This repo intentionally does not include publish automation or Marketplace credentials.
 
 ## Commands
 
 - `WordPress Studio: Check Studio CLI` runs `studio --version` and reports whether the CLI is on `PATH`.
+- `WordPress Studio: Configure Workspace MCP` merges the bundled `wordpress-studio` server, and `wordpress-telemetry` when bundled, into the open workspace's `.vscode/mcp.json`.
+- `WordPress Studio: Validate MCP Config` runs `studio --version` and verifies the bundled VS Code MCP config contains `servers.wordpress-studio`.
 - `WordPress Studio: Show MCP Config` opens the bundled `mcp.json` in an untitled JSON editor.
 - `WordPress Studio: Copy MCP Config` copies the bundled `mcp.json` to the clipboard.
 

plugins/vscode/README.md

@@ -1,8 +1,10 @@
 const vscode = require("vscode");
 const { execFile } = require("child_process");
-const { readFile } = require("fs/promises");
+const { mkdir, readFile, writeFile } = require("fs/promises");
 const path = require("path");
 
+const managedServerNames = ["wordpress-studio", "wordpress-telemetry"];
+
 function runStudioVersion() {
   return new Promise((resolve, reject) => {
     execFile("studio", ["--version"], { timeout: 10000 }, (error, stdout, stderr) => {
@@ -19,6 +21,62 @@ async function readMcpConfig(context) {
   return readFile(path.join(context.extensionPath, "mcp.json"), "utf8");
 }
 
+async function readBundledMcpConfig(context) {
+  const raw = await readMcpConfig(context);
+  const config = JSON.parse(raw);
+
+  if (!config.servers || typeof config.servers !== "object") {
+    throw new Error("Bundled MCP config is missing the VS Code servers wrapper.");
+  }
+
+  if (!config.servers["wordpress-studio"]) {
+    throw new Error("Bundled MCP config is missing servers.wordpress-studio.");
+  }
+
+  return config;
+}
+
+function getWorkspaceFolder() {
+  const folders = vscode.workspace.workspaceFolders ?? [];
+
+  if (folders.length === 0) {
+    return null;
+  }
+
+  return folders[0];
+}
+
+function configsMatch(left, right) {
+  return JSON.stringify(left) === JSON.stringify(right);
+}
+
+async function readWorkspaceMcpConfig(mcpPath) {
+  try {
+    const raw = await readFile(mcpPath, "utf8");
+    const config = JSON.parse(raw);
+
+    if (!config || typeof config !== "object" || Array.isArray(config)) {
+      throw new Error("Workspace MCP config must be a JSON object.");
+    }
+
+    if (config.servers === undefined) {
+      config.servers = {};
+    }
+
+    if (!config.servers || typeof config.servers !== "object" || Array.isArray(config.servers)) {
+      throw new Error("Workspace MCP config servers field must be a JSON object.");
+    }
+
+    return config;
+  } catch (error) {
+    if (error.code === "ENOENT") {
+      return { servers: {} };
+    }
+
+    throw error;
+  }
+}
+
 async function checkStudio() {
   try {
     const version = await runStudioVersion();
@@ -32,6 +90,90 @@ async function checkStudio() {
   }
 }
 
+async function configureWorkspaceMcp(context) {
+  const workspaceFolder = getWorkspaceFolder();
+
+  if (!workspaceFolder) {
+    vscode.window.showErrorMessage("Open a workspace folder before configuring WordPress Studio MCP.");
+    return;
+  }
+
+  let bundledConfig;
+  try {
+    bundledConfig = await readBundledMcpConfig(context);
+  } catch (error) {
+    vscode.window.showErrorMessage("Cannot configure WordPress Studio MCP. " + error.message);
+    return;
+  }
+
+  const workspaceMcpDir = path.join(workspaceFolder.uri.fsPath, ".vscode");
+  const workspaceMcpPath = path.join(workspaceMcpDir, "mcp.json");
+  let workspaceConfig;
+
+  try {
+    workspaceConfig = await readWorkspaceMcpConfig(workspaceMcpPath);
+  } catch (error) {
+    vscode.window.showErrorMessage("Cannot read workspace MCP config. " + error.message);
+    return;
+  }
+
+  for (const serverName of managedServerNames) {
+    const bundledServer = bundledConfig.servers[serverName];
+
+    if (!bundledServer) {
+      continue;
+    }
+
+    const existingServer = workspaceConfig.servers[serverName];
+    if (existingServer && !configsMatch(existingServer, bundledServer)) {
+      const choice = await vscode.window.showWarningMessage(
+        "Workspace MCP server " + serverName + " already exists and differs from the bundled WordPress Studio config.",
+        { modal: true },
+        "Replace",
+        "Cancel"
+      );
+
+      if (choice !== "Replace") {
+        vscode.window.showInformationMessage("WordPress Studio MCP config was not changed.");
+        return;
+      }
+    }
+
+    workspaceConfig.servers[serverName] = bundledServer;
+  }
+
+  try {
+    await mkdir(workspaceMcpDir, { recursive: true });
+    await writeFile(workspaceMcpPath, JSON.stringify(workspaceConfig, null, 2) + "\n", "utf8");
+    vscode.window.showInformationMessage("Configured WordPress Studio MCP at " + workspaceMcpPath + ".");
+  } catch (error) {
+    vscode.window.showErrorMessage("Cannot write workspace MCP config. " + error.message);
+  }
+}
+
+async function validateMcpConfig(context) {
+  let version;
+  try {
+    version = await runStudioVersion();
+  } catch (error) {
+    vscode.window.showErrorMessage(
+      "Studio CLI was not found. Install WordPress Studio and ensure the studio command is on PATH. " + error.message
+    );
+    return;
+  }
+
+  try {
+    await readBundledMcpConfig(context);
+  } catch (error) {
+    vscode.window.showErrorMessage("Bundled WordPress Studio MCP config is invalid. " + error.message);
+    return;
+  }
+
+  vscode.window.showInformationMessage(
+    "WordPress Studio MCP config is valid. Studio CLI: " + (version || "available") + "."
+  );
+}
+
 async function showMcpConfig(context) {
   const config = await readMcpConfig(context);
   const document = await vscode.workspace.openTextDocument({
@@ -50,6 +192,8 @@ async function copyMcpConfig(context) {
 function activate(context) {
   context.subscriptions.push(
     vscode.commands.registerCommand("wordpressStudio.checkStudio", checkStudio),
+    vscode.commands.registerCommand("wordpressStudio.configureWorkspaceMcp", () => configureWorkspaceMcp(context)),
+    vscode.commands.registerCommand("wordpressStudio.validateMcpConfig", () => validateMcpConfig(context)),
     vscode.commands.registerCommand("wordpressStudio.showMcpConfig", () => showMcpConfig(context)),
     vscode.commands.registerCommand("wordpressStudio.copyMcpConfig", () => copyMcpConfig(context))
   );

plugins/vscode/extension.js

@@ -13,11 +13,13 @@
     "url": "https://github.com/Automattic/build-with-wordpress.git"
   },
   "license": "GPL-2.0-or-later",
+  "icon": "images/icon.png",
   "files": [
     "extension.js",
     "mcp.json",
     "README.md",
     "LICENSE",
+    "images/icon.png",
     "skills/**"
   ],
   "engines": {
@@ -34,6 +36,8 @@
   ],
   "activationEvents": [
     "onCommand:wordpressStudio.checkStudio",
+    "onCommand:wordpressStudio.configureWorkspaceMcp",
+    "onCommand:wordpressStudio.validateMcpConfig",
     "onCommand:wordpressStudio.showMcpConfig",
     "onCommand:wordpressStudio.copyMcpConfig"
   ],
@@ -44,6 +48,14 @@
         "command": "wordpressStudio.checkStudio",
         "title": "WordPress Studio: Check Studio CLI"
       },
+      {
+        "command": "wordpressStudio.configureWorkspaceMcp",
+        "title": "WordPress Studio: Configure Workspace MCP"
+      },
+      {
+        "command": "wordpressStudio.validateMcpConfig",
+        "title": "WordPress Studio: Validate MCP Config"
+      },
       {
         "command": "wordpressStudio.showMcpConfig",
         "title": "WordPress Studio: Show MCP Config"