Skip to content

Commit e286b80

Browse files
committed
Update mcp readme
1 parent 8bb3519 commit e286b80

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

packages/mcp/README.md

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

3-
A Model Context Protocol (MCP) server that allows AI agents to generate smart contracts using the OpenZeppelin Contracts Wizard.
3+
A Model Context Protocol (MCP) server that allows AI agents to generate smart contracts using the [OpenZeppelin Contracts Wizard](https://wizard.openzeppelin.com/).
44

55
> [!WARNING]
66
> 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.
77
88
## Features
99

10-
### Solidity
10+
Provides tools to generate smart contracts for the following languages and contract kinds. Tools are named in the format `<language>-<contract>`.
11+
12+
| Language | Contracts |
13+
| --- | --- |
14+
| solidity | erc20, erc721, erc1155, stablecoin, rwa, account, governor, custom |
15+
| cairo | erc20, erc721, erc1155, account, multisig, governor, vesting, custom |
16+
| stellar | fungible, non-fungible |
17+
| stylus | erc20, erc721, erc1155 |
1118

12-
Provides the following tools:
13-
- `solidity-erc20`: Generate an ERC20 smart contract for Solidity
14-
- `solidity-erc721`: Generate an ERC721 smart contract for Solidity
15-
- `solidity-erc1155`: Generate an ERC1155 smart contract for Solidity
16-
- `solidity-stablecoin`: (Experimental) Generate a stablecoin smart contract for Solidity
17-
- `solidity-account`: (Experimental) Generate an account smart contract for Solidity
18-
- `solidity-custom`: Generate a custom smart contract for Solidity
19-
- `solidity-governor`: Generate a governor smart contract for Solidity
20-
- `solidity-rwa`: (Experimental) Generate a real-world asset smart contract for Solidity
2119

2220
## Installation
2321

@@ -27,7 +25,7 @@ Add the following to your MCP configuration file:
2725
```
2826
{
2927
"mcpServers": {
30-
"OpenZeppelin Contracts Wizard": {
28+
"openzeppelin-contracts-wizard": {
3129
"command": "npx",
3230
"args": [
3331
"@openzeppelin/wizard-mcp"
@@ -42,13 +40,13 @@ Add the following to your MCP configuration file:
4240
1. Go to Settings > Windsurf Settings > Cascade > Manage Plugins > View raw config.
4341
2. Add the above [MCP Configuration](#mcp-configuration) to the config file and save.
4442
3. Click Refresh on the Manage Plugins page.
45-
4. See the MCP Server in the list.
43+
4. See the MCP server in the list.
4644

4745
### Cursor
4846

49-
1. Go to Settings > Cursor Settings > MCP > Add new global MCP server.
47+
1. Go to Settings > Cursor Settings > MCP Tools > New MCP Server.
5048
2. Add the above [MCP Configuration](#mcp-configuration) to the config file and save.
51-
3. See the MCP Server in the list.
49+
3. See the MCP server in the list.
5250

5351
## Usage
5452

0 commit comments

Comments
 (0)