Hashkey MCP Server 🔵

!OpenRouter Integration

A Model Context Protocol (MCP) server that provides onchain tools for AI applications like Claude Desktop and Cursor, allowing them to interact with the Hashkey Network.

Extending Hashkey MCP with 3P Protocols, Tools, and Data Sources

Hashkey MCP is designed to be extensible, allowing you to add your own third-party protocols, tools, and data sources. This section provides an overview of how to extend the Hashkey MCP server with new capabilities.

Adding New Tools

If you want to add a new tool to the Hashkey MCP server, follow these steps:

1. Create a new directory in the src/tools directory for your tool
2. Implement the tool following the existing patterns:
   • index.ts: Define and export your tools
   • schemas.ts: Define input schemas for your tools
   • handlers.ts: Implement the functionality of your tools
3. Add your tool to the list of available tools in src/tools/index.ts
4. Add documentation for your tool in the README.md
5. Add examples of how to use your tool in examples.md
6. Write tests for your tool

Project Structure

The Hashkey MCP server follows this structure for tools:

src/
├── tools/
│   ├── index.ts (exports toolsets)
│   ├── [TOOL_NAME]/  Settings > Developer > Edit Config.

2. Add the following configuration:

   ```json
   {
     "mcpServers": {
       "hashkey-mcp": {
         "command": "npx",
         "args": ["-y", "hashkey-mcp@latest"],
         "env": {
           "COINBASE_API_KEY_NAME": "your_api_key_name",
           "COINBASE_API_PRIVATE_KEY": "your_private_key",
           "SEED_PHRASE": "your seed phrase here",
           "COINBASE_PROJECT_ID": "your_project_id",
           "ALCHEMY_API_KEY": "your_alchemy_api_key",
           "PINATA_JWT": "your_pinata_jwt",
           "OPENROUTER_API_KEY": "your_openrouter_api_key",
           "CHAIN_ID": "177"
         },
         "disabled": false,
         "autoApprove": []
       }
     }
   }

3. Restart Claude Desktop for the changes to take effect.

Available Tools

get-address

Retrieves the address for your wallet.

Example query to Claude:

list-balances

Lists all balances for your wallet.

Example query to Claude:

transfer-funds

Transfers funds from your wallet to another address.

Parameters:

• destination: The address to which to transfer funds
• assetId: The asset ID to transfer
• amount: The amount of funds to transfer

Example query to Claude:

deploy-contract

Deploys a smart contract to the blockchain.

Parameters:

• constructorArgs: The arguments for the contract constructor
• contractName: The name of the contract to deploy
• solidityInputJson: The JSON input for the Solidity compiler containing contract source and settings
• solidityVersion: The version of the solidity compiler

Example query to Claude:

check-address-reputation

Checks the reputation of an address.

Parameters:

• address: The Ethereum address to check

Example query to Claude:

get_morpho_vaults

Gets the vaults for a given asset on Morpho.

Parameters:

• assetSymbol: Asset symbol by which to filter vaults (optional)

Example query to Claude:

call_contract

Calls a contract function on the blockchain.

Parameters:

• contractAddress: The address of the contract to call
• functionName: The name of the function to call
• functionArgs: The arguments to pass to the function
• abi: The ABI of the contract
• value: The value of ETH to send with the transaction (optional)

Example query to Claude:

get_onramp_assets

Gets the assets available for onramping in a given country/subdivision.

Parameters:

• country: ISO 3166-1 two-digit country code string representing the purchasing user's country of residence
• subdivision: ISO 3166-2 two-digit country subdivision code (required for US)

Example query to Claude:

onramp

Gets a URL for onramping funds via Coinbase.

Parameters:

• amountUsd: The amount of funds to onramp
• assetId: The asset ID to onramp

Example query to Claude:

erc20_balance

Gets the balance of an ERC20 token.

Parameters:

• contractAddress: The address of the ERC20 contract

Example query to Claude:

erc20_transfer

Transfers an ERC20 token to another address.

Parameters:

• contractAddress: The address of the ERC20 contract
• toAddress: The address of the recipient
• amount: The amount of tokens to transfer

Example query to Claude:

list_nfts

Lists NFTs owned by a specific address.

Parameters:

• ownerAddress: The address of the owner whose NFTs to list
• limit: Maximum number of NFTs to return (default: 50)

Example query to Claude:

transfer_nft

Transfers an NFT to another address. Supports both ERC721 and ERC1155 standards.

Parameters:

• contractAddress: The address of the NFT contract
• tokenId: The token ID of the NFT to transfer
• toAddress: The address of the recipient
• amount: The amount to transfer (only used for ERC1155, default: 1)

Example query to Claude:

buy_openrouter_credits

Buys OpenRouter credits with USDC.

Parameters:

• amountUsd: The amount of credits to buy, in USD

Example query to Claude:

Security Considerations

• The configuration file contains sensitive information (API keys and seed phrases). Ensure it's properly secured and not shared.
• Consider using environment variables or a secure credential manager instead of hardcoding sensitive information.
• Be cautious when transferring funds or deploying contracts, as these operations are irreversible on the blockchain.
• When using the onramp functionality, ensure you're on a secure connection.
• Verify all transaction details before confirming, especially when transferring funds or buying credits.

Troubleshooting

If you encounter issues:

1. Check that your Coinbase API credentials are correct
2. Verify that your seed phrase is valid
3. Ensure you're on the correct network (Hashkey Mainnet)
4. Check the Claude Desktop logs for any error messages

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

For detailed guidelines on contributing to Hashkey MCP, including:

• Reporting bugs
• Suggesting enhancements
• Development setup
• Coding standards
• Adding new tools, protocols, and data sources (see also the Extending Hashkey MCP section above)
• Testing requirements
• Documentation standards

Please refer to our comprehensive CONTRIBUTING.md guide.

Basic contribution steps:

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Please make sure your code follows the existing style and includes appropriate tests.

Shared threads will appear here, showcasing real-world applications and insights from the community. Check back soon for updates!