MCP 服务器

Flow MCP

提供与 Flow 区块链交互的工具，包括 Flow 余额检查、代币余额查询和 Cadence 拥有的账户信息检索。

README

Flow MCP

用于模型上下文协议 (MCP) 的 Flow 区块链工具。此 MCP 服务器提供与 Flow 区块链交互的工具，包括：

Flow 余额检查
Token 余额查询
COA (Cadence Owned Account) 信息检索

特性

实时 Flow 区块链交互
支持主网和测试网
使用 Zod 的类型安全工具定义
全面的测试覆盖
使用 Bun 构建，以获得最佳性能

安装

# 使用 bun
bun install flow-mcp

# 使用 npm
npm install flow-mcp

# 使用 yarn
yarn add flow-mcp

用法

import { McpServer } from '@modelcontextprotocol/sdk/server/mcp';
import { flowBalanceTool, tokenBalanceTool, coaAccountTool } from 'flow-mcp';

const server = new McpServer({
  name: "flow-mcp",
  version: "1.0.0"
}, {
  capabilities: {
    tools: {
      flowBalanceTool,
      tokenBalanceTool,
      coaAccountTool
    }
  }
});

server.start();

可用工具

Flow 余额工具

获取任何 Flow 地址的 FLOW token 余额：

const result = await flowBalanceTool.handler({
  address: "0x1234...",
  network: "mainnet"
});

Token 余额工具

获取 Flow 地址的任何可替代 token 的余额：

const result = await tokenBalanceTool.handler({
  address: "0x1234...",
  network: "mainnet",
  tokenIdentifier: "A.1654653399040a61.FlowToken.Vault"
});

COA 账户工具

获取 Flow 地址的 Cadence Owned Account 信息：

const result = await coaAccountTool.handler({
  address: "0x1234...",
  network: "mainnet",
  include_evm_address: true
});

开发

# 安装依赖
bun install

# 运行测试
bun test

# 构建项目
bun run build

# 启动服务器
bun start

贡献

欢迎贡献！请随时提交 Pull Request。

许可证

MIT 许可证

🚀 快速开始

克隆存储库
安装依赖：
```
bun install
```

✨ 主要特性

Bun 用于快速测试和开发
Biome 用于 linting 和格式化
使用 standard-version 自动进行版本管理
干净、可维护的项目结构

📂 项目结构

mcp-starter/
├── src/
│   ├── tools/          # MCP 工具实现
│   ├── utils/          # 共享实用程序
│   ├── main.ts         # 服务器入口点
│   └── types.ts        # 共享类型定义
├── tests/              # 测试文件
├── biome.json          # Linting 配置
├── tsconfig.json       # TypeScript 配置
└── package.json        # 项目依赖

⚙️ 配置

创建新工具

该项目包含一个脚本，可帮助创建新的 MCP 工具：

bun run scripts/create-tool.ts <tool-name>

这将：

在 src/tools/<tool-name> 下创建一个新的工具目录
生成基本工具结构，包括：
- index.ts (主要实现)
- schema.ts (工具参数的 JSON schema)
- test.ts (测试文件)
更新工具索引文件以导出新工具

示例：

bun run scripts/create-tool.ts weather

🛠️ 开发

运行测试: bun test
格式化代码: bun run format
Lint 代码: bun run lint
构建项目: bun run build

要将您的开发 MCP 服务器添加到 Claude Desktop：

构建项目：
```
bun run build
```

添加到您的 Claude Desktop 配置：

// 如果您需要将参数传递给您的服务器，您才需要该参数
{
  "mcpServers": {
    "your-server-name": {
      "command": "node",
      "args": ["/path/to/your/project/dist/main.js", "some_argument"]
    }
  }
}

📜 版本管理

本项目使用 standard-version 进行自动版本管理。运行 bun run release 创建一个新版本。

Commit Message 格式

feat: 新功能 (增加 minor 版本)
fix: Bug 修复 (增加 patch 版本)
BREAKING CHANGE: 破坏性更改 (增加 major 版本)

📦 发布到 npm

确保您已登录到 npm：
```
npm login
```
构建项目：
```
bun run build
```
发布包：
```
npm publish
```

请记住在使用 bun run release 更新版本号后再发布新版本。

从 npm 安装 (发布后)

添加到您的 Claude Desktop 配置：

// 如果您需要将参数传递给您的服务器，您才需要该参数
{
  "mcpServers": {
    "your-server-name": {
      "command": "npx",
      "args": ["-y", "your-package-name", "some_argument"]
    }
  }
}