Flow Blockchain

🚀 Flow MCP Server

A Model Context Protocol (MCP) server for interacting with the Flow blockchain. This server enables AI assistants to access Flow blockchain data and perform operations through a standardized interface.

🚀 Quick Start

The Flow MCP Server allows seamless interaction with the Flow blockchain, providing a standardized interface for AI assistants to access data and execute operations.

✨ Features

• Balance Inquiry: Supports checking balances of Flow and fungible tokens.
• Domain Name Resolution: Supports resolution of .find and .fn domain names.
• Script Execution: Used for reading blockchain data.
• Transaction Submission and Monitoring: Supports transaction submission and status tracking.
• Account Information Query: Retrieves account-related information.
• Environment Configuration: Dynamically adjusts Flow network configuration based on environment variables.

📦 Installation

Using npx (Recommended)

npx -y @outblock/flow-mcp-server --stdio

Or specify the HTTP mode and port:

npx -y @outblock/flow-mcp-server --port 3000

Local Installation (For Development)

git clone https://github.com/lmcmz/flow-mcp-server.git
cd flow-mcp-server
npm install
npm run build
npm start

💻 Usage Examples

Running with npx

# Standard input-output mode (Suitable for AI assistant integration)
npx -y @outblock/flow-mcp-server --stdio

# Run as an HTTP server on port 3000 by default
npx -y @outblock/flow-mcp-server --port 3000

# Specify the Flow network environment
npx -y @outblock/flow-mcp-server --port 3000 --network testnet

Running a Local Development Server

# Standard input-output mode
npm run build
npm start

# Run as an HTTP server on a specified port
npm run build
PORT=3000 npm start

# Automatic reload function in the development environment
npm run dev

📚 Documentation

Configuration Options

The server can be configured via environment variables:

• PORT - The default HTTP port to listen on (If not set, defaults to standard input-output mode).
• FLOW_NETWORK - The Flow network environment to connect to (Mainnet, Testnet, Simulator).
• FLOW_ACCESS_NODE - Custom Flow access node URL.
• LOG_LEVEL - Logging level (Debug, Info, Warning, Error).

Integration with AI Assistants

When integrating with an AI assistant (e.g., Claude), start the MCP server in standard input-output mode and connect it to the assistant's tool configuration.

Example Claude tool configuration:

{
  "tools": [
    {
      "name": "flow-mcp-server",
      "command": "npx -y @outblock/flow-mcp-server --stdio"
    }
  ]
}

HTTP API Endpoints

When running in HTTP mode, the following endpoints are available:

• /sse - Server-Sent Events endpoint for real-time updates.
• /messages - POST request for sending tool requests.
• /health - Health check endpoint.
• / - Server information endpoint.

Example HTTP API call:

curl -X POST http://localhost:3000/messages \
  -H "Content-Type: application/json" \
  -d '{
    "tool_request": {
      "name": "get_balance",
      "parameters": {
        "address": "0x2d4c3caffbeab845",
        "network": "mainnet"
      }
    }
  }'

Available Tools

• get_balance - Get the Flow balance of an address.
• get_token_balance - Get the fungible token balance.
• get_account - Get account information.
• resolve_domain - Resolve a .find or .fn domain name to an address.
• execute_script - Execute a blockchain data reading script.
• submit_transaction - Submit a transaction and monitor its status.

📄 License

Version History

• 1.0.0: Initial version released.