Skip to content

Commit ff5198a

Browse files
authored
Rename MCP server package (#607)
1 parent c9102d0 commit ff5198a

File tree

4 files changed

+31
-21
lines changed

4 files changed

+31
-21
lines changed

.changeset/four-books-relax.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@openzeppelin/contracts-mcp': patch
3+
---
4+
5+
**Breaking changes**: Renamed package from `@openzeppelin/wizard-mcp` to `@openzeppelin/contracts-mcp`

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,23 @@
44
[![Cairo NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-cairo?color=%23e55233&label=%40openzeppelin%2Fwizard-cairo)](https://www.npmjs.com/package/@openzeppelin/wizard-cairo)
55
[![Stellar NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-stellar?color=%23e55233&label=%40openzeppelin%2Fwizard-stellar)](https://www.npmjs.com/package/@openzeppelin/wizard-stellar)
66
[![Stylus NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-stylus?color=%23e55233&label=%40openzeppelin%2Fwizard-stylus)](https://www.npmjs.com/package/@openzeppelin/wizard-stylus)
7-
[![MCP NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-mcp?label=%40openzeppelin%2Fwizard-mcp)](https://www.npmjs.com/package/@openzeppelin/wizard-mcp)
7+
[![Contracts MCP NPM Package](https://img.shields.io/npm/v/@openzeppelin/contracts-mcp?label=%40openzeppelin%2Fcontracts-mcp)](https://www.npmjs.com/package/@openzeppelin/contracts-mcp)
88
[![Netlify Status](https://api.netlify.com/api/v1/badges/ca9b53e1-44eb-410d-aac7-31b2f5399b68/deploy-status)](https://app.netlify.com/sites/openzeppelin-contracts-wizard/deploys)
99

1010
Contracts Wizard is a web application to interactively build a contract out of components from OpenZeppelin Contracts. Select the kind of contract that you want, set your parameters and desired features, and the Wizard will generate all of the code necessary. The resulting code is ready to be compiled and deployed, or it can serve as a starting point and customized further with application specific logic.
1111

12-
[![](./screenshot.png)](https://wizard.openzeppelin.com/)
12+
[![](./screenshot.png)](https://wizard.openzeppelin.com)
1313

1414
## Usage
1515

16-
Use the Contracts Wizard at https://wizard.openzeppelin.com/
16+
Use the Contracts Wizard at https://wizard.openzeppelin.com
1717

18-
## MCP Server
18+
## MCP Servers
1919

20-
The [MCP server](packages/mcp/README.md) allows AI agents to generate smart contracts using the Contracts Wizard.
20+
MCP Servers allow AI agents to generate smart contracts with the same options as the Contracts Wizard.
21+
22+
For local installation, see the [Contracts MCP Server](packages/mcp/README.md) package.
23+
For a hosted version, see [OpenZeppelin MCP Servers](https://mcp.openzeppelin.com).
2124

2225
## TypeScript API
2326

packages/mcp/README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# OpenZeppelin Contracts Wizard MCP Server
1+
# OpenZeppelin Contracts MCP Server
22

3-
[![NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-mcp)](https://www.npmjs.com/package/@openzeppelin/wizard-mcp)
3+
[![NPM Package](https://img.shields.io/npm/v/@openzeppelin/contracts-mcp)](https://www.npmjs.com/package/@openzeppelin/contracts-mcp)
44

5-
A Model Context Protocol (MCP) server that allows AI agents to generate smart contracts using the [OpenZeppelin Contracts Wizard](https://wizard.openzeppelin.com/).
5+
A Model Context Protocol (MCP) server that allows AI agents to generate smart contracts using OpenZeppelin Contracts libraries.
6+
7+
This server runs locally and requires Node.js to be installed. For a hosted version, see [OpenZeppelin MCP Servers](https://mcp.openzeppelin.com/).
68

79
> [!WARNING]
810
> AI agents determine when and how to use the MCP server and therefore may produce inaccurate results. You should always review any information produced by the AI agent to ensure that any results are accurate and suit your purposes.
@@ -25,7 +27,7 @@ Provides tools to generate smart contract source code for the following language
2527

2628
For quick installation, use the button below.
2729

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

3032
For manual installation:
3133
1. Go to Settings > Cursor Settings > Tools & Integrations > MCP Tools > New MCP Server.
@@ -34,9 +36,9 @@ For manual installation:
3436

3537
### Windsurf
3638

37-
1. Go to Settings > Windsurf Settings > Cascade > Manage Plugins > View raw config.
39+
1. Go to Settings > Windsurf Settings > Cascade > Manage MCPs > View raw config.
3840
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.
41+
3. Click Refresh on the Manage MCP Servers page.
4042
4. See the MCP server in the list.
4143

4244
### Claude Desktop
@@ -51,11 +53,11 @@ For manual installation:
5153
```json
5254
{
5355
"mcpServers": {
54-
"openzeppelin-contracts-wizard": {
56+
"OpenZeppelinContracts": {
5557
"command": "npx",
5658
"args": [
5759
"-y",
58-
"@openzeppelin/wizard-mcp"
60+
"@openzeppelin/contracts-mcp"
5961
]
6062
}
6163
}
@@ -65,27 +67,27 @@ For manual installation:
6567
### Claude Code
6668

6769
```sh
68-
claude mcp add openzeppelin-contracts-wizard -- npx -y @openzeppelin/wizard-mcp
70+
claude mcp add OpenZeppelinContracts -- npx -y @openzeppelin/contracts-mcp
6971
```
7072

7173
### VS Code
7274

7375
For quick installation, use one of the buttons below.
7476

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)
77+
[![Add to VS Code](https://img.shields.io/badge/VS_Code-NPM-0098FF?style=flat-square)](https://insiders.vscode.dev/redirect/mcp/install?name=OpenZeppelinContracts&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%20%22%40openzeppelin%2Fcontracts-mcp%22%5D%7D)
78+
[![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=OpenZeppelinContracts&config=%7B%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%20%22%40openzeppelin%2Fcontracts-mcp%22%5D%7D&quality=insiders)
7779

7880
For manual installation:
7981
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:
8082
```json
8183
{
8284
"servers": {
83-
"openzeppelin-contracts-wizard": {
85+
"OpenZeppelinContracts": {
8486
"type": "stdio",
8587
"command": "npx",
8688
"args": [
8789
"-y",
88-
"@openzeppelin/wizard-mcp"
90+
"@openzeppelin/contracts-mcp"
8991
]
9092
}
9193
}

packages/mcp/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
2-
"name": "@openzeppelin/wizard-mcp",
2+
"name": "@openzeppelin/contracts-mcp",
33
"version": "0.0.4",
4-
"description": "MCP Server for OpenZeppelin Contracts Wizard",
4+
"description": "OpenZeppelin Contracts MCP Server",
55
"license": "AGPL-3.0-only",
66
"repository": "https://github.com/OpenZeppelin/contracts-wizard",
77
"main": "dist/index.js",
88
"bin": {
9-
"wizard-mcp": "dist/index.js"
9+
"contracts-mcp": "dist/index.js"
1010
},
1111
"ts:main": "src/index.ts",
1212
"files": [

0 commit comments

Comments
 (0)