Neo N3 MCP

🚀 Neo N3 MCP Server and HTTP Server Documentation

Neo N3 MCP Server is a protocol implementation based on the Model Context Protocol (MCP), providing powerful functional support for blockchain applications. Meanwhile, this software package also offers an HTTP server, exposing Neo N3 functionality through RESTful API interfaces.

✨ Features

• MCP Protocol Support: Adheres to the Model Context Protocol standard, enabling cross - chain data exchange and smart contract interaction.
• HTTP REST API: Provides a series of RESTful API interfaces, facilitating developers to integrate blockchain functionality into their applications.
• Wallet Management: Supports the creation, import, and management of wallet files in multiple formats.
• Smart Contract Operations: Includes functions for deploying, invoking, and querying smart contracts.
• Network Mode Switching: Supports seamless switching between the mainnet and the testnet.

🔧 Technical Details - MCP Protocol

Function Overview

The MCP protocol allows applications to achieve real - time data acquisition by subscribing to specific blockchain events. Its main features include:

• Event Subscription: Developers can publish the event types they are interested in and receive relevant on - chain data in real - time.
• Status Change Notification: When the status of an address or a contract on the blockchain changes, the system automatically pushes notifications to the subscribers.
• Asynchronous Processing: All event processing is performed asynchronously, ensuring stable performance in high - concurrency scenarios.

MCP Server

Initialization and Configuration

// Create an MCP instance and set the configuration
const mcp = new MCP({
    network: 'test', // Network environment: main or test
    contextPath: '/context' // Context path, default is /context
});

// Start the server
await mcp.start();

Event Handling Example

// Subscribe to the balance change event of an address
mcp.subscribe('address - balance - changed', (event) => {
    console.log(`Address ${event.address}'s balance has changed, and the current balance is ${event.balance}`);
});

// Handle smart contract invocation events
mcp.on('contract - invoked', async (event) => {
    try {
        const result = await event.execute();
        console.log(`Contract ${event.contract} was invoked successfully, and the return result is: ${result}`);
    } catch (error) {
        console.error(`Contract ${event.contract} invocation failed, error message: ${error.message}`);
    }
});

🔧 Technical Details - HTTP Server

Function Overview

The HTTP server provides the following functions through RESTful APIs:

• Blockchain Information Query: Retrieve basic on - chain information, block details, and transaction records.
• Wallet Management: Create new wallets, import existing wallets, and view wallet information.
• Smart Contract Operations: Deploy new contracts, invoke deployed contracts, and query contract status.
• Network Mode Switching: Switch between the mainnet and the testnet.

HTTP Endpoints

💻 Usage Examples

# Get blockchain information
curl http://localhost:3000/api/context/current

# Deploy a smart contract
curl -X POST http://localhost:3000/api/contracts \
  -H "Content-Type: application/json" \
  -d '{"contractName": "MyContract", "code":"..."}'

# Invoke a smart contract
curl -X POST http://localhost:3000/api/contracts/MyContract/call \
  -H "Content-Type: application/json" \
  -d '{"method":"balanceOf","params":["userAddress"]}'

🚀 Quick Start

📦 Installation

npm install neo - mcp - server http - restify

Initialization

Create a server.js file:

const MCP = require('neo - mcp - server');
const restify = require('http - restify');

// Initialize the MCP server
const mcpServer = new MCP.Server({
    network: 'test',
    contextPath: '/context'
});

// Initialize the HTTP server
const httpServer = restify.createServer();

// Mount MCP - related routes
mcpServer.applyRoutes(httpServer);

// Start the server
httpServer.listen(3000, () => {
    console.log('Server has been started, listening at: http://localhost:3000');
});

Run the Application

node server.js

📚 Documentation

• Log Monitoring: It is recommended to enable detailed log recording in the production environment for easy problem troubleshooting.
• Performance Tuning: Adjust server configuration parameters such as the number of connections and timeout settings according to actual needs.
• Version Upgrade: Regularly check for updates to dependent libraries to ensure system security and stability.

📄 License

No license information provided in the original document, so this section is skipped.

💡 Usage Tip

If you have any questions or suggestions, please contact our technical support team: support@neonetwork.org