Flow MCP 服务器

用于 Flow 区块链的模型上下文协议 (MCP) 服务器，具有直接 RPC 通信功能。

此服务器实现了模型上下文协议，并提供了通过 RPC 调用直接与 Flow 区块链交互的工具。

功能

• 获取账户余额（FLOW 和代币）
• 执行 Flow 脚本
• 发送交易
• 将域名解析为 Flow 地址
• 与 Flow 合约交互
• 完全符合 MCP 规范，可用于 AI 代理集成

设置

1. 克隆存储库：

   git clone https://github.com/lmcmz/flow-mcp-server.git
   cd flow-mcp-server
   

2. 安装依赖项：

   # 使用 npm
   npm install
   
   # 使用 Bun (推荐)
   bun install
   

3. (可选) 创建一个包含您的配置的 .env 文件：

   PORT=3000
   FLOW_NETWORK=testnet  # 可选：如果未指定，则默认为 'mainnet'
   

   服务器默认自动使用 Flow mainnet。 如果您想使用 testnet 或自定义端口，则只需配置环境。

用法

启动服务器

# 在开发模式下运行，具有热重载功能
bun dev

# 在生产模式下运行
bun start

# 构建服务器
bun run build

使用 NPX 命令

您可以使用 npx 直接运行 MCP 服务器，无需安装：

# 使用 npx 运行
npx flow-mcp-server

# 指定网络和端口
npx flow-mcp-server --network testnet --port 3001

# 获取所有选项的帮助
npx flow-mcp-server --help

或者全局安装它：

# 全局安装
npm install -g flow-mcp-server

# 运行全局安装的版本
flow-mcp-server

命令行选项

Options:
  -p, --port <port>          Port to run the server on (default: 3000)
  -n, --network <network>    Flow network to connect to (default: mainnet)
  -a, --access-node <url>    Custom Flow access node URL
  --stdio                    Run in stdio mode for direct integration
  -h, --help                 Show this help text

网络配置

服务器会自动配置 FCL，并为所选网络配置适当的合约地址。 支持以下网络：

Mainnet

mainnet 配置包括以下合约地址：

{
  NonFungibleToken: '0x1d7e57aa55817448',
  FungibleToken: '0xf233dcee88fe0abe',
  MetadataViews: '0x1d7e57aa55817448',
  NFTCatalog: '0x49a7cda3a1eecc29',
  NFTRetrieval: '0x49a7cda3a1eecc29',
  Find: '0x097bafa4e0b48eef',
  Flowns: '0x233eb012d34b0070',
  Domains: '0x233eb012d34b0070',
  FlowToken: '0x1654653399040a61',
  TransactionGeneration: '0xe52522745adf5c34',
  FlowFees: '0xf919ee77447b7497',
  StringUtils: '0xa340dc0a4ec828ab',
  HybridCustody: '0xd8a7e05a7ac670c0',
  ViewResolver: '0x1d7e57aa55817448'
}

Testnet

testnet 配置包括 testnet 环境的合约地址。

您还可以通过访问 /networks 端点来查看当前网络配置。

MCP 配置

要配置 AI 助手以使用 Flow MCP，请使用以下配置：

{
  "mcpServers": {
    "flow-mcp": {
      "command": "npx",
      "args": ["-y", "flow-mcp-server", "--stdio"],
      "env": {
        "FLOW_NETWORK": "mainnet"  // 可选：默认为 'mainnet'，可以设置为 'testnet'
      }
    }
  }
}

或者使用直接 HTTP API：

{
  "mcpServers": {
    "flow-mcp": {
      "serverUrl": "http://localhost:3000",
      "env": {
        "FLOW_NETWORK": "mainnet"
      }
    }
  }
}

与 AI 助手一起使用

该服务器实现了模型上下文协议，允许它与支持 MCP 的 AI 助手一起使用。 它公开了各种用于与 Flow 区块链交互的工具。

API 端点

• /sse - 用于实时通信的 SSE 端点
• /messages - 用于发送工具请求的端点
• /health - 健康检查端点
• / - 服务器信息
• /networks - 网络配置信息

可用工具

• get_flow_balance - 获取地址的 FLOW 余额
• get_token_balance - 获取地址的代币余额
• execute_script - 执行 Cadence 脚本
• send_transaction - 将签名的交易发送到 Flow 区块链
• resolve_domain - 将 .find 或 .fn 域名解析为 Flow 地址

发布到 npm

如果您想发布您自己的此软件包版本：

# 登录到 npm
npm login

# 发布软件包
npm publish

# 更新软件包
npm version patch  # 或 minor 或 major
npm publish

许可证

MIT