Flow MCP

🚀 @outblock/flow-mcp

A toolkit for interacting with the Flow blockchain in the context of the Model Context Protocol (MCP). This package provides a set of tools to interact with the Flow blockchain.

✨ Features

• Get the FLOW balance of any address.
• Get the balance of any Flow token.
• Retrieve COA account information.
• Fetch the source code of contracts.
• Obtain detailed account information, including storage statistics.

📦 Installation

# Using npm
npm install @outblock/flow-mcp

# Using bun
bun add @outblock/flow-mcp

💻 MCP Configuration

To use this tool with Claude, add the following to your MCP configuration:

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

You can find the MCP configuration file at the following locations:

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

💻 Usage Examples

Basic Usage

Get FLOW Balance

export interface GetFlowBalanceParams {
  address: string;
}

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

Get Token Balance

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

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

Transfer

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

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

📚 Documentation

Project Structure

flow-mcp/
├── src/
│   ├── index.ts          # Main entry file
│   ├── utils/           # Utility functions
│   │   └── balance.ts    # Logic for handling balances
│   ├── types/           # Type and interface definitions
│   │   └── types.ts      # Contains definitions like Balance, TokenBalance
│   └── transactions/    # Transaction handling logic
│       └── transfer.ts   # Logic for handling transfers
├── package.json         # Project dependencies and configuration
└── README.md            # Project documentation

Development

# Install dependencies
bun install

# Format code
bun run format

# Run tests
bun test

# Commit code
git add .
git commit -m "feat: new feature"

Create a New Tool

Use the script to create a new tool:

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

Commit Message Format

• feat: New features (increment the minor version, keep the major version unchanged).
• fix: Bug fixes (increment the patch version, keep the major and minor versions unchanged).
• BREAKING CHANGE: Breaking changes (increment the major version).

Version Management

Use standard-version for version management:

bun run release

Publish to npm

1. Log in to npm:

   npm login
   

2. Build the project:

   bun run build
   

3. Publish the package:

   npm publish
   

Make sure to update the version number using bun run release before publishing a new version.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

💪 Contribution

Contributions are welcome! Please feel free to submit a Pull Request.