Flow MCP

🚀 @outblock/flow-mcp

このパッケージは、Flowブロックチェーンのモデルコンテキストプロトコル（MCP）用のツールキットです。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: バグ修正（メジャーバージョンとマイナーバージョンは変更せず、パッチバージョンを増やす）
• BREAKING CHANGE: 破壊的な変更（メジャーバージョンを増やす）

バージョン管理

standard-versionを使用してバージョン管理を行います。

bun run release

npmへの公開

1. npmにログインします。

   npm login
   

2. プロジェクトをビルドします。

   bun run build
   

3. パッケージを公開します。

   npm publish
   

新しいバージョンを公開する前に、必ずbun run releaseを使用してバージョン番号を更新してください。

📄 ライセンス

MITライセンス - 詳細はLICENSEファイルを参照してください。

貢献

貢献を歓迎します！自由にPull Requestを送信してください。