@openzeppelin/contracts-mcp
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

OpenZeppelin Contracts MCP Server

NPM Package

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.

[!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.

Features

Provides tools to generate smart contract source code for the following languages and contract kinds. Resulting contracts use OpenZeppelin Contracts libraries for each language. Tools are named in the format <language>-<contract>.

Language Contracts
solidity erc20, erc721, erc1155, stablecoin, rwa, account, governor, custom
cairo erc20, erc721, erc1155, account, multisig, governor, vesting, custom
stellar fungible, stablecoin, non-fungible
stylus erc20, erc721, erc1155

Installation

Cursor

For quick installation, use the button below.

Add to Cursor

For manual installation:

  1. Go to Settings > Cursor Settings > Tools & Integrations > MCP Tools > New MCP Server.
  2. Add the contents from the Client Configuration section to your MCP configuration file and save.
  3. See the MCP server in the list.

Windsurf

  1. Go to Settings > Windsurf Settings > Cascade > Manage MCPs > View raw config.
  2. Add the contents from the Client Configuration section to your MCP configuration file and save.
  3. Click Refresh on the Manage MCP Servers page.
  4. See the MCP server in the list.

Claude Desktop

  1. Go to Settings > Developer > Edit Config.
  2. Add the contents from the Client Configuration section to your MCP configuration file and save.
  3. Restart Claude Desktop.
  4. Click the "Search and tools" button and see the MCP server in the list.

Client Configuration (Cursor/Windsurf/Claude Desktop)

{
  "mcpServers": {
    "OpenZeppelinContracts": {
      "command": "npx",
      "args": [
        "-y",
        "@openzeppelin/contracts-mcp"
      ]
    }
  }
}

Claude Code

claude mcp add OpenZeppelinContracts -- npx -y @openzeppelin/contracts-mcp

VS Code

For quick installation, use one of the buttons below.

Add to VS Code Add to VS Code Insiders

For manual installation:

  1. Follow VS Code documentation to Add an MCP server to your workspace using the following configuration:
{
  "servers": {
    "OpenZeppelinContracts": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "@openzeppelin/contracts-mcp"
      ]
    }
  }
}
  1. Start the MCP server according to Manage MCP servers.

Usage

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.

Readme

Keywords

none

Package Sidebar

Install

npm i @openzeppelin/contracts-mcp

Weekly Downloads

59

Version

0.1.0

License

AGPL-3.0-only

Unpacked Size

233 kB

Total Files

174

Last publish

Collaborators

  • frangio
  • namis
  • zeljkox
  • dylkil
  • mcarlomagno
  • collins-oz
  • tirumerla
  • bjmrq
  • pasevin