Skip to content

Commit 17e8b5c

Browse files
committed
Clarify VS Code extension usage
1 parent 061da62 commit 17e8b5c

3 files changed

Lines changed: 50 additions & 18 deletions

File tree

plugins/vscode/README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,35 @@
11
# WordPress Studio for VS Code
22

3-
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.
3+
Use WordPress Studio from VS Code Copilot Agent by connecting the current workspace to Studio's MCP tools. The extension writes VS Code's supported `.vscode/mcp.json` configuration so Copilot Agent can use Studio for local WordPress site management, WP-CLI, screenshots, block validation, and audits.
4+
5+
## Quick start
6+
7+
1. Install WordPress Studio and make sure the `studio` command is available on your `PATH`.
8+
2. Open a workspace folder in VS Code.
9+
3. Open the Command Palette with `Cmd+Shift+P`.
10+
4. Run `WordPress Studio: Check Studio CLI`.
11+
5. Run `WordPress Studio: Configure Workspace MCP`.
12+
6. Open Copilot Chat in Agent mode and ask it to use the `wordpress-studio` tools.
13+
14+
Example prompts:
15+
16+
- `Use the wordpress-studio MCP tools to list my Studio sites.`
17+
- `Use WordPress Studio to inspect the current site and tell me what tools are available.`
18+
- `Use wp_cli through WordPress Studio to check the active theme.`
19+
20+
If Copilot does not see the tools immediately, reload the VS Code window and try again.
421

522
## What it includes
623

7-
- `package.json` with VS Code extension metadata and command contributions.
8-
- `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.
24+
- commands to validate Studio availability, show/copy the bundled MCP config, and merge the WordPress Studio MCP servers into the open workspace.
925
- `mcp.json` with `wordpress-studio` and `wordpress-telemetry` server entries.
1026
- `skills/` as reference Build with WordPress playbooks for editor users and future extension behavior.
1127

1228
## MCP integration
1329

1430
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.
1531

16-
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.
17-
18-
## Marketplace placeholder
19-
20-
The manifest uses the Visual Studio Marketplace publisher `automattic`. This repo intentionally does not include publish automation or Marketplace credentials.
32+
This extension writes workspace MCP config rather than registering an extension-owned MCP provider. That keeps the integration explicit and reviewable in the workspace.
2133

2234
## Commands
2335

scripts/build-plugins.mjs

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -706,24 +706,36 @@ function buildVsCodeReadme({ skillNames }) {
706706

707707
return `# WordPress Studio for VS Code
708708
709-
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.
709+
Use WordPress Studio from VS Code Copilot Agent by connecting the current workspace to Studio's MCP tools. The extension writes VS Code's supported \`.vscode/mcp.json\` configuration so Copilot Agent can use Studio for local WordPress site management, WP-CLI, screenshots, block validation, and audits.
710+
711+
## Quick start
712+
713+
1. Install WordPress Studio and make sure the \`studio\` command is available on your \`PATH\`.
714+
2. Open a workspace folder in VS Code.
715+
3. Open the Command Palette with \`Cmd+Shift+P\`.
716+
4. Run \`WordPress Studio: Check Studio CLI\`.
717+
5. Run \`WordPress Studio: Configure Workspace MCP\`.
718+
6. Open Copilot Chat in Agent mode and ask it to use the \`wordpress-studio\` tools.
719+
720+
Example prompts:
721+
722+
- \`Use the wordpress-studio MCP tools to list my Studio sites.\`
723+
- \`Use WordPress Studio to inspect the current site and tell me what tools are available.\`
724+
- \`Use wp_cli through WordPress Studio to check the active theme.\`
725+
726+
If Copilot does not see the tools immediately, reload the VS Code window and try again.
710727
711728
## What it includes
712729
713-
- \`package.json\` with VS Code extension metadata and command contributions.
714-
- \`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.
730+
- commands to validate Studio availability, show/copy the bundled MCP config, and merge the WordPress Studio MCP servers into the open workspace.
715731
- \`mcp.json\` with \`wordpress-studio\` and \`wordpress-telemetry\` server entries.
716732
- \`skills/\` as reference Build with WordPress playbooks for editor users and future extension behavior.
717733
718734
## MCP integration
719735
720736
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.
721737
722-
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.
723-
724-
## Marketplace placeholder
725-
726-
The manifest uses the Visual Studio Marketplace publisher \`automattic\`. This repo intentionally does not include publish automation or Marketplace credentials.
738+
This extension writes workspace MCP config rather than registering an extension-owned MCP provider. That keeps the integration explicit and reviewable in the workspace.
727739
728740
## Commands
729741

scripts/verify-plugins.mjs

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -678,8 +678,16 @@ async function verifyVsCodePlugin(skillNames) {
678678
}
679679

680680
const readme = await readFile(path.join(vsCodePluginDir, "README.md"), "utf8");
681-
if (!readme.includes("publisher `automattic`")) {
682-
throw new Error("VS Code README must document the Marketplace publisher");
681+
if (!readme.includes("Copilot Chat in Agent mode")) {
682+
throw new Error("VS Code README must explain Copilot Agent usage");
683+
}
684+
685+
if (!readme.includes("WordPress Studio: Configure Workspace MCP")) {
686+
throw new Error("VS Code README must explain workspace MCP setup");
687+
}
688+
689+
if (!readme.includes("Use the wordpress-studio MCP tools to list my Studio sites.")) {
690+
throw new Error("VS Code README must include a WordPress Studio MCP example prompt");
683691
}
684692
}
685693

0 commit comments

Comments
 (0)