Skip to content

Commit 7c693d4

Browse files
authored
Update installation steps in MCP readme (#581)
1 parent 2ecfee1 commit 7c693d4

File tree

1 file changed

+29
-22
lines changed

1 file changed

+29
-22
lines changed

packages/mcp/README.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -25,59 +25,66 @@ Provides tools to generate smart contract source code for the following language
2525

2626
For quick installation, use the button below.
2727

28-
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=openzeppelin-contracts-wizard&config=eyJjb21tYW5kIjoibnB4IEBvcGVuemVwcGVsaW4vd2l6YXJkLW1jcCJ9)
28+
[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=openzeppelin-contracts-wizard&config=eyJjb21tYW5kIjoibnB4IC15IEBvcGVuemVwcGVsaW4vd2l6YXJkLW1jcCJ9)
2929

3030
For manual installation:
31-
1. Go to Settings > Cursor Settings > MCP Tools > New MCP Server.
32-
2. Add the following to your MCP configuration file and save.
33-
```
34-
{
35-
"mcpServers": {
36-
"openzeppelin-contracts-wizard": {
37-
"command": "npx",
38-
"args": [
39-
"@openzeppelin/wizard-mcp"
40-
]
41-
}
42-
}
43-
}
44-
```
31+
1. Go to Settings > Cursor Settings > Tools & Integrations > MCP Tools > New MCP Server.
32+
2. Add the contents from the [Client Configuration](#client-configuration-cursorwindsurfclaude-desktop) section to your MCP configuration file and save.
4533
3. See the MCP server in the list.
4634

4735
### Windsurf
4836

4937
1. Go to Settings > Windsurf Settings > Cascade > Manage Plugins > View raw config.
50-
2. Add the following to your MCP configuration file and save.
51-
```
38+
2. Add the contents from the [Client Configuration](#client-configuration-cursorwindsurfclaude-desktop) section to your MCP configuration file and save.
39+
3. Click Refresh on the Manage Plugins page.
40+
4. See the MCP server in the list.
41+
42+
### Claude Desktop
43+
44+
1. Go to Settings > Developer > Edit Config.
45+
2. Add the contents from the [Client Configuration](#client-configuration-cursorwindsurfclaude-desktop) section to your MCP configuration file and save.
46+
3. Restart Claude Desktop.
47+
4. Click the "Search and tools" button and see the MCP server in the list.
48+
49+
### Client Configuration (Cursor/Windsurf/Claude Desktop)
50+
51+
```json
5252
{
5353
"mcpServers": {
5454
"openzeppelin-contracts-wizard": {
5555
"command": "npx",
5656
"args": [
57+
"-y",
5758
"@openzeppelin/wizard-mcp"
5859
]
5960
}
6061
}
6162
}
6263
```
63-
3. Click Refresh on the Manage Plugins page.
64-
4. See the MCP server in the list.
64+
65+
### Claude Code
66+
67+
```sh
68+
claude mcp add openzeppelin-contracts-wizard -- npx -y @openzeppelin/wizard-mcp
69+
```
6570

6671
### VS Code
6772

6873
For quick installation, use one of the buttons below.
6974

70-
[![Add to 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=openzeppelin-contracts-wizard&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22%40openzeppelin%2Fwizard-mcp%22%5D%7D) [![Add to 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=openzeppelin-contracts-wizard&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22%40openzeppelin%2Fwizard-mcp%22%5D%7D&quality=insiders)
75+
[![Add to VS Code](https://img.shields.io/badge/VS_Code-NPM-0098FF?style=flat-square)](https://insiders.vscode.dev/redirect/mcp/install?name=openzeppelin-contracts-wizard&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%20%22%40openzeppelin%2Fwizard-mcp%22%5D%7D)
76+
[![Add to VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-NPM-24bfa5?style=flat-square)](https://insiders.vscode.dev/redirect/mcp/install?name=openzeppelin-contracts-wizard&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%20%22%40openzeppelin%2Fwizard-mcp%22%5D%7D&quality=insiders)
7177

7278
For manual installation:
7379
1. Follow VS Code documentation to [Add an MCP server to your workspace](https://code.visualstudio.com/docs/copilot/chat/mcp-servers#_add-an-mcp-server-to-your-workspace) using the following configuration:
74-
```
80+
```json
7581
{
7682
"servers": {
7783
"openzeppelin-contracts-wizard": {
7884
"type": "stdio",
7985
"command": "npx",
8086
"args": [
87+
"-y",
8188
"@openzeppelin/wizard-mcp"
8289
]
8390
}
@@ -88,4 +95,4 @@ For manual installation:
8895

8996
## Usage
9097

91-
In your IDE's Write or Agent mode, ask the AI agent to write or modify smart contracts for your use case. When the AI agent determines it is appropriate to do so, it will use the MCP server to generate the contracts or determine best practices for your use case.
98+
When interacting with an AI agent, for example in your IDE's Write or Agent mode, ask it to write or modify smart contracts for your use case. When the AI agent determines it is appropriate to do so, it will use the MCP server to generate the contracts or determine best practices for your use case.

0 commit comments

Comments
 (0)