diff --git a/.changeset/four-books-relax.md b/.changeset/four-books-relax.md new file mode 100644 index 000000000..251cbb312 --- /dev/null +++ b/.changeset/four-books-relax.md @@ -0,0 +1,5 @@ +--- +'@openzeppelin/contracts-mcp': patch +--- + +**Breaking changes**: Renamed package from `@openzeppelin/wizard-mcp` to `@openzeppelin/contracts-mcp` diff --git a/README.md b/README.md index 947478b8b..7dcf4607e 100644 --- a/README.md +++ b/README.md @@ -4,20 +4,23 @@ [![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) [![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) [![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) -[![MCP NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-mcp?label=%40openzeppelin%2Fwizard-mcp)](https://www.npmjs.com/package/@openzeppelin/wizard-mcp) +[![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) [![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) 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. -[![](./screenshot.png)](https://wizard.openzeppelin.com/) +[![](./screenshot.png)](https://wizard.openzeppelin.com) ## Usage -Use the Contracts Wizard at https://wizard.openzeppelin.com/ +Use the Contracts Wizard at https://wizard.openzeppelin.com -## MCP Server +## MCP Servers -The [MCP server](packages/mcp/README.md) allows AI agents to generate smart contracts using the Contracts Wizard. +MCP Servers allow AI agents to generate smart contracts with the same options as the Contracts Wizard. + +For local installation, see the [Contracts MCP Server](packages/mcp/README.md) package. +For a hosted version, see [OpenZeppelin MCP Servers](https://mcp.openzeppelin.com). ## TypeScript API diff --git a/packages/mcp/README.md b/packages/mcp/README.md index 5466dc156..22208437e 100644 --- a/packages/mcp/README.md +++ b/packages/mcp/README.md @@ -1,8 +1,10 @@ -# OpenZeppelin Contracts Wizard MCP Server +# OpenZeppelin Contracts MCP Server -[![NPM Package](https://img.shields.io/npm/v/@openzeppelin/wizard-mcp)](https://www.npmjs.com/package/@openzeppelin/wizard-mcp) +[![NPM Package](https://img.shields.io/npm/v/@openzeppelin/contracts-mcp)](https://www.npmjs.com/package/@openzeppelin/contracts-mcp) -A Model Context Protocol (MCP) server that allows AI agents to generate smart contracts using the [OpenZeppelin Contracts Wizard](https://wizard.openzeppelin.com/). +A Model Context Protocol (MCP) server that allows AI agents to generate smart contracts using OpenZeppelin Contracts libraries. + +This server runs locally and requires Node.js to be installed. For a hosted version, see [OpenZeppelin MCP Servers](https://mcp.openzeppelin.com/). > [!WARNING] > 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 For quick installation, use the button below. -[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=openzeppelin-contracts-wizard&config=eyJjb21tYW5kIjoibnB4IC15IEBvcGVuemVwcGVsaW4vd2l6YXJkLW1jcCJ9) +[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/install-mcp?name=OpenZeppelinContracts&config=ewogICJjb21tYW5kIjogIm5weCIsCiAgImFyZ3MiOiBbCiAgICAiLXkiLAogICAgIkBvcGVuemVwcGVsaW4vY29udHJhY3RzLW1jcCIKICBdCn0=) For manual installation: 1. Go to Settings > Cursor Settings > Tools & Integrations > MCP Tools > New MCP Server. @@ -34,9 +36,9 @@ For manual installation: ### Windsurf -1. Go to Settings > Windsurf Settings > Cascade > Manage Plugins > View raw config. +1. Go to Settings > Windsurf Settings > Cascade > Manage MCPs > View raw config. 2. Add the contents from the [Client Configuration](#client-configuration-cursorwindsurfclaude-desktop) section to your MCP configuration file and save. -3. Click Refresh on the Manage Plugins page. +3. Click Refresh on the Manage MCP Servers page. 4. See the MCP server in the list. ### Claude Desktop @@ -51,11 +53,11 @@ For manual installation: ```json { "mcpServers": { - "openzeppelin-contracts-wizard": { + "OpenZeppelinContracts": { "command": "npx", "args": [ "-y", - "@openzeppelin/wizard-mcp" + "@openzeppelin/contracts-mcp" ] } } @@ -65,27 +67,27 @@ For manual installation: ### Claude Code ```sh -claude mcp add openzeppelin-contracts-wizard -- npx -y @openzeppelin/wizard-mcp +claude mcp add OpenZeppelinContracts -- npx -y @openzeppelin/contracts-mcp ``` ### VS Code For quick installation, use one of the buttons below. -[![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) -[![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) +[![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) +[![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) For manual installation: 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: ```json { "servers": { - "openzeppelin-contracts-wizard": { + "OpenZeppelinContracts": { "type": "stdio", "command": "npx", "args": [ "-y", - "@openzeppelin/wizard-mcp" + "@openzeppelin/contracts-mcp" ] } } diff --git a/packages/mcp/package.json b/packages/mcp/package.json index f50caba47..229bd0510 100644 --- a/packages/mcp/package.json +++ b/packages/mcp/package.json @@ -1,12 +1,12 @@ { - "name": "@openzeppelin/wizard-mcp", + "name": "@openzeppelin/contracts-mcp", "version": "0.0.4", - "description": "MCP Server for OpenZeppelin Contracts Wizard", + "description": "OpenZeppelin Contracts MCP Server", "license": "AGPL-3.0-only", "repository": "https://github.com/OpenZeppelin/contracts-wizard", "main": "dist/index.js", "bin": { - "wizard-mcp": "dist/index.js" + "contracts-mcp": "dist/index.js" }, "ts:main": "src/index.ts", "files": [