Skip to content
MCP server

Symbol (XYM)

Read-only Symbol (XYM) blockchain tools for node health, harvesting and voting keys

Runs locallyStatus and history
Install
Pricing
Open source
Platforms
CLI, self-hosted
Runs
Locally
Version
0.10.2
Listing updated
1 day ago

About Symbol (XYM)

Symbol (XYM) is an open-source MCP server for finance and payments. It runs locally on your machine and is started by your AI client.

Twenty task-level tools turn the Symbol node REST API into questions people actually ask, rather than mirroring each endpoint. Account holders can look up balances with aliases and decimals applied, transaction history with decoded messages, mosaics and namespaces, fee estimates and height-to-time conversions. Node operators get node status with a healthy-or-not verdict and sync check, delegated-harvesting status and income by month, comparison against reference nodes and, above all, voting-key expiry with a recommended renewal window.

Every answer carries structured content validated against a published schema plus a short summary whose first line answers the question. Amounts come both with divisibility applied and as raw integers, and timestamps are UTC with an optional local time. The model cannot point the server at another host, because everything is configured by environment variables.

It needs Node.js 22 or later and an https Symbol REST node. It supports Symbol only, not NEM NIS1 (XEM), and is an unofficial, independent project. A Claude Desktop bundle is available as well as npm.

Install

Run in a terminal

claude mcp add symbol --env SYMBOL_NODE_URL='<SYMBOL_NODE_URL>' -- npx -y symbol-mcp-server

Add to claude_desktop_config.json

{
  "mcpServers": {
    "symbol": {
      "command": "npx",
      "args": [
        "-y",
        "symbol-mcp-server"
      ],
      "env": {
        "SYMBOL_NODE_URL": "<SYMBOL_NODE_URL>"
      }
    }
  }
}

Add to ~/.cursor/mcp.json

{
  "mcpServers": {
    "symbol": {
      "command": "npx",
      "args": [
        "-y",
        "symbol-mcp-server"
      ],
      "env": {
        "SYMBOL_NODE_URL": "<SYMBOL_NODE_URL>"
      }
    }
  }
}

Add to .vscode/mcp.json

{
  "servers": {
    "symbol": {
      "type": "stdio",
      "command": "npx",
      "args": [
        "-y",
        "symbol-mcp-server"
      ],
      "env": {
        "SYMBOL_NODE_URL": "<SYMBOL_NODE_URL>"
      }
    }
  }
}

Add to ~/.codeium/windsurf/mcp_config.json

{
  "mcpServers": {
    "symbol": {
      "command": "npx",
      "args": [
        "-y",
        "symbol-mcp-server"
      ],
      "env": {
        "SYMBOL_NODE_URL": "<SYMBOL_NODE_URL>"
      }
    }
  }
}

Add to your client's MCP settings (most use this shape)

{
  "mcpServers": {
    "symbol": {
      "command": "npx",
      "args": [
        "-y",
        "symbol-mcp-server"
      ],
      "env": {
        "SYMBOL_NODE_URL": "<SYMBOL_NODE_URL>"
      }
    }
  }
}

Configuration

  • SYMBOL_NODE_URLREST URL of the Symbol node to query, e.g. https://<node-host>:3001; https:// is required (http:// only for localhost / 127.0.0.1 / [::1]) and the port is used exactly as given.Required
  • SYMBOL_NETWORKmainnet or testnet; when set, start-up fails if the node reports a different network.
  • SYMBOL_TIMEZONEIANA zone such as Asia/Tokyo that adds a local time next to every UTC timestamp.
  • SYMBOL_REFERENCE_NODESComma-separated https:// node URLs that symbol_network_compare and symbol_version_drift check against; no other host is ever contacted.
  • SYMBOL_REQUEST_TIMEOUT_MSPer-request timeout in milliseconds, 100 to 600000 (default 10000).
  • SYMBOL_STATE_DIRAbsolute directory where symbol_harvesting_status keeps one snapshot file per node (unlocked harvester public keys, heights and times; no secrets) when it is asked to compare or save, created on first save with mode 0700; when unset, the tool reports the current list without a comparison.

Tools this server provides (5)

Taken from the project documentation; the running server may differ.

symbol_node_status
Node health verdict and sync state
symbol_harvesting_income
Harvesting receipts by period, optionally CSV
symbol_harvesting_status
Delegated harvesting status with optional snapshot comparison
symbol_network_compare
Compare a node against reference nodes
symbol_version_drift
Check node version against reference nodes

What it does

Node health
symbol_node_status folds seven checks into one verdict and reports sync state.
Voting-key expiry
Reports remaining epochs, blocks and days and a recommended renewal window.
Harvesting income
symbol_harvesting_income sums receipts by month and can output CSV.
Reference comparison
symbol_network_compare and symbol_version_drift check against nodes you list.
Account lookups
Balances, transactions, mosaics, namespaces, fees and address validation.
Structured answers
Each tool returns schema-validated JSON with a short summary first.

Good for

  • Check whether a Symbol node is in sync
  • Find out when a node's voting keys need renewing
  • Work out harvesting earnings per month
  • Compare a node's version with reference nodes

Pricing

Open source

Free; npm package and Claude Desktop bundle

Symbol (XYM) FAQ

Is it read-only?

Yes. The README describes it as a read-only server.

Does it support NEM (XEM)?

No. It supports Symbol nodes only, not NEM NIS1.

What do I need to run it?

Node.js 22 or newer and a Symbol REST node reachable over https, such as port 3001 on most public nodes.

Is it official?

No. The README says it is independent and unaffiliated with the NEM or Symbol core teams.

Is Symbol (XYM) free?

Yes. Symbol (XYM) is open source, so you can use and self-host it for free.

How do I add Symbol (XYM) to Claude Code?

Run this command in your terminal: claude mcp add symbol --env SYMBOL_NODE_URL='<SYMBOL_NODE_URL>' -- npx -y symbol-mcp-server

What are the best alternatives to Symbol (XYM)?

The closest alternatives to Symbol (XYM) are REA, Codebase Memory, GitHub, Serena MCP: the IDE for your agent and XERJ.

Alternatives to Symbol (XYM)

  1. REA

    MCP server

    CLI and MCP server that lets coding agents reverse engineer apps and binaries

    Runs locally
    • Open source
    • 464K GitHub stars
    • Developer tools
  2. Codebase Memory

    MCP server

    Local MCP server that builds a code knowledge graph for AI coding agents

    Runs locally
    • Open source
    • 48.7K GitHub stars
    • Knowledge and memory
  3. GitHub

    MCP server

    Official MCP server connecting AI assistants to GitHub repos, issues and workflows

    Not checked yet
    • Remote
    • Open source
    • 34.5K GitHub stars
    • Developer tools
  4. MCP toolkit giving coding agents symbol-level code retrieval and editing

    Runs locally
    • Open source
    • 31.5K GitHub stars
    • Developer tools
  5. XERJ

    MCP server

    Local search engine for AI agents with cited answers over your code and docs

    Runs locally
    • Open source
    • 19.2K GitHub stars
    • Knowledge and memory
  6. Ouroboros

    MCP server

    Spec-first layer that pins requirements and verifies results of AI coding agent work

    Runs locally
    • Open source
    • 6.4K GitHub stars
    • Developer tools