How do I install Symbol?

Copy the stdio config for Cursor, Claude Desktop, Claude Code, or VS Code on this page. It uses the publisher's install, not a PlugMCP proxy.

Does Symbol need an API key?

No required environment variable is listed on this record.

What transport does Symbol use?

Symbol runs locally over stdio.

When was Symbol last checked?

Last checked 2026-10-28. Read-only MCP server exposing the Symbol blockchain REST API as task-level tools

Symbol MCP 服务器

symbol-mcp-server

Symbol only. This server talks to Symbol (catapult) nodes. It does not support NEM NIS1 (XEM), which is a separate chain with a different API. Unofficial. This is an independent project with no affiliation to the NEM or Symbol core teams.

日本語版 README

Read-only MCP server that turns the Symbol REST API into 20 task-level tools. Instead of mirroring REST endpoints one-to-one, each tool answers a question a person actually asks:

Account holders: balances with alias names and decimals applied, transaction history and details with decoded messages, mosaic and namespace lookups, fee estimates, address validation, height/epoch/time conversion.
Node operators: node health and sync state, delegated-harvesting status, comparison against reference nodes, and above all voting-key expiry: remaining epochs, blocks and days, the estimated expiry date and a recommended renewal window.

Every tool returns structuredContent (validated against a published outputSchema) plus the same JSON as text (only symbol_harvesting_income with output: "csv" puts CSV in the text instead), with a short summary first: its first line answers the question, and further lines add details such as each month or each check that is not ok. Amounts are returned both with divisibility applied and as the raw integer; timestamps are ISO 8601 UTC, with a local time added when SYMBOL_TIMEZONE is set.

What it looks like

Two calls and excerpts of what they return. The values come from the test fixtures (a synthetic node host and account), not from a live node.

"Is my node healthy, and is it in sync?" → symbol_node_status {}

{
  "summary": "node.test:3001 (friendlyName \"fixture-node\", host \"mainnet-node.example\") on mainnet is healthy and synced.\nSymbol 1.0.3.9, roles Peer/API/Voting; height 5,763,675, finalized 5,763,656 (epoch 4004); 6 peers; latest block 201 s old (not synced above 300 s).",
  "verdict": "healthy",
  "sync": {
    "synced": true,
    "latestBlockTime": { "utc": "2026-09-10T03:01:38.808Z" },
    "ageSeconds": 201,
    "thresholdSeconds": 300,
    "checkedAt": { "utc": "2026-09-10T03:05:00.000Z" }
  },
  "checks": [
    { "id": "api_node", "status": "ok", "detail": "API node service is up.", "hint": null },
    { "id": "db", "status": "ok", "detail": "Database service is up.", "hint": null },
    {
      "id": "clock_skew",
      "status": "ok",
      "detail": "Node clock is 1,000 ms behind this machine's clock (warn at 15,000 ms, fail at 30,000 ms).",
      "hint": null
    },
    {
      "id": "chain_tip_age",
      "status": "ok",
      "detail": "Latest block (height 5,763,675) is 201 s old (about 3.4 min; warn above 300 s, fail above 900 s).",
      "hint": null
    }
    // … and storage_consistent, finalization_lag and roles
  ]
  // … then node, network, chain, storage, peers, time and notes
}

verdict folds the seven checks into one word, and sync.synced says whether the node follows the chain (null when that could not be judged). A check that is not ok carries a hint with the next step, and the summary lists it on its own line. A request that fails makes its check unknown and its fields null; the call still answers.

"How much did I earn from harvesting, month by month?" → symbol_harvesting_income { "account": "NCV5HR…", "fromDate": "2026-09-01", "toDate": "2026-09-11", "granularity": "monthly" }

NCV5HRBSFEGTPNBIUPBVAGWXWXZ43C4TNOQUYUY on mainnet, 2026-09-01 to 2026-09-11 (Asia/Tokyo; heights 5,736,305-5,767,984, 31,680 blocks): 20 harvest receipts totalling 662.574177 symbol.xym from 11 blocks (harvester share 461.240390 in 9 receipts, beneficiary share 201.333787 in 11 receipts).
Blocks: 9 harvested by this account, 2 harvested by others that paid it only the beneficiary share (typically delegators on its node). 9 of the 11 beneficiary receipts come from blocks it harvested itself, as its own node's beneficiary.
2026-09: 20 receipts, 662.574177 symbol.xym; 11 blocks: 9 harvested by this account, 2 by others (receipts 9 harvester / 11 beneficiary)

That is the summary; the same numbers are in totals and monthly[], each amount both as a decimal string ("662.574177") and as the raw integer ("662574177"), summed by the server. Receipts are shares of a block's reward, so an operator that is its own node's beneficiary gets two for each block it harvests; blocksHarvested and blocksBeneficiaryOnly count the blocks.

Requirements

Node.js 22 or newer.
A Symbol REST node reachable over https:// (port 3001 on most public nodes). Public nodes are listed at https://nodewatch.symbol.tools/.

Install

Claude Desktop: one-click bundle (.mcpb)

Download the latest symbol-mcp-server-<version>.mcpb from Releases.
Double-click it, or open Claude Desktop's Settings → Extensions and install it there.
In the settings form, enter the Symbol node URL, for example https://<node-host>:3001 (your own node is best, see Choosing a node). It is required: the extension does not start without it. Optionally set the time zone and a state directory, where symbol_harvesting_status keeps its snapshots; the other fields can stay empty.
Enable the extension.

After changing these settings later, try them in a new conversation.

The bundle holds the server built from the published npm package with its production dependencies and runs on the Node.js that ships with Claude Desktop. Use either the bundle or the npx configuration below, not both, or every tool appears twice. Claude Desktop may show the extension as unverified because the bundle is not signed with mcpb sign; its origin can be checked with the build provenance the release workflow attaches:

gh attestation verify symbol-mcp-server-<version>.mcpb --repo inotakeh/symbol-mcp-server

npm and source

From npm (recommended for every other MCP host):

npx -y symbol-mcp-server --help

Also listed in the MCP Registry as io.github.inotakeh/symbol.

From source:

git clone https://github.com/inotakeh/symbol-mcp-server.git
cd symbol-mcp-server
npm ci
npm run build
SYMBOL_NODE_URL=https://<node-host>:3001 node dist/index.js

node dist/index.js --help prints the environment variables to stderr and exits; --version prints the version. Apart from those two and the check subcommand (see CLI: monitoring from cron), the binary takes no arguments: everything is configured through the environment, so a model can never point it at another host.

Configure your MCP host

The server speaks MCP over stdio. On start-up it fetches /node/info, detects mainnet or testnet from the generation hash seed, and logs one line to stderr:

symbol-mcp-server <version>: mainnet via <node-host>:3001, timezone Asia/Tokyo

Claude Desktop

Add to claude_desktop_config.json. With the npm package:

{
  "mcpServers": {
    "symbol": {
      "command": "npx",
      "args": ["-y", "symbol-mcp-server"],
      "env": {
        "SYMBOL_NODE_URL": "https://<node-host>:3001",
        "SYMBOL_TIMEZONE": "Asia/Tokyo"
      }
    }
  }
}

From a source checkout:

{
  "mcpServers": {
    "symbol": {
      "command": "node",
      "args": ["/path/to/symbol-mcp-server/dist/index.js"],
      "env": {
        "SYMBOL_NODE_URL": "https://<node-host>:3001"
      }
    }
  }
}

Claude Code

claude mcp add symbol -s user -e SYMBOL_NODE_URL=https://<node-host>:3001 -e SYMBOL_TIMEZONE=Asia/Tokyo -- npx -y symbol-mcp-server
# or, from a source checkout:
claude mcp add symbol -s user -e SYMBOL_NODE_URL=https://<node-host>:3001 -- node /path/to/symbol-mcp-server/dist/index.js

Or commit a project-level .mcp.json:

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

Other clients

The same npx command works in any MCP host that starts stdio servers. File locations and formats below follow each client's own documentation.

Cursor: ~/.cursor/mcp.json for all projects, or .cursor/mcp.json in one project.

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

VS Code: .vscode/mcp.json in the workspace, or the user-level file opened with the command MCP: Open User Configuration. The top-level key is servers, not mcpServers.

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

Cline: in the Cline panel, open MCP Servers → Configure → Configure MCP Servers and add the server under mcpServers (the Cline CLI reads the same format from ~/.cline/mcp.json).

{
  "mcpServers": {
    "symbol": {
      "command": "npx",
      "args": ["-y", "symbol-mcp-server"],
      "env": { "SYMBOL_NODE_URL": "https://<node-host>:3001" },
      "disabled": false,
      "autoApprove": []
    }
  }
}

On Windows, a client that cannot start npx may need "command": "npx.cmd".

Environment variables

Variable	Required	Meaning
`SYMBOL_NODE_URL`	yes	REST URL of the node to query, e.g. `https://<node-host>:3001`. `https://` is required (`http://` only for `localhost` / `127.0.0.1` / `[::1]`). The port is used exactly as given.
`SYMBOL_NETWORK`	no	`mainnet` or `testnet`. When set, start-up fails if the node reports a different network.
`SYMBOL_TIMEZONE`	no	IANA zone such as `Asia/Tokyo`. Adds a local time next to every UTC timestamp.
`SYMBOL_REFERENCE_NODES`	no	Comma-separated `https://` node URLs that `symbol_network_compare` and `symbol_version_drift` check against. No other host is ever contacted.
`SYMBOL_REQUEST_TIMEOUT_MS`	no	Per-request timeout, 100 to 600000. Default `10000`.
`SYMBOL_STATE_DIR`	no	Absolute 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. Unset: the tool reports the current list without a comparison.

Choosing a node

Your own node is the best choice. SYMBOL_NODE_URL receives what you look up: addresses, transaction hashes, and the ids of namespaces and mosaics (Privacy Policy has the full list). The reference nodes only receive /node/info and /chain/info requests, never your identifiers.
A public node works, but its operator can see what you look up. Its access logs can show which accounts, transactions and namespaces were queried, when, and from which IP address. Use a node you trust, or your own node for anything you would rather keep private.
It must be the REST API of an API node. Most tools read /network/properties, accounts, transactions or blocks. Light REST, a REST with a reduced set of endpoints, is not enough: its README in the Symbol repository (client/rest/README_LIGHT.md in symbol/symbol) lists only /chain/info, /node/info, /node/peers, /node/unlockedaccount and /node/server. If a tool answers does not provide the endpoint … (no such route), see Troubleshooting.
Finding one: https://nodewatch.symbol.tools/ lists mainnet and testnet nodes with their height and version. Pick an API node that is at the current height, runs the majority version and answers over https:// (usually port 3001). Set SYMBOL_NETWORK to make start-up fail if the node turns out to be on the other network, and try it with SYMBOL_NODE_URL=https://<node-host>:3001 npx -y symbol-mcp-server check.

Tools

All 20 tools are read-only (readOnlyHint: true) and are listed in a fixed order. Arguments are identifiers only, never URLs. Every account argument (and the address of symbol_transaction_search) takes a base32 address, a 48-character hex address, a hex public key, or a namespace name such as alice or alice.pay that carries an address alias; the resolution of a name is reported in accountResolution and at the start of the summary.

Tool	Arguments	Answers
`symbol_network_info`	none	Network name/identifier and generation hash seed, current and finalized height, finalization epoch, block target time, voting set grouping, epoch adjustment, XYM mosaic id/alias/divisibility, current fee multipliers.
`symbol_node_status`	`format`	Is the configured node in sync and are its services healthy right now, and what is it. One verdict, `healthy`, `degraded` (a warning or a check that could not be made) or `unhealthy`, from seven checks in a fixed order, each ok/warn/fail/unknown with a hint: API node and database status (a 503 `/node/health` answer is read, not treated as a failure), database block count versus chain height, node clock versus this machine's clock, finalization lag in blocks and minutes, roles, and the age of the latest block versus this machine's clock, which catches a node that has stopped following the chain (warn beyond 10 target block times, fail beyond 30). `sync.synced` is true while the latest block is at most 10 target block times old (5 minutes on mainnet), false beyond that, and null when it could not be judged. Also friendly name, host, roles (Peer/API/Voting), decoded version, network, heights, peer count, database counts and the node clock. A request that fails makes its check unknown and its fields null instead of failing the call. Thresholds derive from the network properties.
`symbol_account_get`	`account` (address, public key or namespace name), `format`	Address in base32 and hex, public key, every mosaic balance with alias and decimals, importance, linked/VRF/node/voting keys, whether delegated harvesting is set up, multisig settings (as a multisig account or as a cosignatory).
`symbol_voting_key_status`	`account`	Every voting key with status (expired/active/future), remaining epochs/blocks/days, estimated expiry date, recommended renewal window (7 to 3 days before), slot usage including expired keys, voter eligibility versus `minVoterBalance`, warnings.
`symbol_transaction_get`	`transactionHash`	Looks in confirmed, unconfirmed and partial groups and reports the status; type name, signer and recipient, mosaics with aliases, decoded plain message or "encrypted" marker, fee, height and time, inner transactions of aggregates. A transaction the node rejected is reported as failed, with the node's code and its meaning; a hash the node does not know as not_found.

Example questions

"When does the voting key of NCV5HRBSFEGTPNBIUPBVAGWXWXZ43C4TNOQUYUY expire, and when should I renew it?" → symbol_voting_key_status { "account": "NCV5HRBSFEGTPNBIUPBVAGWXWXZ43C4TNOQUYUY" } Returns each key's startEpoch/endEpoch, the expiry height (endEpoch - 1) × votingSetGrouping, remaining epochs, blocks and days, an estimated expiry date based on the measured average block time, the renewal window, free slots (expired keys still occupy slots) and whether the balance meets minVoterBalance.

"Show me alice's account." → symbol_account_get { "account": "alice" } The namespace alice is resolved through the node to its address alias (a missing, expired, mosaic-aliased or alias-less namespace is an error with a hint); the answer starts with alice → NCV5… and carries the resolution in accountResolution. Works for every account argument.

"How much XYM does NCV5HRBSFEGTPNBIUPBVAGWXWXZ43C4TNOQUYUY hold?" → symbol_account_get { "account": "NCV5HRBSFEGTPNBIUPBVAGWXWXZ43C4TNOQUYUY" } Returns every mosaic with alias (symbol.xym), amount (decimals applied) and rawAmount.

"Show the last 20 transfers involving that account, then the details of the newest one." → symbol_transaction_search { "address": "NCV5HR…", "type": "transfer", "pageSize": 20 } → symbol_transaction_get { "transactionHash": "<hash from the list>" } The list gives hashes, dates, counterparties and message previews; the second call adds fees, full decoded messages and inner transactions.

"Is my node behind?" → symbol_node_status {} checks the age of the latest block on the configured node; → symbol_network_compare {} reports how many blocks it trails SYMBOL_REFERENCE_NODES.

"How much did NCV5HRBSFEGTPNBIUPBVAGWXWXZ43C4TNOQUYUY earn from harvesting in August 2026?" → symbol_harvesting_income { "account": "NCV5HR…", "fromDate": "2026-08-01", "toDate": "2026-08-31" } Resolves the dates to block heights, reads every HarvestFee receipt addressed to the account and sums them as exact integers: total XYM, harvester versus beneficiary share, and one row per day. Nothing is left for the model to add up.

"I just announced my voting key link. Did transaction <hash> go through?" → symbol_transaction_status { "transactionHashes": ["<hash>"] } Answers confirmed (with the height), unconfirmed, partial (aggregate bonded waiting for cosignatures), failed (with the node's code such as Failure_Core_Insufficient_Balance and its meaning) or not_found. Always an array, up to 20 hashes per call.

"Was my voting node NCV5HRBSFEGTPNBIUPBVAGWXWXZ43C4TNOQUYUY actually able to vote last week?" → symbol_finality_participation { "account": "NCV5HR…", "epochs": 14 } Reads the finalization proof of the latest finalized epoch and the 13 before it (an epoch is votingSetGrouping blocks, about 12 hours on mainnet) and reports per epoch whether one of the account's voting keys is among the signers of both stages, how many voters signed, and a warning if the current epoch was missed or no key covers it.

"I think my delegated harvesting is not working. Have a look at NCV5HRBSFEGTPNBIUPBVAGWXWXZ43C4TNOQUYUY." → symbol_delegation_diagnose { "account": "NCV5HR…" } Runs eleven checks in a fixed order (existence, balance limits, importance, the three key links, node key versus the configured node, unlocked on that node, account type, recent harvested blocks, the delegation request transfer) and answers active, not_active (with the failing step and a hint) or cannot_verify (the account delegates to a node other than SYMBOL_NODE_URL, so the node side cannot be checked).

"Is my node healthy, and is its version behind?" → symbol_node_status {} checks the API node, database, storage, clock, finalization lag and the age of the latest block of the configured node, answers healthy / degraded / unhealthy with the failing checks, and says whether the node is synced; → symbol_version_drift {} compares the node version with its peers and the reference nodes and answers ok / behind / far_behind. Both are the first things to look at after a node OS migration.

"Have my delegators come back after the migration?" → symbol_harvesting_status { "mode": "compare_and_save" } compares the harvesters unlocked on the node right now with the last stored snapshot (added and removed keys, count delta, 30-day min / max / average) and stores today's list for the next check; "mode": "compare" looks without storing. Needs SYMBOL_STATE_DIR; without it the tool reports the current count and says no comparison is possible. Without a mode the tool answers "how many delegators right now?" and touches no snapshot.

"Where does NCV5HRBSFEGTPNBIUPBVAGWXWXZ43C4TNOQUYUY rank by XYM holdings? Who are the top 10?" → symbol_account_rank { "account": "NCV5HRBSFEGTPNBIUPBVAGWXWXZ43C4TNOQUYUY", "top": 10 } Reads the holder list ordered by balance 100 accounts at a time until the account turns up (or maxRank, default 1000, is reached), and returns its balance, share of supply and rank together with the top 10 holders and their combined share. All shares are computed by the server in integer arithmetic; the top of the list is usually exchanges and the foundation, and the tool labels nobody.

"If XYM is 12.34 yen, how much are my holdings worth? NCV5HRBSFEGTPNBIUPBVAGWXWXZ43C4TNOQUYUY" → symbol_holdings_value { "account": "NCV5HR…", "unitPrice": "12.34", "currency": "JPY" } Reads the balance and multiplies it by the price in integer arithmetic: 53,321,140 JPY for 4,321,000 XYM, with the exact product alongside. The price comes from the caller. This server never contacts a price API (it talks to SYMBOL_NODE_URL only), so when you ask "what are my holdings worth right now?" the flow in Claude Desktop is: the model looks the price up first (a web search, another MCP server that serves prices, or you type it in), then calls this tool with unitPrice, currency and, ideally, priceSource / priceAsOf so the answer says where and when the price was observed. The model is told not to multiply balance by price itself.

More cases, with the exact arguments expected for each, are in evals/cases.json.

Prompts

Two MCP prompts (prompts/list) bundle the tool calls a node operator repeats. Both take one argument, account: the 39-character base32 address of the voting / harvesting account. The prompt text contains no addresses, hosts, keys or dates of its own.

Prompt What it walks through

voting_key_renewal_checklist symbol_voting_key_status (expiry, renewal window, free slots and its warnings as given), symbol_node_status (stop if not synced, or if the sync could not be judged; its verdict and the checks that are not ok go under open items), symbol_network_compare (sync reported as not confirmed when it could not compare), then, after the operator has announced the VotingKeyLink outside this server, symbol_transaction_status on the hash, a second symbol_voting_key_status to confirm the new key, and symbol_finality_participation once the new key's start epoch is finalized. Ends with a four-line summary.

monthly_health_check symbol_node_status (verdict, sync, version and peer count; unhealthy goes first), symbol_version_drift (behind or far_behind goes first), symbol_network_compare (sync reported as not confirmed when it could not compare), symbol_harvesting_status in mode compare_and_save (delta against the previous snapshot), symbol_voting_key_status (remaining days and expiry; its warnings go first, as given), symbol_account_get (balance versus minVoterBalance) and symbol_harvesting_income for the previous calendar month (the income, then the blocks the account harvested itself and the blocks of delegators or others as separate items). Reports on one screen as Action required / Attention / Normal.

Prompt	What it walks through
`voting_key_renewal_checklist`	`symbol_voting_key_status` (expiry, renewal window, free slots and its warnings as given), `symbol_node_status` (stop if not synced, or if the sync could not be judged; its verdict and the checks that are not ok go under open items), `symbol_network_compare` (sync reported as not confirmed when it could not compare), then, after the operator has announced the VotingKeyLink outside this server, `symbol_transaction_status` on the hash, a second `symbol_voting_key_status` to confirm the new key, and `symbol_finality_participation` once the new key's start epoch is finalized. Ends with a four-line summary.
`monthly_health_check`	`symbol_node_status` (verdict, sync, version and peer count; unhealthy goes first), `symbol_version_drift` (behind or far_behind goes first), `symbol_network_compare` (sync reported as not confirmed when it could not compare), `symbol_harvesting_status` in mode `compare_and_save` (delta against the previous snapshot), `symbol_voting_key_status` (remaining days and expiry; its warnings go first, as given), `symbol_account_get` (balance versus `minVoterBalance`) and `symbol_harvesting_income` for the previous calendar month (the income, then the blocks the account harvested itself and the blocks of delegators or others as separate items). Reports on one screen as Action required / Attention / Normal.

The server also sends short instructions at initialize time (read-only, account formats, which tool answers the questions that are easy to mix up: harvest income, voting keys, node health and sync versus version, whether a transaction went through; use the returned numbers as they are). Tools that answer neighbouring questions point to each other in their descriptions.

CLI: monitoring from cron

The same binary has a one-shot check subcommand that needs no MCP client. It judges the node with the tools above, prints one report and exits non-zero when something is wrong:

symbol-mcp-server check [--account <address|publicKey|namespace>] [--warn-days <n>]
                        [--cert <path>]... [--cert-warn-days <n>]
                        [--format text|json] [--quiet]

It reads the same environment variables as the server (SYMBOL_NODE_URL is required; SYMBOL_TIMEZONE, SYMBOL_REFERENCE_NODES and SYMBOL_STATE_DIR are optional) and needs Node.js 22 or newer. Started without arguments the binary is still the MCP server, unchanged.

#	Item	ok / warn / fail
1	`node_health`	The verdict of `symbol_node_status`: healthy / degraded / unhealthy. A node whose latest block is older than 10 target block times (5 minutes on mainnet) is degraded, older than 30 unhealthy
2	`version_drift`	`symbol_version_drift`: ok / behind or unknown / far_behind
3	`harvester_watch`	`symbol_harvesting_status` in mode `compare_and_save`: warn when fewer harvesters are unlocked than at the previous run, or when the snapshot could not be saved. Skipped without `SYMBOL_STATE_DIR`
4	`voting_key_status`	With `--account`: warn when the active voting key expires within `--warn-days` (default 14, 1 to 120), fail within 3 days or without an active key; ok when a successor key is already registered without a gap. Fail also when the balance is below `minVoterBalance` (the account cannot vote), successor or not. Full key slots change no status, but the hint of a warn or fail then adds the tool's slot warning, unless a successor key is already registered. Skipped without `--account`
5	`finality_participation`	With `--account`, latest finalized epoch: participated / missed or no proof on the node / no key covers the epoch. Skipped without `--account`
6	`certificate`	With `--cert <path>`, once for each copy of the node certificate: fail when a certificate has expired or has fewer than 7 days left, warn with fewer than `--cert-warn-days` (default 30) or when the files are not copies of one certificate. A file that cannot be read, or is not a certificate, fails with the reason. Skipped without `--cert`. See Node certificate files

For items 1 to 5 the judgments are the tools' own; the check only reads their output, and the hint printed under a warn or fail line is the tool's text. A tool that fails (for example an HTTP error) fails its item and the others still run. Item 6 is the exception: no REST endpoint shows a node's certificate files, so the check reads the files itself and has no MCP tool behind it.

Exit code	Meaning
0	every item is ok or skipped
1	at least one warning, no failure
2	at least one failure
3	the check could not run: configuration error, node unreachable, or bad arguments (one or two lines on stderr say why). With `--cert`, the certificate files are still judged and reported when it is the node that could not be read; see Node certificate files

Text output (the default; illustrative values):

symbol check: WARN (node.example:3001, mainnet, 2026-01-15T07:00:03+09:00)
[ok] node_health: healthy (finalization lag 12 blocks)
[ok] version_drift: ok. node.example:3001 runs 1.0.3.9; majority of 24 sampled nodes runs 1.0.3.9; 0% run something newer.
[ok] harvester_watch: 18 unlocked harvesters on node.example:3001, unchanged since 2026-01-14T07:00:02+09:00 (2026-01-13T22:00:02.000Z). Snapshot saved (31 stored).
[warn] voting_key_status: active key 0A1B2C3D… expires in about 12.4 days (epoch 4321, estimated 2026-01-27T16:40:00+09:00 (2026-01-27T07:40:00.000Z))
  hint: Active voting key 0A1B2C3D… expires at epoch 4321 in about 12.4 days (...) and no successor key is registered.
[ok] finality_participation: epoch 4290: participated (signed prevote and precommit)
[skip] certificate: no --cert given; pass --cert <path> for each copy of the node certificate to check its expiry

--format json prints the same report as one JSON document: { verdict, exitCode, node: { host, network }, checkedAt, checks: [{ id, status, detail, hint }], warnDays, account }, with verdict one of ok, warn, fail, error (exit code 3) and account the resolved address. When /node/info cannot be read at start-up and --cert was given, network is unknown, the five items that ask the node are skip, certificate is ok, warn or fail, and account is the argument as given (one longer than 16 characters is cut to its first 8 and …); read the overall result from verdict (error) and exitCode (3), not from the items. --quiet prints nothing when the exit code is 0, so cron only mails when there is something to read:

[email protected]
0 7 * * * SYMBOL_NODE_URL=https://node.example:3001 SYMBOL_STATE_DIR=/var/lib/symbol-mcp-server \
  npx --yes symbol-mcp-server check --account NXXX... --warn-days 14 --quiet \
  --cert /path/to/target/nodes/node/cert/node.crt.pem \
  --cert /path/to/target/gateways/rest-gateway/api-node-config/cert/node.crt.pem

The entry is broken into lines here only to fit the page: cron has no line continuation, so write it on one line in the crontab.

The check sends no notification. It writes to stdout and stderr and sets the exit code; mail is cron's job (MAILTO). It contacts SYMBOL_NODE_URL and the SYMBOL_REFERENCE_NODES, nothing else, and is as read-only as the server. With SYMBOL_STATE_DIR set, every run appends one snapshot to the file symbol_harvesting_status uses (the newest 60 are kept). With --cert it reads the named files on the machine it runs on; nothing of them is sent anywhere.
The whole run is limited to 120 seconds. At the limit the remaining items are skipped, the reason goes to stderr, and the result is WARN at best, printed even with --quiet. The limit is not applied when /node/info cannot be read at start-up (see Node certificate files): no further request is made then, and the --cert files are only read, up to 1 MiB each.
A typo in the subcommand name is an unknown argument of the server and exits with 2, as before.

Node certificate files (`--cert`)

A node set up with symbol-bootstrap keeps its certificate in two places: the node itself uses target/nodes/node/cert/node.crt.pem, and the REST gateway has its own copy at target/gateways/rest-gateway/api-node-config/cert/node.crt.pem. symbol-bootstrap renewCertificates renews the first and does not touch the second. When only the REST gateway's copy expires, the gateway can no longer talk to the node and /node/health reports apiNode: down. Pass both files, and check tells you before that happens:

symbol-mcp-server check --cert target/nodes/node/cert/node.crt.pem \
  --cert target/gateways/rest-gateway/api-node-config/cert/node.crt.pem

[warn] certificate: warn (copies differ: target/nodes/node/cert/node.crt.pem vs target/gateways/rest-gateway/api-node-config/cert/node.crt.pem)
  target/nodes/node/cert/node.crt.pem: ok, expires 2027-01-20T02:11:09.000Z, 370 days left, sha256 0A:1B:2C:…
  target/gateways/rest-gateway/api-node-config/cert/node.crt.pem: ok, expires 2026-03-01T02:11:09.000Z, 45 days left, sha256 3D:4E:5F:…

Each file: fail when the certificate has expired or has fewer than 7 days left (fixed, not an option), warn with fewer than --cert-warn-days days left (default 30, a whole number of 1 or more; independent of --warn-days), ok otherwise. Days left are whole days from now to the certificate's notAfter, rounded down, so the last day counts as 0. A file that holds several certificates (node.full.crt.pem) is judged by its first one.
Copies: with two or more files, their SHA-256 fingerprints must all be the same; if not, the item is at least warn and names the files that differ. A renewal that replaced one copy and not the other shows up here on the same day, long before the old copy expires. Giving the same path twice is refused as a usage error, since it would compare the file with itself (paths are compared as written, after resolving . and ..; a link to the same file, or another spelling of it on a file system that ignores case, is not noticed).
The item's verdict is the worst of the files and the comparison. A file that cannot be read or is not a certificate fails with the reason (cannot be read (ENOENT), not a certificate …), and the other files and the other items are still checked.
Run it on the node's server. The files are read from the local disk; no MCP tool can do this, because the REST API does not show them. A relative path is resolved against the current directory; cron starts commands in the home directory, so give absolute paths there.
Never pass a key. A file whose content contains PRIVATE KEY (the label of every PEM private key) is not parsed and fails with a private key was passed; pass the certificate (.crt.pem). Any other file that is not a certificate fails as not a certificate. Either way, the report holds only the path you gave, the verdict, notAfter (ISO 8601, UTC), the days left, the SHA-256 fingerprint and, in the JSON, the subject's common name; no other content of a file is printed.
--format json adds files: [{ path, status, notAfter, daysLeft, fingerprint256, commonName, reason }] to the certificate item when it ran (reason says why a file could not be used and is null otherwise; daysLeft is negative once expired).
When the node stops answering during the run and every node-backed item fails for that reason, the exit code stays 3 whatever the files say; the certificate lines are still printed. The same holds when /node/info cannot be read at start-up (the node does not answer, or answers with an error): the files are read and judged all the same and the report is printed, with too. Its first line says and gives the network as , the five items that ask the node are skipped with the reason , the item and the line of each file follow, and stderr says why could not be read. Without , only the lines on stderr are printed then. A configuration error (an environment variable that is missing or not valid, or a node on the wrong network) ends the check before any file is read.

Security

Read-only. No tool signs, builds or announces transactions. No argument accepts a private key, mnemonic or token. A 64-character hex account argument is taken as a public key and turned into its address on this machine, and the node is asked for the address: a private key pasted by mistake never reaches the node, and errors show at most its first 8 characters. Nothing is stored between calls, except that symbol_harvesting_status, in the modes that save (compare_and_save, save_only), keeps its per-node snapshot of unlocked harvester public keys, heights and times under SYMBOL_STATE_DIR when that variable is set (no secrets; delete the file to start over).
Certificate files only on request. The MCP server reads no certificate or key. Only check --cert <path> does, and only the files named there, on the machine it runs on. It opens no key file on its own, and a PEM private key passed by mistake (a file whose content contains PRIVATE KEY) is refused without being parsed. Nothing of a file is printed except the certificate's expiry date, SHA-256 fingerprint and common name, and nothing is sent anywhere.
Fixed destinations. The server contacts only SYMBOL_NODE_URL and, for symbol_network_compare and symbol_version_drift, the hosts listed in SYMBOL_REFERENCE_NODES. Tools never take a URL as an argument, so a model cannot redirect requests. There is no telemetry.
Untrusted chain data. Transfer messages, metadata values, alias names and what a node reports about itself (friendly name, host name, status and version strings) are written by third parties. They are exposed under names that make this obvious (messageText) and made one line: tabs and line breaks become a space, so words stay apart, and runs of spaces become one. Every other control and invisible format character is stripped (zero-width and bidi characters, soft hyphens, and the tag characters U+E0000 to U+E007F that people cannot see but models can read), and length is capped without splitting a character. Variation selectors are kept, so emoji and ideograph variants survive; emoji joined by a zero-width joiner come out as separate emoji. The 16 tools that show such text report in invisibleCharactersRemoved how many characters were removed from it, and when any were, the summary ends with a line saying so. In the summary, such text also appears after a label and in double quotes, with quotes and backslashes escaped as in JSON (untrusted message: "…", friendlyName "…"), so it cannot close the quote and read as the server's own words; alias and namespace names that fit the namespace grammar stay as they are. Treat all of it as data, not instructions.

Vulnerability reports: see SECURITY.md.

Privacy Policy

What the MCP server and its check command send, who receives it, and what stays on your machine.

This project. The maintainer receives nothing: the server has no telemetry, no analytics and no update check. The only network connections it opens go to the nodes you set in SYMBOL_NODE_URL and SYMBOL_REFERENCE_NODES.
The node in SYMBOL_NODE_URL. It receives what you look up: addresses, transaction hashes, namespace and mosaic ids, heights and epochs, and the paging, sort order and filter options of a search. Its operator can see these, together with the time and the IP address they came from.
Names and public keys. A namespace name is sent as the id computed from it on your machine (this does not hide the name: the id follows from the name), and an account given as a public key is asked for by the address derived from it. One tool sends a public key: symbol_delegation_diagnose sends the key the node reported for the account back to that same node, to find the account's delegation request.
The nodes in SYMBOL_REFERENCE_NODES. They receive only /node/info and /chain/info requests, so their operators see the time and your IP address but nothing you looked up. Every request, to them and to SYMBOL_NODE_URL, has the header User-Agent: symbol-mcp-server/<version>.
Your disk. Only if you set SYMBOL_STATE_DIR: each saved snapshot (symbol_harvesting_status in mode compare_and_save or save_only, and each run of check) goes into one file per node there, which holds the node's nodePublicKey and, for the newest 60 snapshots, the time, the height and the public keys of the unlocked harvesters. The files (their names start with harvesters-) stay until you delete them; deleting them removes every snapshot the server has kept.
Logs. The server and check log a few lines to stderr: the server's start-up line (version, network, node host and, when set, the time zone, the number of reference nodes and the state directory), a line for a failed start, for a wrong argument, for an error on the connection to the MCP host, for an unexpected error or for a time from the node that cannot be shown as a date, and the diagnostics of check. They write no log file and, apart from the snapshots above, keep no record of tool calls; what becomes of stderr is decided by the program that started them (see Troubleshooting).
check --cert. The certificate files you name are read on the machine the command runs on, and nothing of them is stored or sent. The report shows the path you gave and the certificate's expiry date and SHA-256 fingerprint (with , also its common name), and goes to stdout; where it goes from there (cron's mail, a log file) is your own setting.

Release integrity

Published from CI, with provenance. Every npm release is built and published by the GitHub Actions workflow release.yml through npm trusted publishing (OIDC). There is no npm token, neither on a maintainer's machine nor in the repository secrets. Each version carries a provenance attestation that links it to the source commit and the workflow run that built it.
Check it yourself.
- The package page on npmjs.com shows a Provenance section with the commit and the workflow run.
- npm view symbol-mcp-server dist.attestations prints the attestation URL and the provenance predicate type of the latest version.
- In a project that installs it, npm audit signatures verifies the registry signatures and provenance attestations of the installed packages.
GitHub Releases carry the same package. From 0.8.0 on, each GitHub Release has three files attached (earlier releases have the first two): symbol-mcp-server-<version>.tgz, byte for byte the tarball npm serves (its SHA-512 is checked against the registry's dist.integrity), symbol-mcp-server-<version>.tgz.sigstore.json, npm's SLSA provenance for that tarball as a Sigstore bundle (its subject is checked to be the tarball's SHA-512), and the Claude Desktop bundle symbol-mcp-server-<version>.mcpb (next point). The first two are collected by scripts/release-assets.sh. To verify a downloaded pair with the GitHub CLI:
```
gh attestation verify symbol-mcp-server-<version>.tgz \
  --bundle symbol-mcp-server-<version>.tgz.sigstore.json \
  --repo inotakeh/symbol-mcp-server --digest-alg sha512
```
--digest-alg sha512 is needed because npm's provenance names the tarball by its SHA-512.
The Claude Desktop bundle is built from that same tarball. symbol-mcp-server-<version>.mcpb is made by scripts/build-mcpb.sh from the checked npm tarball above plus the production dependencies installed with npm ci --omit=dev from the lockfile of that release; nothing else is compiled or downloaded. The release workflow attaches a GitHub build provenance attestation to it (, see ).

Supported networks

Network	Identifier	Detected by generation hash seed
Symbol mainnet	104	`57F7DA20…72B2D6`
Symbol testnet (sai)	152	`49D6E1CE…FC665A4`

The network is detected from the node at start-up. Any other generation hash seed (private networks, NEM NIS1) is rejected. Nodes of both networks are listed at https://nodewatch.symbol.tools/; see Choosing a node.

Limitations

Node history and limits. Results come from the configured node. Nodes that prune transaction history return only what they still hold, so symbol_transaction_search may miss old transactions on such nodes. A public node may also limit how many requests it accepts. The calls that send the most are symbol_account_rank (up to 50 pages) and symbol_harvesting_income over a long period (up to 200 pages); use your own node for those.
Future dates are estimates. Expiry dates for voting keys, namespaces and mosaics, and any future height or epoch, are projected from the measured average block time over the last 10,000 blocks (about 30 s on mainnet) and are flagged as estimates.
Encrypted messages are not decrypted; they are reported as encrypted.
Page size is 10 to 100, because catapult-rest coerces smaller pages to 10.
Confirmed transactions only in search. Unconfirmed and partial transactions are visible through symbol_transaction_get by hash.
Harvesting status covers the configured node (/node/unlockedaccount), not the whole network.
No prices. symbol_holdings_value multiplies a balance by a unit price the caller passes in; it does not fetch, check or remember prices, and the result is only as good as that input. Look the price up first (web search, a price MCP server, or the user) and pass it with priceSource and priceAsOf. The value is the plain product: no fees, spread or taxes, and no tax lot accounting.
Holder rank is a scan, not an index. symbol_account_rank reads the holder list 100 accounts per request down to maxRank (at most 5,000, i.e. 50 requests); an account below that gets rank: null with rankBeyond. Equal balances are ordered by the node and may swap between calls.
Harvester history is local. symbol_harvesting_status compares against snapshots it wrote itself under SYMBOL_STATE_DIR; another machine, a deleted file or a changed node key (a new node.key.pem after a migration) starts a new baseline. Repeated calls on the same day add repeated snapshots; only the newest 60 are kept.
Harvest income reads at most 20,000 statements per call (200 pages of 100). A longer period comes back truncated; split it with fromHeight/toHeight. Rewards are summed from HarvestFee receipts, so a node that prunes receipts reports less than the chain holds.

Troubleshooting

Start-up errors go to stderr as one line starting with symbol-mcp-server failed to start:. MCP hosts keep stderr in their logs (Claude Desktop: ~/Library/Logs/Claude/mcp*.log on macOS, %APPDATA%\Claude\logs on Windows), and running the same command in a terminal prints it too.

You see	Cause and fix
`SYMBOL_NODE_URL is required`	The variable does not reach the server process. Put it in the `env` block of the host configuration; an `export` in your shell does not reach a server that a desktop app starts.
`SYMBOL_NODE_URL must use https://` or `SYMBOL_NODE_URL must start with https://`	Use the node's `https://` URL (usually port 3001). `http://` is accepted only for `localhost` / `127.0.0.1` / `[::1]`.
`SYMBOL_NETWORK=mainnet but node <host> is on testnet`	The node is on the other network. Point `SYMBOL_NODE_URL` at a node of the network you want, or correct `SYMBOL_NETWORK`.
`Node <host> reports an unknown network`	The node's generation hash seed is neither Symbol mainnet nor testnet (a private network, or a NEM NIS1 node). Use a Symbol mainnet or testnet node.
`<host> did not answer /node/info within 10000 ms` or `could not reach <host> for /node/info` at start-up; `Node <host> did not answer … within … ms` or `Could not connect to node <host>` from a tool	The node is down, overloaded, or the port is wrong (3001 for https). Try another node from nodewatch, or give a slow node more time with `SYMBOL_REQUEST_TIMEOUT_MS` (up to 600000).
`<host> answered /node/info with a redirect (HTTP 301), which is not followed` at start-up; `Node <host> answered … with a redirect` from a tool	The URL leads to something that redirects: http to https, a proxy, or a moved path. Redirects are never followed and the address in them is not contacted. Set `SYMBOL_NODE_URL` to the node's REST API URL itself, usually `https://<node-host>:3001`.
`Node <host> does not provide the endpoint … (no such route)` from a tool (`check` prints it as a `hint:` line)	The node answered that it has no route for that path. This server needs the REST API of an API node. Possible causes: the node offers only Light REST, which serves only a few `/node` and `/chain` endpoints (see Choosing a node), or it runs a catapult-rest version without that endpoint. Set to the REST URL of an up-to-date API node, for example one from nodewatch. If an up-to-date API node answers this way, it is a bug in this server: please report it with the tool name.

Development

npm ci
npm run lint && npm run typecheck && npm test
npm run build
SYMBOL_NODE_URL=https://<node-host>:3001 node dist/index.js
npx @modelcontextprotocol/inspector -e SYMBOL_NODE_URL=https://<node-host>:3001 node dist/index.js
SYMBOL_INTEGRATION=1 SYMBOL_NODE_URL=https://<testnet-node>:3001 npm test   # live-node tests
SYMBOL_INTEGRATION=1 SYMBOL_NODE_URL=https://<node-host>:3001 SYMBOL_INTEGRATION_ACCOUNT=<address> npm test   # account tools against a specific account
SYMBOL_INTEGRATION=1 SYMBOL_NODE_URL=https://<node-host>:3001 SYMBOL_INTEGRATION_MULTISIG_ACCOUNT=<address> npm test   # symbol_account_get against a multisig account and its first cosignatory
node scripts/capture-fixtures.mjs https://<node-host>:3001   # refresh test/fixtures/<network>/ from a node

The MCP Inspector gives the server it starts only a few of its own environment variables (PATH, HOME and the like, the MCP SDK's default) plus the ones it is given, so a variable set in front of npx does not reach the server. Pass each one with -e KEY=VALUE as above, or enter it in the Inspector's form; on macOS and Linux, wrapping the server command in env works too.

Design notes: docs/DESIGN-BRIEF.md. Changes: CHANGELOG.md. Releases: docs/RELEASING.md.

Contributing

Bug reports, feature requests and pull requests are welcome. See CONTRIBUTING.md for the development setup, how to add a tool and the design rules; security problems go through SECURITY.md.

License

MIT

Symbol

添加此服务器

用我们的密钥与日志托管一份副本。

Server facts

Tools

Questions

How do I install Symbol?

Does Symbol need an API key?

What transport does Symbol use?

When was Symbol last checked?

Documentation

symbol-mcp-server

What it looks like

Requirements

Install

Claude Desktop: one-click bundle (.mcpb)

npm and source

Configure your MCP host

Claude Desktop

Claude Code

Other clients

Environment variables

Choosing a node

Tools

Example questions

Prompts

CLI: monitoring from cron

Node certificate files (`--cert`)

Security

Privacy Policy

Release integrity

Supported networks

Limitations

Troubleshooting

Development

Contributing

License

添加此服务器

用我们的密钥与日志托管一份副本。

Server facts

Tools

Questions

How do I install Symbol?

Does Symbol need an API key?

What transport does Symbol use?

When was Symbol last checked?

Documentation

symbol-mcp-server

What it looks like

Requirements

Install

Claude Desktop: one-click bundle (.mcpb)

npm and source

Configure your MCP host

Claude Desktop

Claude Code

Other clients

Environment variables

Choosing a node

Tools

Example questions

Prompts

CLI: monitoring from cron

Node certificate files (--cert)

Security

Privacy Policy

Release integrity

Supported networks

Limitations

Troubleshooting

Development

Contributing

License

Node certificate files (`--cert`)