Documentation > API Reference

API Reference

Complete documentation for all 34 tools and 9 resources

34 Tools Available
9 Resources
2 Networks

Quick Reference

5
Blockchain Tools
8
Wallet Tools
12
Asset Tools
9
Contract Tools

Request Format

All requests should be made as HTTP POST to the MCP endpoint with JSON payload:

Example Request
{
  "name": "tool_name",
  "arguments": {
    "param1": "value1",
    "param2": "value2"
  }
}

Response Format

All successful responses follow this format:

Success Response
{
  "result": {
    // Tool-specific result data
  }
}
Error Response
{
  "error": {
    "message": "Error description",
    "code": "ERROR_CODE"
  }
}

Blockchain Operations

get_blockchain_info

Get general information about the Neo N3 blockchain including height, validators, and network status.

Parameters:
network?: string (optional)
Example
{
  "name": "get_blockchain_info",
  "arguments": {
    "network": "mainnet"
  }
}

get_block_count

Get the current block height of the Neo N3 blockchain.

Parameters:
network?: string (optional)
Example
{
  "name": "get_block_count",
  "arguments": {}
}

get_block

Get detailed information about a specific block by height or hash.

Parameters:
hashOrHeight: string|number (required)
network?: string (optional)
Example
{
  "name": "get_block",
  "arguments": {
    "hashOrHeight": "latest"
  }
}

get_transaction

Get detailed information about a specific transaction by hash.

Parameters:
txid: string (required)
network?: string (optional)
Example
{
  "name": "get_transaction",
  "arguments": {
    "txid": "0x1234567890abcdef..."
  }
}

get_mempool

Get current memory pool information including pending transactions.

Parameters:
network?: string (optional)
Example
{
  "name": "get_mempool",
  "arguments": {}
}

Wallet Management

create_wallet

Create a new Neo N3 wallet with encrypted private key storage.

Parameters:
password: string (required)
network?: string (optional)
Example
{
  "name": "create_wallet",
  "arguments": {
    "password": "secure-password-123"
  }
}

import_wallet

Import an existing wallet using private key, WIF, or encrypted key.

Parameters:
key: string (required)
password?: string (optional)
network?: string (optional)
Example
{
  "name": "import_wallet",
  "arguments": {
    "key": "KweTw...",
    "password": "password123"
  }
}

get_balance

Get the balance of NEP-17 tokens for a specific address.

Parameters:
address: string (required)
asset?: string (optional)
network?: string (optional)
Example
{
  "name": "get_balance",
  "arguments": {
    "address": "NZNos2WqTbu5oCgyfss9kUJgBXJqhuYAaj"
  }
}

Asset Operations

transfer_assets

Transfer NEP-17 tokens between addresses with confirmation tracking.

Parameters:
fromWIF: string (required)
toAddress: string (required)
asset: string (required)
amount: string (required)
confirm: boolean (required)
network?: string (optional)
Example
{
  "name": "transfer_assets",
  "arguments": {
    "fromWIF": "KweTw...",
    "toAddress": "NZNos2...",
    "asset": "GAS",
    "amount": "10.5",
    "confirm": true
  }
}

estimate_transfer_fees

Estimate network and system fees for asset transfers.

Parameters:
fromAddress: string (required)
toAddress: string (required)
asset: string (required)
amount: string (required)
network?: string (optional)
Example
{
  "name": "estimate_transfer_fees",
  "arguments": {
    "fromAddress": "NZNos2...",
    "toAddress": "NZNos2...",
    "asset": "NEO",
    "amount": "1"
  }
}

claim_gas

Claim unclaimed GAS from NEO holdings.

Parameters:
fromWIF: string (required)
network?: string (optional)
Example
{
  "name": "claim_gas",
  "arguments": {
    "fromWIF": "KweTw..."
  }
}

Contract Interactions

list_famous_contracts

List all supported famous contracts and their availability.

Parameters:
network?: string (optional)
Example
{
  "name": "list_famous_contracts",
  "arguments": {}
}

get_contract_info

Get detailed information about a specific famous contract.

Parameters:
contractName: string (required)
network?: string (optional)
Example
{
  "name": "get_contract_info",
  "arguments": {
    "contractName": "NeoFS"
  }
}

invoke_read_contract

Invoke read-only contract methods without state changes.

Parameters:
contractName: string (required)
operation: string (required)
args?: array (optional)
network?: string (optional)
Example
{
  "name": "invoke_read_contract",
  "arguments": {
    "contractName": "NeoFS",
    "operation": "getContainers",
    "args": ["owner-id"]
  }
}

invoke_write_contract

Invoke contract methods that modify blockchain state.

Parameters:
fromWIF: string (required)
contractName: string (required)
operation: string (required)
args?: array (optional)
confirm: boolean (required)
network?: string (optional)
Example
{
  "name": "invoke_write_contract",
  "arguments": {
    "fromWIF": "KweTw...",
    "contractName": "NeoFS",
    "operation": "createContainer",
    "args": ["owner-id", []],
    "confirm": true
  }
}

Network Resources

Resources provide read-only access to blockchain data through URI-based endpoints.

network_status

Live network status including block height, node count, and network health metrics.

Resource URI
mcp://neo-n3/network/status

validators

Current list of consensus validators and their voting information.

Resource URI
mcp://neo-n3/network/validators

gas_price

Current network gas price and fee estimation data.

Resource URI
mcp://neo-n3/network/gas-price

Error Codes

-32600

Invalid Request - The JSON sent is not a valid Request object.

-32601

Method not found - The method does not exist or is not available.

-32602

Invalid params - Invalid method parameter(s).

-32603

Internal error - Internal server error.