Flow Blockchain

by lmcmz

1 stars
375 downloads
Not rated
GitHub

About

Integrates with the Flow blockchain to enable direct querying of account balances, domain resolution, and transaction execution through RPC communication for seamless blockchain data access and operations.

Details

Author
lmcmz
Repository
lmcmz/flow-mcp-server
GitHub stars
1
Downloads
375
Categories
Productivity, Developer Tools, Design, AI, Search, Automation, Frontend, Infrastructure, Other

- Balance checking for Flow and fungible tokens
- Domain resolution for .find and .fn domains
- Script execution for reading blockchain data
- Transaction submission and monitoring
- Account information retrieval
- Flow configuration based on environment variables

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name Flow Blockchain
    Command (node, npx, python, etc.) npx
    Arguments
    • Argument 1 -y
    • Argument 2 @highlight/mcp-server

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

The server can be configured using environment variables:

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

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

bash

get_balance

Get Flow balance for an address. Parameters: address (string), network (string)

get_token_balance

Get fungible token balance. Parameters: address (string), token (string), network (string)

get_account

Get account information. Parameters: address (string)

resolve_domain

Resolve a .find or .fn domain to an address. Parameters: domain (string)

execute_script

Execute a Cadence script. Parameters: script (string), args (optional array)

send_transaction

Send a transaction to the blockchain. Parameters: transaction (object)

get_transaction

Get transaction details by ID. Parameters: transaction_id (string)

- get_balance - Get Flow balance for an address
- get_token_balance - Get fungible token balance
- get_account - Get account information
- resolve_domain - Resolve a .find or .fn domain to an address
- execute_script - Execute a Cadence script
- send_transaction - Send a transaction to the blockchain
- get_transaction - Get transaction details by ID

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "flow blockchain": {
            "env": {},
            "args": [
                "-y",
                "@highlight/mcp-server"
            ],
            "command": "npx"
        }
    }
}

Linux

{
    "env": [],
    "args": [
        "-y",
        "@highlight/mcp-server"
    ],
    "command": "npx"
}

Macos

{
    "env": [],
    "args": [
        "-y",
        "@highlight/mcp-server"
    ],
    "command": "npx"
}

Windows

{
    "env": [],
    "args": [
        "/c",
        "npx",
        "-y",
        "@highlight/mcp-server"
    ],
    "command": "cmd"
}

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.

Features

- Balance checking for Flow and fungible tokens
- Domain resolution for .find and .fn domains
- Script execution for reading blockchain data
- Transaction submission and monitoring
- Account information retrieval
- Flow configuration based on environment variables

Installation

Using npx (Recommended)

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

Or specify HTTP mode with a 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

Running with npx

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

Run as HTTP server on port 3000

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

Specify Flow network

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

Running Local Development Server

# Run in stdio mode
npm run build
npm start

Run as HTTP server on port 3000

npm run build PORT=3000 npm start

For development with auto-reload

npm run dev

Configuration

The server can be configured using environment variables:

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

Using with AI Assistants

When integrating with AI assistants like Claude, you can start the MCP server in stdio mode and connect it to your 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 Flow balance for an address
- get_token_balance - Get fungible token balance
- get_account - Get account information
- resolve_domain - Resolve a .find or .fn domain to an address
- execute_script - Execute a Cadence script
- send_transaction - Send a transaction to the blockchain
- get_transaction - Get transaction details by ID

Version History

- v0.1.1 - Bug fix for formatArguments import issue in transaction service
- v0.1.0 - Initial release with basic Flow blockchain integration

License

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.