Documentation > API Reference

API Reference

Complete documentation for all 27 tools and 4 resources

27 Tools Available
4 Resources
2 Networks

Quick Reference

6
Blockchain Tools
3
Wallet Tools
8
Asset Tools
10
Contract & Network 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)
confirm: boolean (required)
network?: string (optional)
Example
{
  "name": "claim_gas",
  "arguments": {
    "fromWIF": "KweTw...",
    "confirm": true
  }
}

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 contract using a known name, script hash, or Neo address.

Parameters:
contract?: string (optional)
contractName?: string (optional)
nameOrHash?: string (optional)
network?: string (optional)
Example
{
  "name": "get_contract_info",
  "arguments": {
    "contract": "NdzDrZQcdA4V3wRaL6h6JXS8s3i8dJzY5M",
    "network": "testnet"
  }
}

get_contract_status

Check whether a contract is deployed and inspect its resolved status on-chain.

Parameters:
contract?: string (optional)
contractName?: string (optional)
nameOrHash?: string (optional)
network?: string (optional)
Example
{
  "name": "get_contract_status",
  "arguments": {
    "contract": "NeoFS",
    "network": "mainnet"
  }
}

invoke_contract

Invoke a contract using a generic contract reference or a direct script hash. Generic contract references can be a known name, script hash, or Neo address.

Parameters:
contract?: string (optional)
scriptHash?: string (optional)
operation: string (required)
args?: array (optional)
fromWIF?: string (optional)
confirm?: boolean (optional for writes)
network?: string (optional)
Example
{
  "name": "invoke_contract",
  "arguments": {
    "contract": "NeoFS",
    "operation": "balanceOf",
    "args": ["NaMLm1hwCaQitxmLboJGo2XJkG8PSYvuyr"],
    "network": "testnet"
  }
}

estimate_invoke_fees

Estimate system and network fees for a contract invocation before sending it.

Parameters:
signerAddress: string (required)
contract?: string (optional)
scriptHash?: string (optional)
operation: string (required)
args?: array (optional)
network?: string (optional)
Example
{
  "name": "estimate_invoke_fees",
  "arguments": {
    "signerAddress": "NaMLm1hwCaQitxmLboJGo2XJkG8PSYvuyr",
    "contract": "NeoFS",
    "operation": "transfer",
    "args": [],
    "network": "testnet"
  }
}

deploy_contract

Deploy a new contract using a NEF script and manifest. Requires explicit confirmation.

Parameters:
fromWIF: string (required)
script: string (required)
manifest: object (required)
confirm: boolean (required)
network?: string (optional)
Example
{
  "name": "deploy_contract",
  "arguments": {
    "fromWIF": "KweTw...",
    "script": "base64-nef-script",
    "manifest": {"name": "ExampleContract"},
    "confirm": true,
    "network": "testnet"
  }
}

Network Tools

get_network_mode

Return the currently configured network mode and the enabled Neo networks.

Parameters:
none

set_network_mode

Set the server network mode to mainnet-only, testnet-only, or both. Restart may be required for resource listings to refresh.

Parameters:
mode: string (required)
Example
{
  "name": "set_network_mode",
  "arguments": {
    "mode": "both"
  }
}

Network Resources

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

neo://network/status

Live status for the default configured Neo network.

Resource URI
neo://network/status

neo://mainnet/status

Read-only status snapshot for Neo mainnet.

Resource URI
neo://mainnet/status

neo://testnet/status

Read-only status snapshot for Neo testnet.

Resource URI
neo://testnet/status

neo://block/{height}

Parameterized block resource for fetching a block by height on the default configured network.

Resource URI
neo://block/123456

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.