Getting Started - Neo N3 MCP Server

1 Installation

Choose your preferred installation method to get started with Neo N3 MCP Server.

Install via NPM

The easiest way to get started. Requires Node.js 18+ and npm.

bash

# Install globally
npm install -g @r3e/neo-n3-mcp

# Or install locally in your project
npm install @r3e/neo-n3-mcp

💡 Prerequisites

Make sure you have Node.js 18+ and npm installed on your system.

Install via Docker

Use Docker for a containerized deployment with all dependencies included.

bash

# Pull the latest image
docker pull r3e/neo-n3-mcp:latest

# Run the server
docker run -p 8080:8080 r3e/neo-n3-mcp:latest

🐳 Docker Benefits

Docker provides isolated environment, easy scaling, and consistent deployments across different systems.

Claude Desktop Integration

Add Neo N3 MCP directly to Claude Desktop for seamless blockchain integration.

json

{
  "mcpServers": {
    "neo-n3-mcp": {
      "command": "npx",
      "args": ["@r3e/neo-n3-mcp"],
      "env": {
        "NEO_NETWORK": "mainnet"
      }
    }
  }
}

🤖 Claude Integration

Add this configuration to your Claude Desktop config file to enable blockchain capabilities in your AI assistant.

2 Configuration

Configure Neo N3 MCP Server for your specific needs and network preferences.

Environment Variables

bash

# Network configuration
export NEO_NETWORK=mainnet          # or 'testnet'
export NEO_RPC_URL=https://rpc.neo.org

# Optional: Custom endpoints
export NEO_TESTNET_RPC=https://testnet-rpc.neo.org
export NEO_TIMEOUT=30000

Configuration File

Create a neo-mcp.config.json file for advanced configuration:

json

{
  "network": "mainnet",
  "rpcEndpoints": {
    "mainnet": "https://rpc.neo.org",
    "testnet": "https://testnet-rpc.neo.org"
  },
  "timeout": 30000,
  "retries": 3,
  "security": {
    "enableEncryption": true,
    "keyDerivationRounds": 10000
  }
}

⚠️ Security Notice

Never commit private keys or sensitive configuration to version control. Use environment variables for sensitive data.

3 First Steps

Let's verify your installation and make your first blockchain queries.

Verify Installation

javascript

const neo = require('@r3e/neo-n3-mcp');

// Test basic connectivity
async function testConnection() {
  try {
    const info = await neo.callTool('get_blockchain_info');
    console.log('Connected! Block height:', info.blockcount);
    console.log('Network:', info.network);
  } catch (error) {
    console.error('Connection failed:', error.message);
  }
}

testConnection();

Your First Queries

Check Network Status

Get current blockchain information and network health.

Query Block Data

Fetch information about specific blocks and transactions.

Asset Information

Look up NEP-17 token information and balances.

✅ Ready to Go!

If these examples work, your Neo N3 MCP Server is correctly installed and configured.

4 Real-World Examples

Explore practical examples that demonstrate the power of Neo N3 MCP Server.

Wallet Creation

Create and manage Neo N3 wallets with enterprise security.

View Example

Smart Contract Calls

Invoke smart contracts and handle complex parameters.

View Example

DeFi Integration

Connect with Flamingo DEX and other DeFi protocols.

View Example

5 Next Steps

You're ready to build amazing blockchain applications! Here's what to explore next:

📖 API Reference

Comprehensive documentation for all 34 tools and 9 resources.

Browse API

🏗️ Architecture Guide

Learn about system design and best practices.

Read Guide

🚀 Deployment

Deploy to production with Docker and monitoring.

Deploy Now

🎉 Congratulations!

You've successfully set up Neo N3 MCP Server. Start building the future of blockchain development!

View Examples →