@outblock/flow-mcp
モデルコンテキストプロトコル（MCP）用のFlowブロックチェーンツール。このパッケージは、モデルコンテキストプロトコルを介してFlowブロックチェーンとやり取りするためのツールセットを提供します。
特徴
- 任意のアドレスのFLOW残高を取得
- Flowトークンのトークン残高を取得する
- COAアカウント情報を取得する
- 契約のソースコードを取得する
- ストレージ統計を含む詳細なアカウント情報を取得します
インストール
# Using npm
npm install @outblock/flow-mcp
# Using 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
設定を追加したら、Claude を再起動して新しい MCP サーバーをロードします。
ツール
フローバランス
任意のアドレスの FLOW 残高を取得します。
{
name: 'get_flow_balance',
input: {
address: string,
network?: 'mainnet' | 'testnet'
}
}
アカウント情報
詳細なアカウント情報を取得します:
{
name: 'get_account_info',
input: {
address: string,
network?: 'mainnet' | 'testnet'
}
}
トークン残高
Flowトークンの残高を取得します:
{
name: 'get_token_balance',
input: {
address: string,
network?: 'mainnet' | 'testnet'
}
}
COAアカウント
COA アカウント情報を取得します:
{
name: 'get_coa_account',
input: {
address: string,
network?: 'mainnet' | 'testnet'
}
}
契約書を入手
契約のソースコードを取得します:
{
name: 'get_contract',
input: {
address: string,
contractName: string,
network?: 'mainnet' | 'testnet'
}
}
📂 プロジェクト構造
flow-mcp/
├── src/
│ ├── tools/ # MCP tools implementation
│ │ ├── flowBalance/ # Flow balance tool
│ │ ├── accountInfo/ # Account info tool
│ │ ├── tokenBalance/ # Token balance tool
│ │ ├── coaAccount/ # COA account tool
│ │ └── getContract/ # Contract source tool
│ ├── utils/ # Shared utilities
│ ├── prompts/ # MCP prompts
│ ├── types/ # Type definitions
│ └── bin/ # CLI implementation
├── biome.json # Linting configuration
├── tsconfig.json # TypeScript configuration
└── package.json # Project dependencies
🛠️ 開発
このプロジェクトでは、開発とテストにFastMCPを使用しています。FastMCPは、MCPサーバーに効率的な開発エクスペリエンスを提供します。
# Install dependencies
bun install
# Format code
bun run format
# Run tests
bun test
# Run development server
bun run dev
# Inspect the server
bun run inspect
# Build
bun run build
開発用 MCP サーバーを Claude Desktop に追加するには:
- プロジェクトをビルドします。
- Claude Desktop の設定に追加:
// You only need the argument if you need to pass arguments to your server
{
"mcpServers": {
"your-server-name": {
"command": "node",
"args": ["/path/to/your/project/dist/main.js", "some_argument"]
}
}
}
新しいツールの作成
このプロジェクトには、新しい MCP ツールの作成に役立つスクリプトが含まれています。
bun run scripts/create-tool.ts <tool-name>
これにより、次のようになります。
src/tools/<tool-name>の下に新しいツールディレクトリを作成します。- 以下を含む基本的なツール構造を生成します。
- index.ts (メイン実装)
- schema.ts (ツールパラメータのJSONスキーマ)
- test.ts (テストファイル)
- 新しいツールをエクスポートするためにツールのインデックスファイルを更新します
例：
bun run scripts/create-tool.ts weather
コミットメッセージの形式
feat : 新機能 (マイナーバージョンをアップグレード)fix ：バグ修正（パッチバージョンをアップグレード）BREAKING CHANGE : 破壊的変更 (メジャーバージョンを上げる)
📜 バージョン管理
このプロジェクトでは、自動バージョン管理のためにstandard-versionを使用しています。新しいバージョンを作成するには、 bun run releaseを実行してください。
📦 npm への公開
- npm にログインしていることを確認します。
- プロジェクトをビルドします。
- パッケージを公開します。
新しいバージョンを公開する前に、 bun run releaseを使用してバージョン番号を更新することを忘れないでください。
ライセンス
MIT ライセンス - 詳細についてはライセンスを参照してください。
貢献
貢献を歓迎します！お気軽にプルリクエストを送信してください。