Skip to content

Add VS Code install instructions to README #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mbaiza27 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add VS Code install instructions to README #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6e5bfd
update readme with VS Code usage instructions
Apr 3, 2025
d4b5bad
update buttons
Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,47 @@ You shouldn't ever need to rerun `npx workers-mcp install:claude`, but it's safe

## Using with Other MCP Clients

### VS Code

For one-click installation, click one of the install buttons below:

[![Install with NPX in VS Code](https://img.shields.io/badge/VS_Code-NPM-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=workers-mcp&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22workers-mcp%22%2C%22run%22%2C%22workers-mcp%22%2C%22https%3A%2F%2Fyour-server-url.workers.dev%22%2C%22%24%7BworkspaceFolder%7D%22%5D%2C%22env%22%3A%7B%7D%7D) [![Install with NPX in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-NPM-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://insiders.vscode.dev/redirect/mcp/install?name=workers-mcp&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22workers-mcp%22%2C%22run%22%2C%22workers-mcp%22%2C%22https%3A%2F%2Fyour-server-url.workers.dev%22%2C%22%24%7BworkspaceFolder%7D%22%5D%2C%22env%22%3A%7B%7D%7D&quality=insiderss)

#### Manual Installation

Add the following JSON block to your User Settings (JSON) file in VS Code. You can do this by pressing `Ctrl + Shift + P` and typing `Preferences: Open User Settings (JSON)`.

```json
{
"mcp": {
"servers": {
"workers-mcp": {
"command": "npx",
"args": ["workers-mcp", "run", "workers-mcp", "https://your-server-url.workers.dev", "${workspaceFolder}"],
"env": {}
}
}
}
}
```

Optionally, you can add it to a file called `.vscode/mcp.json` in your workspace. This will allow you to share the configuration with others.

```json
{
"servers": {
"workers-mcp": {
"command": "npx",
"args": ["workers-mcp", "run", "workers-mcp", "https://your-server-url.workers.dev", "${workspaceFolder}"],
"env": {}
}
}
}
```

Remember to replace `https://your-server-url.workers.dev` with your actual Worker URL.


### Cursor

To get your Cloudflare MCP server working in Cursor, you need to combine the 'command' and 'args' from your config file into a single string and use type 'command'.
Expand Down Expand Up @@ -95,6 +136,7 @@ In Cursor, create an MCP server entry with:
* type: `command`
* command: `/path/to/workers-mcp run your-mcp-server-name https://your-server-url.workers.dev /path/to/your/project`


### Other MCP Clients

For Windsurf and other MCP clients, update your configuration file to include your worker so you could use the tools directly from the client:
Expand Down