Flowmcp CLI

FlowMCP命令行界面

用于开发、验证和管理FlowMCP模式的命令行工具。

描述

FlowMCP CLI是一个开发工具，用于处理FlowMCP模式-结构化的API定义，使AI代理能够与外部服务交互。CLI提供模式验证、实时API测试、存储库导入、基于增量的更新，以及用于与Claude Code等人工智能代理框架集成的MCP服务器模式。

建筑

flowchart LR
    A[Global: ~/.flowmcp/] --> B[Config + .env + Schemas]
    B --> C[flowmcp init]
    C --> D[Local: project/.flowmcp/]
    D --> E[Groups with Selected Tools]
    E --> F[flowmcp call / run]

快速启动

git clone https://github.com/FlowMCP/flowmcp-cli.git
cd flowmcp-cli
npm i
npx flowmcp init

命令

设置

工具发现（代理模式）

模式管理

组管理

及时管理

验证和测试

代理管理

架构迁移

资源管理（SQLite）

缓存管理

执行

工具参考格式

source/file.mjs              # All tools from a schema
source/file.mjs::routeName   # Single tool from a schema

全球旗帜

工作流示例

基本设置和使用

# 1. Setup (quick install imports schemas and creates default group)
flowmcp init

# 2. Or: Manual import and group creation
flowmcp import https://github.com/FlowMCP/flowmcp-schemas
flowmcp group append crypto --tools "flowmcp-schemas/coingecko/simplePrice.mjs,flowmcp-schemas/etherscan/getBalance.mjs"
flowmcp group set-default crypto

# 3. Validate and test
flowmcp validate
flowmcp test project

# 4. Use tools
flowmcp call list-tools
flowmcp call coingecko_simplePrice '{"ids":"bitcoin","vs_currencies":"usd"}'

# 5. Update schemas from remote
flowmcp update

# 6. Run as MCP server
flowmcp run

模式开发

# Validate a single schema file
flowmcp validate ./my-schema.mjs

# Validate an entire directory
flowmcp validate ./schemas/my-provider/

# Test with live API calls
flowmcp test single ./my-schema.mjs

# Test a specific route only
flowmcp test single ./my-schema.mjs --route getBalance

架构迁移（v2到v3）

# Preview what would change
flowmcp migrate ./schemas/ --dry-run

# Migrate a single file
flowmcp migrate ./schemas/provider/schema.mjs

# Migrate all schemas in a directory
flowmcp migrate --all ./schemas/

代理导入

# Import an agent from the registry
flowmcp import-agent my-agent

# Validate a catalog directory
flowmcp validate-catalog ./my-catalog/

目录验证

这 validate-catalog 命令检查目录目录的结构是否正确：

• registry.json 必须存在并与目录名匹配
• 所有引用的架构文件必须存在
• 所有引用的共享文件必须存在
• 所有代理清单文件必须存在
• 架构规范版本必须有效（2.0.0或3.0.0）

flowmcp validate-catalog ./catalogs/my-catalog/

{
    "status": true,
    "catalog": "my-catalog",
    "schemaSpec": "3.0.0",
    "counts": {
        "shared": 2,
        "schemas": 15,
        "agents": 1
    },
    "errors": [],
    "warnings": []
}

资源管理

对于具有基于SQLite的资源的模式：

# Create databases defined in a schema
flowmcp resource create ./schemas/provider/schema.mjs -y

# Preview database path migrations
flowmcp resource migrate --dry-run

# Execute migrations
flowmcp resource migrate -y

缓存管理

# Check cache size and entries
flowmcp cache status

# Clear everything
flowmcp cache clear

# Clear a specific namespace
flowmcp cache clear etherscan

及时管理

# List all prompts
flowmcp prompt list

# Search for prompts
flowmcp prompt search "blockchain"

# View a specific prompt
flowmcp prompt show analysis/token-report

# Add a prompt from a markdown file
flowmcp prompt add analysis token-report --file ./prompts/token-report.md

# Remove a prompt
flowmcp prompt remove analysis token-report

文档

完整文档请访问 docs.flowmcp.org。请参阅 CLI 参考 获取详细的命令文档。

许可证

麻省理工学院