algorand mcp

Local 2025-08-31 23:58:52 0
Developer Tools @GoPlausible/algorand-mcp

A comprehensive MCP server for tooling interactions(40+) and resource accessibility(60+) with Algorand blockchain, plus many useful prompts.

smithery badge npm downloads npm version License: MIT

Overview

Model context protocol or MCP, is an open protocol that standardizes how applications provide context to LLMs. MCP provides specification standards to give LLMs tools, resources and instructions to be more useful and effective.

Screenshot 2025-03-15 at 17 47 54

MCP Github contains more information and different tools and specifications plus documentation of MCP.

This repository is a Model Context Protocol (MCP) implementation for Algorand blockchain interactions. The implementation consists of: - (PRODUCTION) A server package for blockchain interactions (Node.js only) - (WIP) A client package for wallet management and transaction signing (supports both browser and Node.js)

? Packages in this repository: - Algorand MCP Server - Algorand MCP server full implementation. - Algorand MCP Client - Algorand MCP Client for client side Wallet management and transaction signing, as well as integration by other Agent hosts.

? NPM: - Algorand MCP Server NPM package - Algorand MCP server implementation via NPM package installation.

? Smithery: - Algorand MCP Server on Smithery - Algorand MCP server implementation via smithery.

Features

  • Complete Algorand blockchain interaction capabilities
  • Extensive wallet management system
  • Comprehensive transaction handling
  • Rich blockchain state querying
  • Built-in security features
  • Support for Claude Desktop and Cursor integration

Requirements

  • Node.js v23.6.1 or later
  • npm v10.2.4 or later

Installation

Via NPM (for developers who wish to run their own instances)

# Install both client and server packages
npm install algorand-mcp

Via Smithery (For all users)

Via Smithery (for Claude Desktop)

Simply run this command in the terminal:

npx -y @smithery/cli@latest install @GoPlausible/algorand-mcp --client claude --config "{"NFD_API_KEY":"","NFD_API_URL":"https://api.nf.domains","ALGORAND_ALGOD":"https://testnet-api.algonode.cloud","ALGORAND_TOKEN":"","ITEMS_PER_PAGE":"10","VESTIGE_API_KEY":"","VESTIGE_API_URL":"https://api.vestigelabs.org","ALGORAND_INDEXER":"https://testnet-idx.algonode.cloud","ALGORAND_NETWORK":"testnet","ALGORAND_ALGOD_API":"https://testnet-api.algonode.cloud/v2","ALGORAND_ALGOD_PORT":"","ALGORAND_INDEXER_API":"https://testnet-idx.algonode.cloud/v2","ALGORAND_INDEXER_PORT":""}"

Via Smithery (for Cursor)

Simply run this command in terminal:

npx -y @smithery/cli@latest install @GoPlausible/algorand-mcp --client cursor --config "{"NFD_API_KEY":"","NFD_API_URL":"https://api.nf.domains","ALGORAND_ALGOD":"https://testnet-api.algonode.cloud","ALGORAND_TOKEN":"","ITEMS_PER_PAGE":"10","VESTIGE_API_KEY":"","VESTIGE_API_URL":"https://api.vestigelabs.org","ALGORAND_INDEXER":"https://testnet-idx.algonode.cloud","ALGORAND_NETWORK":"testnet","ALGORAND_ALGOD_API":"https://testnet-api.algonode.cloud/v2","ALGORAND_ALGOD_PORT":"","ALGORAND_INDEXER_API":"https://testnet-idx.algonode.cloud/v2","ALGORAND_INDEXER_PORT":""}"
IMPORTANT NOTE When using Smithery UI to copy the command, make sure you set ITEMS_PER_PAGE before clicking connect so that all ENV variables are brought to command, otherwise your command will not contain environment variables required for Algorand MCP to run!

Screenshot 2025-03-24 at 13 46 49

Screenshot 2025-03-24 at 13 46 42

Project Architecture

The project follows a modular architecture with two main packages:

  1. Server Package (@algorand-mcp/server)
  2. Provides MCP tools and resources
  3. Manages blockchain interactions
  4. Handles transaction creation and submission

  5. Offers comprehensive blockchain queries

  6. Client Package (@algorand-mcp/client)

  7. Handles wallet connections and transaction signing
  8. Supports both local and external wallets
  9. Universal compatibility (browser/Node.js)
  10. Secure credential management
  11. Still work in progress (Server works irrelevant to client status)

Project Structure

algorand-mcp/
├── packages/
│   ├── client/                    # Client Package
│   │   ├── src/
│   │   │   ├── index.ts          # Client entry point and wallet management
│   │   │   └── LocalWallet.ts    # Local wallet implementation
│   │   ├── package.json
│   │   └── tsconfig.json
│   └── server/                    # Server Package
│       ├── src/
│       │   ├── resources/         # MCP Resources
│       │   │   ├── algod/        # Real-time blockchain state
│       │   │   ├── indexer/      # Historical blockchain data
│       │   │   ├── nfd/          # NFDomains name service
│       │   │   ├── vestige/      # DeFi analytics and tracking
│       │   │   ├── tinyman/      # Tinyman AMM integration
│       │   │   └── ultrade/      # Ultrade DEX integration
│       │   ├── tools/            # MCP Tools
│       │   │   ├── accountManager.ts     # Account operations
│       │   │   ├── algodManager.ts       # Node interactions
│       │   │   ├── utilityManager.ts     # Utility functions
│       │   │   ├── resource_tools/       # Resource Tools
│       │   │   │   ├── algod/           # Algod resource tools
│       │   │   │   ├── indexer/         # Indexer resource tools
│       │   │   │   ├── nfd/            # NFDomains tools
│       │   │   │   ├── vestige/        # Vestige DeFi tools
│       │   │   │   ├── tinyman/        # Tinyman AMM tools
│       │   │   │   └── ultrade/        # Ultrade DEX tools
│       │   │   └── transactionManager/   # Transaction handling
│       │   ├── env.ts            # Environment configuration
│       │   └── index.ts          # Server entry point
│       ├── package.json
│       └── tsconfig.json
├── package.json                   # Root package file
└── tsconfig.json                 # Root TypeScript config

Core Functionalities

Server Features

  • Account management
  • Asset operations
  • Application interactions
  • Transaction creation and submission
  • Blockchain state queries
  • Comprehensive utility functions
  • Standardized response format
  • Built-in pagination support
  • NFDomains integration
  • Vestige DeFi analytics
  • Tinyman AMM integration
  • Ultrade DEX integration

Client Features (Work in Progress)

  • Local wallet with secure storage
  • External wallet support (Pera, Defly, Daffi)
  • Transaction signing
  • Session management
  • Universal ES module support

Response Format

All responses follow a standardized format:

{
  "data": {
    // Response data here
  },
  "metadata": {  // Only for paginated responses
    "totalItems": number,
    "itemsPerPage": number,
    "currentPage": number,
    "totalPages": number,
    "hasNextPage": boolean,
    "pageToken": string,
    "arrayField": string  // Name of paginated array field
  }
}

Errors are returned in a standardized format: 

{
  "error": {
    "code": string,
    "message": string
  }
}

Available Tools and Resources

The Algorand MCP implementation provides 125 tools and resources for blockchain interaction: - 40 base tools (account, asset, application, transaction management) - 30 resource tools (algod and indexer) - 6 NFDomains (NFD) tools for name services - 28 Vestige tools for DeFi analytics - 9 Tinyman tools for AMM interactions - 12 Ultrade tools for DEX functionality

Resource Tools

Algod Resource Tools

  • resource_algod_get_account_info: Get current account balance, assets, and auth address
  • resource_algod_get_account_application_info: Get account-specific application information
  • resource_algod_get_account_asset_info: Get account-specific asset information
  • resource_algod_get_application_by_id: Get application information
  • resource_algod_get_application_box: Get application box by name
  • resource_algod_get_application_boxes: Get all application boxes
  • resource_algod_get_asset_by_id: Get current asset information
  • resource_algod_get_pending_transaction: Get pending transaction information
  • resource_algod_get_pending_transactions_by_address: Get pending transactions for an address
  • resource_algod_get_pending_transactions: Get all pending transactions
  • resource_algod_get_transaction_params: Get suggested transaction parameters
  • resource_algod_get_node_status: Get current node status
  • resource_algod_get_node_status_after_block: Get node status after a specific round

Indexer Resource Tools

  • resource_indexer_lookup_account_by_id: Get account information
  • resource_indexer_lookup_account_assets: Get account assets
  • resource_indexer_lookup_account_app_local_states: Get account application local states
  • resource_indexer_lookup_account_created_applications: Get applications created by account
  • resource_indexer_search_for_accounts: Search for accounts with various criteria
  • resource_indexer_lookup_applications: Get application information
  • resource_indexer_lookup_application_logs: Get application log messages
  • resource_indexer_search_for_applications: Search for applications
  • resource_indexer_lookup_asset_by_id: Get asset information and configuration
  • resource_indexer_lookup_asset_balances: Get accounts holding this asset
  • resource_indexer_lookup_asset_transactions: Get transactions involving this asset
  • resource_indexer_search_for_assets: Search for assets
  • resource_indexer_lookup_transaction_by_id: Get transaction information
  • resource_indexer_lookup_account_transactions: Get account transaction history
  • resource_indexer_search_for_transactions: Search for transactions

NFDomains (NFD) Resource Tools

  • resource_nfd_get_nfd: Get NFD by name or application ID
  • resource_nfd_get_nfds_for_addresses: Get NFDs for specific addresses
  • resource_nfd_get_nfd_activity: Get activity/changes for NFDs
  • resource_nfd_get_nfd_analytics: Get analytics data for NFDs
  • resource_nfd_browse_nfds: Browse NFDs with various filters
  • resource_nfd_search_nfds: Search NFDs with various filters

Vestige Resource Tools

  1. View Tools:
  2. resource_vestige_view_networks: Get all networks
  3. resource_vestige_view_network_by_id: Get network by id
  4. resource_vestige_view_protocols: Get all protocols
  5. resource_vestige_view_protocol_by_id: Get protocol by id
  6. resource_vestige_view_protocol_volumes: Get protocol volumes at specific day
  7. resource_vestige_view_assets: Get data about assets
  8. resource_vestige_view_assets_list: Get asset list
  9. resource_vestige_view_assets_search: Search assets by query
  10. resource_vestige_view_asset_price: Get asset prices
  11. resource_vestige_view_asset_candles: Get asset candles
  12. resource_vestige_view_asset_history: Get asset volume, swaps, total lockup, vwap and confidence history
  13. resource_vestige_view_asset_composition: Get asset lockups based on protocol and pair
  14. resource_vestige_view_pools: Get pools
  15. resource_vestige_view_vaults: Get all vaults
  16. resource_vestige_view_balances: Get balances by network id, protocol id and asset id
  17. resource_vestige_view_notes: Get notes by network id and optionally asset id
  18. resource_vestige_view_first_asset_notes: Get first note for assets
  19. resource_vestige_view_asset_notes_count: Get notes count for assets

  20. resource_vestige_view_swaps: Get swaps

  21. Swap Tools:

  22. resource_vestige_get_best_v4_swap_data: Get best V4 swap data
  23. resource_vestige_get_v4_swap_discount: Get V4 swap discount
  24. resource_vestige_get_v4_swap_data_transactions: Get V4 swap data transactions

  25. resource_vestige_get_aggregator_stats: Get aggregator stats

  26. Currency Tools:

  27. resource_vestige_view_currency_prices: Get all latest currency prices
  28. resource_vestige_view_currency_price_history: Get currency prices by timestamp range
  29. resource_vestige_view_currency_price: Get currency price by timestamp
  30. resource_vestige_view_currency_average_price: Get average price for currency
  31. resource_vestige_view_currency_prices_simple_30d: Get currency prices for last 30 days

Tinyman Resource Tools

  • resource_tinyman_get_pool: Get Tinyman pool information by asset pair
  • resource_tinyman_get_pool_analytics: Get analytics for a Tinyman pool
  • resource_tinyman_get_pool_creation_quote: Get quote for creating a new pool
  • resource_tinyman_get_liquidity_quote: Get quote for adding liquidity
  • resource_tinyman_get_remove_liquidity_quote: Get quote for removing liquidity
  • resource_tinyman_get_swap_quote: Get quote for swapping assets
  • resource_tinyman_get_asset_optin_quote: Get quote for opting into pool token
  • resource_tinyman_get_validator_optin_quote: Get quote for opting into validator
  • resource_tinyman_get_validator_optout_quote: Get quote for opting out of validator

Ultrade Resource Tools

  1. Wallet Tools:
  2. resource_ultrade_wallet_signin_message: Generate message from the sign in data
  3. resource_ultrade_wallet_signin: Sign in to trading account
  4. resource_ultrade_wallet_add_key: Add a trading key
  5. resource_ultrade_wallet_revoke_key: Revoke a trading key
  6. resource_ultrade_wallet_keys: Get trading keys
  7. resource_ultrade_wallet_key_message: Generate message from the trading key data
  8. resource_ultrade_wallet_trades: Get filtered wallet trades
  9. resource_ultrade_wallet_transactions: Get filtered wallet transactions
  10. resource_ultrade_wallet_withdraw: Withdraw token

  11. resource_ultrade_wallet_withdraw_message: Generate message from the withdrawal data

  12. Market Tools:

  13. resource_ultrade_market_symbols: Get market symbols
  14. resource_ultrade_market_details: Get market details
  15. resource_ultrade_market_price: Get last market price by pair symbol
  16. resource_ultrade_market_depth: Get order book depth
  17. resource_ultrade_market_last_trades: Get last trades
  18. resource_ultrade_market_history: Get market history
  19. resource_ultrade_market_assets: Get trading assets
  20. resource_ultrade_market_fee_rates: Get fee rates
  21. resource_ultrade_market_chains: Get blockchain chains
  22. resource_ultrade_market_withdrawal_fee: Get withdrawal fee
  23. resource_ultrade_market_operation_details: Get operation details
  24. resource_ultrade_market_settings: Get market settings
  25. resource_ultrade_market_orders: Get orders
  26. resource_ultrade_market_open_orders: Get open orders
  27. resource_ultrade_market_order_by_id: Get order by ID
  28. resource_ultrade_market_order_message: Generate message from the order data
  29. resource_ultrade_market_create_order: Create new order
  30. resource_ultrade_market_create_orders: Create new orders
  31. resource_ultrade_market_cancel_order: Cancel open order

  32. resource_ultrade_market_cancel_orders: Cancel multiple open orders

  33. System Tools:

  34. resource_ultrade_system_time: Get current system time
  35. resource_ultrade_system_maintenance: Get system maintenance status
  36. resource_ultrade_system_version: Get system version

Account Management Tools

  • create_account: Create a new Algorand account
  • rekey_account: Rekey an account to a new address
  • validate_address: Check if an Algorand address is valid
  • encode_address: Encode a public key to an Algorand address
  • decode_address: Decode an Algorand address to a public key

Application Tools

  • make_app_create_txn: Create an application creation transaction
  • make_app_update_txn: Create an application update transaction
  • make_app_delete_txn: Create an application delete transaction
  • make_app_optin_txn: Create an application opt-in transaction
  • make_app_closeout_txn: Create an application close-out transaction
  • make_app_clear_txn: Create an application clear state transaction
  • make_app_call_txn: Create an application call transaction
  • get_application_address: Get the address for a given application ID
  • compile_teal: Compile TEAL source code
  • disassemble_teal: Disassemble TEAL bytecode back to source

Asset Tools

  • make_asset_create_txn: Create an asset creation transaction
  • make_asset_config_txn: Create an asset configuration transaction
  • make_asset_destroy_txn: Create an asset destroy transaction
  • make_asset_freeze_txn: Create an asset freeze transaction
  • make_asset_transfer_txn: Create an asset transfer transaction

Transaction Tools

  • send_raw_transaction: Submit signed transactions to the network
  • simulate_raw_transactions: Simulate raw transactions
  • simulate_transactions: Simulate transactions with detailed configuration
  • make_payment_txn: Create a payment transaction
  • assign_group_id: Assign a group ID to a list of transactions
  • sign_transaction: Sign a transaction with a secret key

Key Management Tools

  • mnemonic_to_mdk: Convert a mnemonic to a master derivation key
  • mdk_to_mnemonic: Convert a master derivation key to a mnemonic
  • secret_key_to_mnemonic: Convert a secret key to a mnemonic
  • mnemonic_to_secret_key: Convert a mnemonic to a secret key
  • seed_from_mnemonic: Generate a seed from a mnemonic
  • mnemonic_from_seed: Generate a mnemonic from a seed
  • sign_bytes: Sign arbitrary bytes with a secret key

Utility Tools

  • bytes_to_bigint: Convert bytes to a BigInt
  • bigint_to_bytes: Convert a BigInt to bytes
  • encode_uint64: Encode a uint64 to bytes
  • decode_uint64: Decode bytes to a uint64
  • generate_algorand_uri: Generate an Algorand URI and QR code according to ARC-26 specification

Dependencies

  • algosdk: Algorand JavaScript SDK
  • @perawallet/connect: Pera Wallet connector
  • @blockshake/defly-connect: Defly Wallet connector
  • @daffiwallet/connect: Daffi Wallet connector

License

MIT