Lmcmz Flow MCP Server

🚀 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 AI assistants to access the Flow blockchain via a standardized interface. You can quickly start using it through the following methods:

Using npx (Recommended)

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

Or specify the port for HTTP mode:

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

✨ Features

• Check Flow and fungible token balances.
• Resolve .find and .fn domain names.
• Execute scripts to read blockchain data.
• Submit and monitor transactions.
• Retrieve account information.
• Configure the Flow network via environment variables.

📦 Installation

Using npx (Recommended)

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

Or specify the port for HTTP mode:

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

# Run in stdio mode (for AI assistant integration)
npx -y @outblock/flow-mcp-server --stdio

# Run in HTTP server mode on port 3000
npx -y @outblock/flow-mcp-server --port 3000

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

Running the Local Development Server

# Run in stdio mode
npm run build
npm start

# Run in HTTP server mode on port 3000
npm run build
PORT=3000 npm start

# Use auto-reload during development
npm run dev

📚 Documentation

Configuration

The server can be configured via environment variables:

• PORT - The HTTP port to listen on (defaults to stdio mode if not set).
• FLOW_NETWORK - The Flow network to connect to (mainnet, testnet, emulator).
• FLOW_ACCESS_NODE - A custom Flow access node URL.
• LOG_LEVEL - The logging level (debug, info, warn, error).

Integration with AI Assistants

When integrating the server with an AI assistant (e.g., Claude), you can start the MCP server in stdio 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 endpoint for sending tool requests.
• /health - Health check endpoint.
• / - Server information.

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 - Retrieve account information.
• execute_transaction - Submit and monitor transactions.
• resolve_domain - Resolve .find and .fn domain names.

Version History

• 1.0.0 - Initial release.
• 1.1.0 - Fixed the formatArguments import issue in the transaction service.