@outblock/flow-mcp

Name: Flow MCP
Author: Outblock

Flow-Blockchain-Tools für das Model Context Protocol (MCP). Dieses Paket bietet eine Reihe von Tools für die Interaktion mit der Flow-Blockchain über das Model Context Protocol.

Merkmale

Erhalten Sie das FLOW-Guthaben für jede Adresse
Erhalten Sie das Token-Guthaben für jedes Flow-Token
COA-Kontoinformationen abrufen
Vertragsquellcode abrufen
Erhalten Sie detaillierte Kontoinformationen einschließlich Speicherstatistiken

Related MCP server: MCP Etherscan Server

Installation

# Using npm
npm install @outblock/flow-mcp

# Using bun
bun add @outblock/flow-mcp

MCP-Konfiguration

Um dieses Tool mit Claude zu verwenden, fügen Sie Ihrer MCP-Konfiguration Folgendes hinzu:

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

Ihre MCP-Konfiguration finden Sie unter:

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

Starten Sie Claude nach dem Hinzufügen der Konfiguration neu, um den neuen MCP-Server zu laden.

Werkzeuge

Durchflussbilanz

Erhalten Sie den FLOW-Saldo für jede Adresse:

{
  name: 'get_flow_balance',
  input: {
    address: string,
    network?: 'mainnet' | 'testnet'
  }
}

Kontoinformationen

Erhalten Sie detaillierte Kontoinformationen:

{
  name: 'get_account_info',
  input: {
    address: string,
    network?: 'mainnet' | 'testnet'
  }
}

Token-Guthaben

Erhalten Sie das Guthaben für jedes Flow-Token:

{
  name: 'get_token_balance',
  input: {
    address: string,
    network?: 'mainnet' | 'testnet'
  }
}

COA-Konto

COA-Kontoinformationen abrufen:

{
  name: 'get_coa_account',
  input: {
    address: string,
    network?: 'mainnet' | 'testnet'
  }
}

Vertrag erhalten

Vertragsquellcode abrufen:

{
  name: 'get_contract',
  input: {
    address: string,
    contractName: string,
    network?: 'mainnet' | 'testnet'
  }
}

📂 Projektstruktur

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

🛠️ Entwicklung

Dieses Projekt verwendet FastMCP für Entwicklung und Tests. FastMCP bietet eine optimierte Entwicklungserfahrung für MCP-Server.

# 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

So fügen Sie Ihren Entwicklungs-MCP-Server zu Claude Desktop hinzu:

Erstellen Sie das Projekt:
```
bun run build
```

Fügen Sie Ihrer Claude Desktop-Konfiguration hinzu:

// 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"]
    }
  }
}

Erstellen neuer Tools

Das Projekt enthält ein Skript zur Unterstützung der Erstellung neuer MCP-Tools:

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

Dies wird:

Erstellen Sie ein neues Tool-Verzeichnis unter src/tools/<tool-name>
Generieren Sie die grundlegende Werkzeugstruktur, einschließlich:
- index.ts (Hauptimplementierung)
- schema.ts (JSON-Schema für Tool-Parameter)
- test.ts (Testdatei)
Aktualisieren Sie die Indexdatei des Tools, um das neue Tool zu exportieren

Beispiel:

bun run scripts/create-tool.ts weather

Commit-Nachrichtenformat

feat : Neue Funktion (verbessert Nebenversion)
fix : Fehlerbehebung (verbessert die Patch-Version)
BREAKING CHANGE : Breaking Change (erhöht die Hauptversion)

📜 Versionsverwaltung

Dieses Projekt verwendet die Standardversion für die automatisierte Versionsverwaltung. Führen Sie bun run release aus, um eine neue Version zu erstellen.

📦 Veröffentlichen auf npm

Stellen Sie sicher, dass Sie bei npm angemeldet sind:
```
npm login
```
Erstellen Sie das Projekt:
```
bun run build
```
Veröffentlichen Sie das Paket:
```
npm publish
```

Denken Sie daran, die Versionsnummer mit bun run release zu aktualisieren, bevor Sie neue Versionen veröffentlichen.

Lizenz

MIT-Lizenz – Einzelheiten finden Sie unter LIZENZ.

Beitragen

Beiträge sind willkommen! Senden Sie gerne einen Pull Request.

Flow MCP