You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: packages/mcp/README.md
+29-22Lines changed: 29 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,59 +25,66 @@ Provides tools to generate smart contract source code for the following language
25
25
26
26
For quick installation, use the button below.
27
27
28
-
[](https://cursor.com/install-mcp?name=openzeppelin-contracts-wizard&config=eyJjb21tYW5kIjoibnB4IEBvcGVuemVwcGVsaW4vd2l6YXJkLW1jcCJ9)
28
+
[](https://cursor.com/install-mcp?name=openzeppelin-contracts-wizard&config=eyJjb21tYW5kIjoibnB4IC15IEBvcGVuemVwcGVsaW4vd2l6YXJkLW1jcCJ9)
29
29
30
30
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.
45
33
3. See the MCP server in the list.
46
34
47
35
### Windsurf
48
36
49
37
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.
claude mcp add openzeppelin-contracts-wizard -- npx -y @openzeppelin/wizard-mcp
69
+
```
65
70
66
71
### VS Code
67
72
68
73
For quick installation, use one of the buttons below.
69
74
70
-
[](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)[](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
+
[](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
+
[](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)
71
77
72
78
For manual installation:
73
79
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
75
81
{
76
82
"servers": {
77
83
"openzeppelin-contracts-wizard": {
78
84
"type": "stdio",
79
85
"command": "npx",
80
86
"args": [
87
+
"-y",
81
88
"@openzeppelin/wizard-mcp"
82
89
]
83
90
}
@@ -88,4 +95,4 @@ For manual installation:
88
95
89
96
## Usage
90
97
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