Neo N3

You can run the Neo N3 MCP Server to enable programmatic access to the Neo N3 blockchain, including wallet management, asset transfers, contract interactions, and blockchain queries. This server exposes a rich set of tools that you can call from your MCP client, enabling seamless integration with your applications and automated workflows.

How to use

To use the Neo N3 MCP Server from an MCP client, you typically run the MCP server command line or deploy it via Docker, then connect your client through an MCP transport (stdio in this example). You can start the server in testnet mode for development or switch to mainnet for production. Your client sends requests for wallet creation, asset transfers, contract invocations, and general blockchain data, and the MCP server handles those requests, returning results or status information.

How to install

Prerequisites: you need Node.js and npm (or a compatible runtime for running npm scripts). The Neo N3 MCP Server ships as an npm package and can be run directly or installed globally.

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

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

Additional setup and run options

Basic usage runs the MCP server with its default configuration. You can override settings via command line options or a configuration JSON file. The server supports configuring the network (testnet or mainnet), RPC endpoints for mainnet and testnet, and logging behavior. You can also run the server via Docker or with Docker Compose for production readiness.

Example start via CLI with default configuration: neo-n3-mcp or npx @r3e/neo-n3-mcp.

Configuration from JSON or CLI

You can configure the server using a JSON file or command line options. The configuration covers network selection, RPC endpoints, and logging preferences.

JSON configuration example highlights network, RPC endpoints, logging, and wallet directory. You can tailor the file to suit development or production needs.

Available tools

get_network_mode

Retrieve the current network mode (mainnet or testnet) from the MCP server

set_network_mode

Switch the network mode for subsequent operations

get_blockchain_info

Query overall blockchain information such as chain height, protocol version, and network status

get_block_count

Return the current number of blocks in the active chain

get_block

Fetch a specific block by its index or hash

get_transaction

Retrieve details of a specific transaction by its ID

create_wallet

Create a new wallet and securely store it in the configured wallet directory

import_wallet

Import an existing wallet into the MCP server for management

get_balance

Check the balance of a wallet or address for a given asset

transfer_assets

Initiate transfer of assets between addresses or wallets

estimate_transfer_fees

Estimate fees for a proposed asset transfer

invoke_contract

Invoke a smart contract function or script on the Neo N3 blockchain

list_famous_contracts

List commonly used or famous contract addresses for quick access

get_contract_info

Retrieve details about a specific contract

claim_gas

Claim GAS or gas rewards associated with an account

estimate_invoke_fees

Estimate fees for contract invocations or complex operations

neo_network_status

Check the current status of the Neo network connections

neo_mainnet_status

Query mainnet status information

neo_testnet_status

Query testnet status information

neo_blockchain

Access blockchain data for analysis and monitoring

neo_assets

Query asset information for mainnet and testnet

neo_mint

Mint or issue assets on the Neo N3 network (when supported)

neo_contract_registry

Access registry of deployed contracts across networks

neo_account_info

Retrieve account-specific information and balances

transfer_fees

Compute fees for asset transfers and smart contract invocations

list_resources

List available resources such as network status and blockchain data endpoints

get_resource

Fetch details for a specific resource endpoint