项目简介

Agents Playbook 是一个专为AI驱动开发工作流设计的框架。它通过结构化、YAML定义的工作流和语义搜索功能,将复杂的开发任务分解为可管理的步骤和阶段。作为一个MCP(Model Context Protocol)服务器,它能够向LLM(大语言模型)客户端提供这些工作流作为工具和上下文,从而实现LLM对开发任务的智能编排和执行。

主要功能点

  • AI工作流编排: 提供预定义的YAML工作流(如功能开发、快速修复、代码重构),指导AI完成复杂的开发任务。
  • 语义工作流发现: 利用OpenAI嵌入技术,通过任务描述智能匹配最相关的工作流,提升AI的任务理解能力。
  • 上下文工程迷你Prompt: 包含针对不同开发阶段(分析、设计、规划、实现、测试)精心设计的迷你Prompt模板,确保AI获取准确的指令。
  • 智能步骤跳过: 根据已有的上下文和前置条件,智能判断并跳过不必要的步骤,提高工作流效率。
  • MCP服务器集成: 通过JSON-RPC协议,以标准化的方式向LLM客户端提供工作流工具和上下文信息,实现无缝对接。

安装步骤

  1. 克隆仓库:
    git clone https://github.com/Fohlio/agents-playbook
  2. 进入项目目录:
    cd agents-playbook
  3. 安装项目依赖:
    npm install
  4. 配置OpenAI API Key: 创建 '.env.local' 文件,并在其中添加您的OpenAI API Key,例如:
    OPENAI_API_KEY=your_openai_api_key_here
  5. 构建工作流嵌入(推荐,以启用语义搜索功能):
    npm run build:embeddings

MCP服务器配置 (供MCP客户端连接)

Agents Playbook 部署后提供一个MCP服务器端点。您的LLM客户端可以通过以下JSON格式的配置连接到此服务器。此配置包含LLM客户端连接和(在本地场景下)可能需要启动服务器的关键信息。

{
  "mcpServers": {
    "agents-playbook": {
      "url": "http://localhost:3000/api/mcp", 
      // 备注:这是MCP服务器在本地运行时的API端点。
      // 如果部署到Vercel等平台,URL将是部署后的公共地址,例如:
      // "url": "https://agents-playbook.vercel.app/api/mcp"

      "command": "npm", 
      // 备注:如果MCP客户端需要自动启动此服务器,这是执行命令(Node.js包管理器)。
      // 实际的启动脚本可能由Next.js等框架封装。

      "args": ["run", "dev"] 
      // 备注:这是配合“command”参数启动服务器的参数,
      // 用于在本地开发模式下启动Agents Playbook服务器。
    }
  }
}

基本使用方法

  1. 启动开发服务器: 在项目根目录运行以下命令,启动本地开发服务器:

    npm run dev

    服务器将在 'http://localhost:3000' 运行。MCP服务器的API端点位于 'http://localhost:3000/api/mcp'。

  2. 通过MCP客户端与服务器交互: 您的支持MCP协议的LLM客户端可以调用Agents Playbook服务器提供的三个核心工具:

    • 'get_available_workflows(task_description: string)':
      • 功能: 提供您的任务描述,LLM客户端将收到与任务最匹配的工作流列表和其简要说明。
      • 示例提示: "使用 agents-playbook 查找关于如何修复生产环境关键bug的工作流。"
    • 'select_workflow(workflow_id: string)':
      • 功能: 传入一个工作流ID,LLM客户端将收到该工作流的详细计划,包括所有阶段、步骤及每个步骤所需的上下文。
      • 示例提示: "请使用 agents-playbook 选择 'quick-fix' 工作流,并向我展示其详细步骤。"
    • 'get_next_step(workflow_id: string, current_step: number, available_context?: string[])':
      • 功能: 传入工作流ID和当前已完成的步骤序号(从0开始),LLM客户端将获取下一步的详细Prompt指导。您可以可选地提供当前已具备的上下文信息数组,服务器会根据这些上下文智能调整Prompt内容或跳过已满足条件的步骤。
      • 示例提示: "使用 agents-playbook 获取 'feature-development' 工作流的第一个步骤。" 或 "我已经完成了第一个步骤,并且有了'requirements'上下文,请获取下一步。"
  3. 部署到Vercel: 您可以将Agents Playbook部署到Vercel平台:

    npm i -g vercel
    vercel --prod

    部署后,请务必在Vercel仪表板中设置 'OPENAI_API_KEY' 环境变量。

信息

分类

开发者工具