Flow MCP

🚀 @outblock/flow-mcp

@outblock/flow-mcp 是一個Flow區塊鏈工具包，專門用於模型上下文協議（MCP）。此工具包提供了一系列與Flow區塊鏈交互的實用工具，能幫助開發者輕鬆實現多種功能。

🚀 快速開始

本工具包提供了與Flow區塊鏈交互的能力，可用於獲取賬戶餘額、合約代碼等信息，還支持轉賬等操作。

✨ 主要特性

• 獲取任意地址的FLOW餘額
• 獲取任意Flow代幣的餘額
• 獲取COA賬戶信息
• 獲取合約源代碼
• 獲取詳細的賬戶信息，包括存儲統計信息

📦 安裝指南

你可以使用以下命令進行安裝：

# 使用npm
npm install @outblock/flow-mcp

# 使用bun
bun add @outblock/flow-mcp

💻 使用示例

基礎用法

MCP配置

要與Claude一起使用此工具，請將以下內容添加到MCP配置中：

{
  "mcpServers": {
    "flow": {
      "command": "npx",
      "args": ["-y", "@outblock/flow-mcp"]
    }
  }
}

你可以在以下位置找到MCP配置文件：

• macOS: ~/Library/Application Support/Claude/mcp.json
• Windows: %APPDATA%/Claude/mcp.json
• Linux: ~/.config/Claude/mcp.json

工具使用

獲取FLOW餘額

export interface GetFlowBalanceParams {
  address: string;
}

export async function getFlowBalance(params: GetFlowBalanceParams): Promise<Balance>;

獲取代幣餘額

export interface GetTokenBalanceParams {
  address: string;
  tokenAddress: string;
}

export async function getTokenBalance(params: GetTokenBalanceParams): Promise<TokenBalance>;

轉賬

export interface TransferParams {
  from: string;
  to: string;
  amount: number;
}

export async function transfer(params: TransferParams): Promise<TransactionReceipt>;

📚 詳細文檔

項目結構

flow-mcp/
├── src/
│   ├── index.ts          # 主入口文件
│   ├── utils/           # 工具函數
│   │   └── balance.ts    # 處理餘額相關邏輯
│   ├── types/           # 定義類型和接口
│   │   └── types.ts      # 包含Balance、TokenBalance等類型定義
│   └── transactions/    # 交易處理邏輯
│       └── transfer.ts   # 處理轉賬事務
├── package.json         # 項目依賴和配置
└── README.md            # 項目文檔

開發

# 安裝依賴
bun install

# 格式化代碼
bun run format

# 運行測試
bun test

# 提交代碼
git add .
git commit -m "feat: 新功能"

創建新工具

使用腳本創建新工具：

bun run scripts/create-tool.ts new-feature

提交信息格式

• feat: 新功能（主版本號不變，次版本號遞增）
• fix: 修復bug（主版本號和次版本號都不變，補丁版本號遞增）
• BREAKING CHANGE: 破壞性更改（主版本號遞增）

版本管理

使用standard-version進行版本管理：

bun run release

發佈到npm

1. 登錄npm：

   npm login
   

2. 構建項目：

   bun run build
   

3. 發佈包：

   npm publish
   

請確保在發佈新版本之前使用bun run release更新版本號。

📄 許可證

本項目採用MIT License，詳情請參閱LICENSE文件。

貢獻

歡迎貢獻！請隨意提交Pull Request。