MCP Clusters API Server

by ayv8er

Integrations

  • Used for loading environment variables from a .env file to configure the MCP server with API keys.

  • Provides schema validation for the MCP server's request and response data, ensuring type safety for the Clusters API.

MCP Server - Clusters API v1

This is a Model Context Protocol (MCP) server implementation for the Clusters API v1. It provides endpoints for authentication, cluster management, name registration, and more.

Dependencies

{ "@modelcontextprotocol/sdk": "^1.7.0", "dotenv": "^16.4.7", "zod": "^3.24.2" }

Setup

  1. Install dependencies:
npm install
  1. Create a .env file with: CLUSTERS_API_KEY={CLUSTERS_API_KEY}
  2. Build and start the server:
npm run dev

Testing Endpoints

Since this server uses StdioServerTransport, you'll need to send JSON-RPC messages through stdin. Here are example commands for testing each endpoint:

Authentication Endpoints

Get Message
echo '{"jsonrpc":"2.0","id":1,"method":"auth_get_message","params":{"address":"0x123...","chainId":1,"nonce":"abc123"}}' | node dist/index.js
Get Token
echo '{"jsonrpc":"2.0","id":1,"method":"auth_get_token","params":{"signature":"0x123...","signingDate":"2024-03-21","type":"evm","wallet":"0x123..."}}' | node dist/index.js
Validate Token
echo '{"jsonrpc":"2.0","id":1,"method":"auth_validate_token","params":{"authKey":"your-auth-key"}}' | node dist/index.js

Cluster Management Endpoints

Create Cluster
echo '{"jsonrpc":"2.0","id":1,"method":"create_cluster","params":{"wallets":[{"address":"0x123...","name":"MyWallet","isPrivate":false}],"authKey":"your-auth-key","testnet":false}}' | node dist/index.js
Get Cluster by ID
echo '{"jsonrpc":"2.0","id":1,"method":"get_cluster_by_id","params":{"id":"cluster-id","testnet":false}}' | node dist/index.js
Get Cluster by Name
echo '{"jsonrpc":"2.0","id":1,"method":"get_cluster_by_name","params":{"name":"cluster-name","testnet":false}}' | node dist/index.js
Get Cluster ID by Address
echo '{"jsonrpc":"2.0","id":1,"method":"get_cluster_id_by_address","params":{"address":"0x123...","testnet":false}}' | node dist/index.js
Add Wallets
echo '{"jsonrpc":"2.0","id":1,"method":"add_wallets","params":{"wallets":[{"address":"0x123...","name":"NewWallet","isPrivate":false}],"authKey":"your-auth-key","testnet":false}}' | node dist/index.js
Generate Wallet
echo '{"jsonrpc":"2.0","id":1,"method":"generate_wallet","params":{"type":"evm","name":"NewWallet","isPrivate":false,"authKey":"your-auth-key","testnet":false}}' | node dist/index.js
Update Wallets
echo '{"jsonrpc":"2.0","id":1,"method":"update_wallets","params":{"wallets":[{"address":"0x123...","name":"UpdatedName"}],"authKey":"your-auth-key","testnet":false}}' | node dist/index.js
Remove Wallets
echo '{"jsonrpc":"2.0","id":1,"method":"remove_wallets","params":{"addresses":["0x123..."],"authKey":"your-auth-key","testnet":false}}' | node dist/index.js
Verify Wallet
echo '{"jsonrpc":"2.0","id":1,"method":"verify_wallet","params":{"clusterId":"cluster-id","authKey":"your-auth-key","testnet":false}}' | node dist/index.js

Address ↔ Name Resolution Endpoints

Get Data by Address
echo '{"jsonrpc":"2.0","id":1,"method":"get_data_by_address","params":{"address":"0x123...","testnet":false}}' | node dist/index.js
Get Bulk Data by Addresses
echo '{"jsonrpc":"2.0","id":1,"method":"get_bulk_data_by_addresses","params":{"addresses":["0x123...","0x456..."],"testnet":false}}' | node dist/index.js
Get Bulk Data by Names
echo '{"jsonrpc":"2.0","id":1,"method":"get_bulk_data_by_names","params":{"names":[{"name":"name1"}],"testnet":false}}' | node dist/index.js

Registration Endpoints

Check Name Availability
echo '{"jsonrpc":"2.0","id":1,"method":"check_name_availability","params":{"names":["name1","name2"]}}' | node dist/index.js
Get Registration Sign Data
echo '{"jsonrpc":"2.0","id":1,"method":"get_registration_sign_data","params":{"network":"1","sender":"0x123...","names":[{"name":"name1","amountWei":"1000000000000000000"}],"referralClusterId":"optional-id","testnet":false}}' | node dist/index.js
Get Transaction Status
echo '{"jsonrpc":"2.0","id":1,"method":"get_transaction_status","params":{"txHash":"0x123..."}}' | node dist/index.js

Notes

  1. Replace placeholder values (like 0x123..., your-auth-key, etc.) with actual values
  2. The testnet parameter is optional for most endpoints
  3. All responses will be JSON-RPC 2.0 formatted
  4. For authenticated endpoints, make sure to obtain and include a valid authKey
  5. The server uses environment variables for configuration, ensure your .env file is properly set up

Alternative Testing Method

For easier testing, you could modify the server to use HTTP transport instead of stdio. This would allow you to use curl commands instead of echo pipes. Let me know if you'd like to switch to HTTP transport.

You must be authenticated.

A
security – no known vulnerabilities
F
license - not found
A
quality - confirmed to work

A Model Context Protocol server implementation that provides endpoints for wallet-based authentication, cluster management, and name registration services.

  1. Dependencies
    1. Setup
      1. Testing Endpoints
        1. Authentication Endpoints
        2. Cluster Management Endpoints
        3. Address ↔ Name Resolution Endpoints
        4. Registration Endpoints
      2. Notes
        1. Alternative Testing Method

          Related MCP Servers

          • A
            security
            F
            license
            A
            quality
            A Model Context Protocol server implementation for interacting with Salesforce through its REST API.
            Last updated -
            4
            10
            TypeScript
          • A
            security
            F
            license
            A
            quality
            A Model Context Protocol server that provides tools to manage Keycloak users and realms, allowing you to create and delete users, list available realms, and view users in specific realms.
            Last updated -
            4
            36
            12
            TypeScript
          • A
            security
            A
            license
            A
            quality
            A Model Context Protocol server that provides tools for managing providers, clients, tenants, and access tokens through the UseGrant platform.
            Last updated -
            26
            116
            JavaScript
            MIT License
          • A
            security
            A
            license
            A
            quality
            A Model Context Protocol server providing utility tools for development and testing, offering functionalities like personalized greetings, random card drawing, and datetime formatting with an extensible architecture.
            Last updated -
            19
            167
            2
            TypeScript
            MIT License
            • Apple
            • Linux

          View all related MCP servers

          ID: 5wgvkpscux