Zum Inhalt springen

CLI-Referenz

Die FlowMCP CLI ist ein Kommandozeilen-Tool fuer die Entwicklung, Validierung und Verwaltung von FlowMCP-Schemas. Sie behandelt Schema-Imports, Gruppen-Verwaltung, Live-API-Tests, Migration und kann als MCP-Server fuer KI-Agent-Integration laufen.

Terminal-Fenster
npm install -g github:FlowMCP/flowmcp-cli

Oder lokal klonen und verlinken:

Terminal-Fenster
git clone https://github.com/FlowMCP/flowmcp-cli.git
cd flowmcp-cli
npm install
npm link

Die CLI arbeitet auf zwei Konfigurationsebenen:

EbenePfadInhalt
Global~/.flowmcp/Config, .env mit API-Schluesseln, alle importierten Schemas
Lokal{project}/.flowmcp/Projekt-Config, Gruppen mit ausgewaehlten Tools
~/.flowmcp/
├── config.json # Globale Konfiguration
├── .env # API-Schluessel fuer Schema-Tests
└── schemas/ # Alle importierten Schema-Dateien
└── flowmcp-schemas/ # Von GitHub importiert
{project}/.flowmcp/
├── config.json # Konfiguration auf Projektebene
└── groups/ # Tool-Gruppen fuer dieses Projekt

Die CLI hat zwei Betriebsmodi, die steuern, welche Befehle verfuegbar sind:

ModusStandardBeschreibung
AgentJaTeilmenge der Befehle fuer KI-Agent-Nutzung (search, add, remove, list, call, run)
DevNeinAlle Befehle inkl. Validierung, Tests, Schema-Browsing, Migration und Imports

Wechsle Modi mit flowmcp mode agent oder flowmcp mode dev.

Interaktives Setup, das globale und lokale Konfiguration erstellt. Einmal pro Projekt ausfuehren.

Terminal-Fenster
flowmcp init

Config, Quellen, Gruppen und Health-Info anzeigen.

Terminal-Fenster
flowmcp status

Aktuellen Modus anzeigen oder wechseln.

Terminal-Fenster
flowmcp mode # Aktuellen Modus anzeigen
flowmcp mode dev # In Dev-Modus wechseln
flowmcp mode agent # In Agent-Modus wechseln

Verfuegbare Tools per Stichwort finden.

Terminal-Fenster
flowmcp search etherscan
flowmcp search "gas price"
flowmcp search defi

Alle verfuegbaren Schemas und ihre Tools auflisten. Nur im Dev-Modus.

Terminal-Fenster
flowmcp schemas

Tool fuer dieses Projekt aktivieren.

Terminal-Fenster
flowmcp add coingecko_simplePrice

Tool aus dem Projekt deaktivieren.

Terminal-Fenster
flowmcp remove coingecko_simplePrice

Alle aktiven Tools im aktuellen Projekt anzeigen.

Terminal-Fenster
flowmcp list

Schemas aus einem GitHub-Repository importieren. Nur im Dev-Modus.

Terminal-Fenster
flowmcp import https://github.com/FlowMCP/flowmcp-schemas
flowmcp import https://github.com/FlowMCP/flowmcp-schemas --branch develop

Schemas von Remote-Registries per Hash-basiertem Delta-Sync aktualisieren.

Terminal-Fenster
flowmcp update # Alle Quellen aktualisieren
flowmcp update flowmcp-schemas # Bestimmte Quelle aktualisieren

Schemas von v2 zu v3 migrieren. Benennt routes in tools um und aktualisiert das Versions-Feld. Nur im Dev-Modus.

Terminal-Fenster
flowmcp migrate ./schemas/coingecko/Ping.mjs
flowmcp migrate --all ./schemas/
flowmcp migrate --dry-run ./schemas/coingecko/Ping.mjs

Gruppen organisieren Tools in benannten Sammlungen. Jedes Projekt kann mehrere Gruppen haben, wobei eine als Standard gesetzt wird.

Alle Gruppen und ihre Tool-Anzahl auflisten.

Terminal-Fenster
flowmcp group list

Tools zu einer Gruppe hinzufuegen. Erstellt die Gruppe, wenn sie nicht existiert.

Terminal-Fenster
flowmcp group append crypto --tools "flowmcp-schemas/coingecko/simplePrice.mjs,flowmcp-schemas/etherscan/getBalance.mjs"

Standard-Gruppe fuer call, test und run setzen.

Terminal-Fenster
flowmcp group set-default crypto

Schema-Struktur gegen die FlowMCP-Spezifikation validieren.

Terminal-Fenster
flowmcp validate
flowmcp validate ./my-schema.mjs
flowmcp validate --group crypto

flowmcp test project [--route name] [--group name]

Abschnitt betitelt „flowmcp test project [--route name] [--group name]“

Standard-Gruppen-Schemas mit Live-API-Aufrufen testen.

Terminal-Fenster
flowmcp test project
flowmcp test project --route getBalance

Eine einzelne Schema-Datei testen.

Terminal-Fenster
flowmcp test single ./my-schema.mjs
flowmcp test single ./my-schema.mjs --route getBalance

Ein Tool mit optionalem JSON-Input aufrufen.

Terminal-Fenster
flowmcp call coingecko_simplePrice '{"ids":"bitcoin","vs_currencies":"usd"}'

Als MCP-Server mit stdio-Transport starten. Wird fuer die Integration mit KI-Agent-Frameworks wie Claude Code verwendet.

Terminal-Fenster
flowmcp run
flowmcp run --group crypto

Tools werden im source/file.mjs-Format mit optionalen Typ-Diskriminatoren referenziert:

source/file.mjs # Alle Tools aus einem Schema
source/file.mjs::tool::toolName # Einzelnes Tool (v3-Format)
source/file.mjs::resource::resName # Einzelne Resource (v3-Format)
source/file.mjs::skill::skillName # Einzelner Skill (v3-Format)

API-Schluessel fuer Schema-Tests in ~/.flowmcp/.env:

Terminal-Fenster
ETHERSCAN_API_KEY=your_key_here
COINGECKO_API_KEY=your_key_here
DUNE_API_KEY=your_key_here