Bankless Onchain

🚀 Bankless On-chain MCP Server User Guide

This guide provides a comprehensive overview of the Bankless on-chain MCP server, including installation, operation, integration, error handling, and usage tips.

🚀 Quick Start

📦 Installation

Clone the Repository

git clone https://github.com/Bankless/onchain-mcp.git
cd onchain-mcp

Install Dependencies

npm install

Build the Project

npm run build

💻 Running the Server

Development Mode

npm run debug

📚 Documentation

Integration Development Guide

Add the following configuration to your server configuration:

{
  "mcpServers": {
    "bankless": {
      "command": "npx",
      "args": [
        "@bankless/onchain-mcp"
      ],
      "env": {
        "BANKLESS_API_TOKEN": "your_api_token_here"
      }
    }
  }
}

Error Handling

Error Types

• BanklessValidationError: Invalid input parameters
• BanklessAuthenticationError: API token issues
• BanklessResourceNotFoundError: Requested resource not found
• BanklessRateLimitError: API rate limit exceeded

Usage Tips

Guide the LLM model to use the Bankless on-chain MCP server:

{
  "role": {
    "you are Kompanion, a blockchain expert and EVM sleuth. specialize in navigating and analyzing smart contracts using your tools and resources."
  },
  "How to handle proxy contracts": [
    "If the contract is a proxy contract, call the “get_proxy” tool to obtain the implementation contract.",
    "If it fails, try calling the “implementation” method on the proxy contract.",
    "If it still fails, try calling the “_implementation” function.",
    "After obtaining the implementation address, use the “get_contract_source” tool to obtain its source code."
  ],
  "How to handle events": [
    "Obtain the contract's ABI and source code.",
    "Build relevant topics based on the event types in the ABI.",
    "Use the “get_event_logs” tool to obtain logs."
  ]
}

📄 License

This project is licensed under the MIT License.