Skip to main content

MCP Tools

The Nium MCP Server exposes six tools. Every session has access to all of them.

Available tools​

CategoryToolDescription
Discoverynium_api_searchYour starting point. Search for APIs, payout journeys, corridor coverage, or how-to guides by keyword or intent. Returns matching endpoints, playbooks, and guides.
nium_api_detailsGet the full field-level schema for a specific API operation — request parameters, response shape, constraints, and variants.
Coveragenium_corridor_readRead Atlas corridor coverage for a specific country: available rails, cutoff times, limits, and mandatory remitter and beneficiary fields.
Guidesnium_docs_readRead pinned Nium developer guides in Markdown — webhook flows, integration patterns, how-tos. Informational context only; not the API contract.
Sandbox actionsnium_api_readExecute live GET calls against the Nium Sandbox API by operation ID or path.
nium_api_writeExecute live POST, PUT, PATCH, and DELETE calls against Sandbox — creates customers, runs KYC, adds beneficiaries, funds wallets, and initiates payouts.
info

Start every session with nium_api_search. It routes your query to the right tool and returns the operation IDs you need for nium_api_details, nium_api_read, and nium_api_write.

warning

nium_api_write executes real Sandbox operations. Review what your agent is about to do before confirming write actions.

Currently, interactions with the Payout APIs are supported. We are working on adding more APIs and endpoints.

For a full overview of supported endpoints, see the list on GitHub.

LLM-ready documentation:: llms.txt and llms-full.txt
Was this page helpful?