ApiFlow

Appearance

Claude Code 集成指南 ​

本文档介绍如何在 Claude Code 中集成 ApiFlow，通过 Skill 和 MCP 两种方式增强 AI 在工作流编写和调试方面的能力。 阅读前请先安装Claude code 并使用官方模型

使用场景 ​

ApiFlow Skill ​

  • 自动编写 DSL：让 AI 掌握 ApiFlow DSL 语法，自动生成工作流脚本
  • 学习辅助：通过 AI 快速学习和理解 DSL 语法规则
  • 代码补全：智能提示和完成 DSL 代码片段

ApiFlow MCP ​

  • 错误检查：自动检测工作流中的语法和逻辑错误
  • 自动修复：智能修复常见错误
  • 实时调试：提供实时调试工具和系统日志查看
  • 详细功能请参考 12-MCP调试工具.md

Skill 安装 ​

安装位置 ​

ApiFlow Skill 的完整内容位于 ApiFlow 安装目录中：

apiFlow-studio-{版本}/apiFlow-engine-{版本}/doc/

手动安装步骤 ​

全局安装（推荐） ​

  1. 创建安装目录 mkdir -p ~/.claude/skills/apiFlow-skill
  2. 找到 apiFlow-studio-{版本}/apiFlow-engine-{版本}/doc 目录
  3. 将doc目录中的内容复制到apiFlow-skill cp -r ./doc/* ~/.claude/skills/apiFlow-skill

注意是复制doc中的内容，不包含doc本身

项目级安装 ​

如果只想在特定工作流项目中使用：

  1. 在项目根目录创建 .claude/skills/ 目录
  2. 将 doc 目录中的内容复制到 .claude/skills/apiFlow-skill

注意是复制doc中的内容，不包含doc本身

自动安装 ​

你可以将以下提示词发送给 Claude Code，让它自动完成安装：

请帮我安装 ApiFlow Skill：

1. 文件位置在：apiFlow-studio-{版本}/apiFlow-engine-{版本}/doc/
2. 将doc 目录复制到 Claude Code 的全局 skills 目录
3. 重命名为 apiFlow-skill
4. 验证安装是否成功

注意要把doc位置换成你实际地址

验证安装 ​

在 Claude Code 中执询问检查是否安装成功：

bash
我当前有安装apiFlow这个skill吗？

如果 AI 开始提供 ApiFlow DSL 相关的帮助，说明安装成功。

安装失败 ​

如果以上方式都安装失败，请查阅官方文档

MCP 安装 ​

前置条件 ​

确保 ApiFlow Studio 服务正在运行，默认端口为 8405。

MCP 服务地址：

http://localhost:8405/mcp

注意：如果你的 ApiFlow Studio 使用了不同的端口，请相应调整配置中的端口号。

全局安装（推荐） ​

在控制台中输入安装命令

bash
claude mcp add --transport http apiFlow-tool http://localhost:8405/mcp

项目级安装 ​

如果只想在特定工作流项目中使用：

在项目根目录创建或编辑 .mcp.json 文件

json
{
  "mcpServers": {
    "apiFlow-tool": {
      "type": "http",
      "url": "http://localhost:8405/mcp"
    }
  }
}

自动安装 ​

发送以下提示词给 Claude Code 进行自动配置：

请帮我配置 ApiFlow MCP 服务：
1. 在全局配置文件中添加 MCP 服务器配置
2. MCP 地址为：http://localhost:8405/mcp
3. 服务器名称为：apiFlow-tool
4. 验证 MCP 连接是否成功

配置格式：
{
  "mcpServers": {
    "apiFlow-tool": {
      "type": "http",
      "url": "http://localhost:8405/mcp"
    }
  }
}

验证安装 ​

方法一：检查 MCP 服务列表 ​

在 Claude Code 中执行：

bash
/mcp

你应该能在列表中看到 apiFlow-tool 服务。

方法二：测试 MCP 功能 ​

尝试在 Claude Code 中使用 apiFlow MCP 提供的工具，例如：

请查看当前apiFlow最近的日志

如果 AI 能够调用 ApiFlow MCP 工具进行检查，说明配置成功。

使用建议 ​

最佳实践 ​

  1. 推荐全局安装：便于在所有项目中使用 ApiFlow 功能
  2. 先装 Skill 后装 MCP：Skill 提供语法知识，MCP 提供运行时支持
  3. 确保服务运行：使用 MCP 前务必启动 ApiFlow Studio

常见问题 ​

Q: MCP 连接失败怎么办？

  • 检查 ApiFlow Studio 是否正在运行
  • 确认端口号是否正确（默认 8405）
  • 查看防火墙是否阻止了本地连接

Q: Skill 不生效？

  • 确认目录名为 apiFlow-skill（不是 doc）
  • 重启 Claude Code
  • 检查 skill 目录中是否包含必要的配置文件

Q: 如何更新 Skill 内容？

重新从最新的 apiFlow-engine-*/doc 目录复制覆盖即可

下一步 ​

安装完成后，你可以：

  1. 阅读 DSL 语法指南 了解基础语法
  2. 查看 MCP 调试工具文档 掌握调试技巧
  3. 在 Claude Code 中尝试编写你的第一个工作流

开始体验 AI 辅助的工作流开发吧！