nimiq-mcp

onmax/nimiq-mcp

3.3

If you are the rightful owner of nimiq-mcp and would like to certify it and/or have it hosted online, please leave a comment on the right or send an email to henry@mcphub.com.

The Nimiq MCP Server is a Model Context Protocol server designed for interacting with the Nimiq blockchain, providing tools for accessing blockchain data and performing calculations.

The Nimiq MCP Server is a specialized server that facilitates interaction with the Nimiq blockchain through the Model Context Protocol (MCP). It is designed to provide users with a comprehensive suite of tools for accessing blockchain data, including accounts, transactions, blocks, and validators. The server is easy to set up using npx and is compatible with any MCP client. It supports only read operations, intentionally excluding transaction sending to maintain security and simplicity. Users can configure the server with custom RPC endpoints and authentication credentials, allowing for flexible integration into various environments. The server is built using TypeScript and leverages the official MCP SDK and a fully typed Nimiq RPC client, ensuring a robust and type-safe development experience. Additionally, it includes comprehensive error handling to manage RPC connection issues, rate limits, and network timeouts, ensuring reliable operation.

Features

  • Nimiq blockchain tools for accounts, transactions, blocks, and validators
  • Easy setup with npx
  • Supports custom RPC endpoints and authentication
  • Comprehensive error handling
  • Built with TypeScript for type safety

Usages

usage with Claude Desktop

{
  "mcpServers": {
    "nimiq": {
      "command": "npx",
      "args": ["nimiq-mcp"]
    }
  }
}

usage with Custom RPC Endpoint

{
  "mcpServers": {
    "nimiq": {
      "command": "npx",
      "args": [
        "nimiq-mcp",
        "--rpc-url",
        "https://your-custom-rpc-endpoint.com"
      ]
    }
  }
}

usage with Authentication

{
  "mcpServers": {
    "nimiq": {
      "command": "npx",
      "args": [
        "nimiq-mcp",
        "--rpc-url",
        "https://your-rpc-endpoint.com",
        "--rpc-username",
        "your-username",
        "--rpc-password",
        "your-password"
      ]
    }
  }
}

Tools

  1. getHead

    Get the current head block of the Nimiq blockchain

  2. getBlockByNumber

    Retrieve a specific block by its number

  3. getBlockByHash

    Retrieve a specific block by its hash

  4. getEpochNumber

    Get the current epoch number

  5. getSupply

    Get the current circulating supply of NIM

  6. calculateSupplyAt

    Calculate the Nimiq PoS supply at a given time

  7. calculateStakingRewards

    Calculates the potential wealth accumulation based on staking

  8. getPrice

    Get the price of NIM against other currencies

  9. getAccount

    Get detailed account information by address

  10. getBalance

    Get the balance of a specific account address

  11. getTransaction

    Get detailed transaction information by hash

  12. getTransactionsByAddress

    Get transaction history for a specific address

  13. getValidators

    Get information about all active validators

  14. getValidator

    Get detailed information about a specific validator

  15. getSlots

    Get validator slot information for current or specific block

  16. getNetworkInfo

    Get network status including peer count and consensus state

  17. getRpcMethods

    Get all available RPC methods from the latest OpenRPC document

  18. getWebClientDocs

    Get the complete web-client documentation for LLMs

  19. getProtocolDocs

    Get the complete Nimiq protocol and learning documentation for LLMs

  20. getValidatorDocs

    Get the complete validator and staking documentation for LLMs

  21. searchDocs

    Search through the Nimiq documentation using full-text search