项目简介

Agile Planner MCP 服务器是一个基于 Model Context Protocol (MCP) 的后端应用，专注于自动化生成完整的敏捷待办事项（包括史诗、用户故事、MVP 规划、迭代规划）或特定功能的用户故事，只需简单的文字描述。它利用大型语言模型（LLM）的能力，以结构化的方式生成文档，并通过标准化的 MCP 协议与兼容的 LLM 客户端（如 Windsurf, Cascade, Cursor）进行通信。

主要功能点

自动化待办事项生成: 从一段项目描述自动生成包含史诗、特性和用户故事的完整待办事项结构。
特性生成: 根据特性描述生成特定功能的详细用户故事和验收标准。
AI 驱动: 利用 OpenAI 或 Groq 等 LLM 进行智能内容生成。
结构化输出: 生成的待办事项以标准化的 JSON 格式存储，并以 Markdown 文件形式组织在项目目录中，遵循特定的目录结构（RULE 3）。
MCP 协议通信: 通过 JSON-RPC 协议接收来自 LLM 客户端的 'initialize', 'tools/list', 'tools/call' 等请求。
工具声明与调用: 向客户端声明 'generateBacklog' 和 'generateFeature' 等可用工具，并执行客户端发起的工具调用请求。
多传输协议支持: 支持 Stdio 等传输方式，便于与 MCP 客户端集成。

安装步骤

确保 Node.js 环境: 本服务器需要 Node.js 运行环境。请访问 Node.js 官网安装最新版本。

克隆仓库或使用 npm:

克隆仓库: 使用 Git 命令将仓库克隆到本地：

git clone https://github.com/cyberlife-coder/agile-planner-mcp-server.git
cd agile-planner-mcp-server

使用 npm 全局安装 (推荐 CLI 模式):
```
npm install -g agile-planner-mcp-server
```
（请注意，虽然支持全局安装用于 CLI，但作为 MCP 服务器通常需要在客户端配置中指定安装路径或使用 'npx'。）

安装依赖: 在仓库根目录运行命令安装项目依赖：
```
npm install
```
配置 API 密钥: 本服务器依赖 LLM API (OpenAI 或 Groq) 进行内容生成。在项目根目录创建一个名为 '.env' 的文件，并添加您的 API 密钥（至少需要其中一个）：
```
OPENAI_API_KEY=sk-...你的OpenAI密钥
GROQ_API_KEY=gsk-...你的Groq密钥
```
（请确保您的 API 密钥有效且有足够的调用额度。）

服务器配置（用于 MCP 客户端）

MCP 客户端（如 Windsurf, Cascade, Cursor）需要配置如何启动并连接到 Agile Planner MCP 服务器。配置通常是一个 JSON 对象，您需要将以下信息添加到您的客户端的 MCP 服务器配置中：

server name: 服务器的唯一标识符，例如 '"agile-planner"'。
command: 启动服务器进程的命令。如果使用本地克隆的仓库，通常是 'node'。
args: 传递给启动命令的参数。对于本地仓库，通常是服务器的入口文件路径 'server/index.js'。如果使用 'npx' 方式，命令可能是 'npx'，参数是 'agile-planner-mcp-server'。
env: 启动服务器进程所需的环境变量。'MCP_EXECUTION' 必须设置为 '"true"' 以激活 MCP 模式。您还需要在此处或 '.env' 文件中设置您的 LLM API 密钥（如 'OPENAI_API_KEY' 或 'GROQ_API_KEY'）。

配置示例描述 (JSON 格式):

{
  "mcpServers": {
    "agile-planner": { // 服务器名称，可自定义
      "command": "node", // 或 "npx"
      "args": ["D:/path/to/agile-planner/server/index.js"], // 或 ["agile-planner-mcp-server"] 如果使用 npx
      "env": {
        "MCP_EXECUTION": "true", // 必需，指示服务器以 MCP 模式运行
        "OPENAI_API_KEY": "sk-...", // 或 GROQ_API_KEY, 用于 LLM 调用
        "DEBUG": "false" // 可选，开启调试日志
        // ... 其他环境变量 ...
      }
    }
  }
}

（请注意： 上述是一个配置示例描述，具体的配置方式和位置取决于您使用的 MCP 客户端应用程序。请查阅您客户端的官方文档获取详细的服务器配置指南。您不需要手动运行 'node server/index.js' 或 'npx agile-planner-mcp-server'，这些命令将由您的 MCP 客户端根据配置自动执行。）

基本使用方法

Agile Planner MCP 服务器通常不会独立运行供用户直接交互。您需要使用一个兼容的 MCP 客户端来与其进行交互：

启动 MCP 客户端: 打开并配置好支持 MCP 的客户端应用（如 Windsurf, Cascade, Cursor）。
通过客户端界面操作: 在客户端应用中，您应该能找到与 Agile Planner MCP 服务器集成的功能点，例如生成项目待办事项或生成特性。
输入项目/特性描述: 根据客户端的界面提示，输入您的项目或特性的详细描述。
客户端发送请求: 您的客户端应用会将您的输入打包成 MCP 标准的 JSON-RPC 请求（通常是 'tools/call' 方法），并通过配置的传输方式（如 Stdio）发送给 Agile Planner MCP 服务器进程。
服务器处理并返回结果: Agile Planner MCP 服务器接收请求，调用内部逻辑（包括 LLM API 调用）生成待办事项或特性数据，并将结果以 JSON-RPC 响应的形式返回给客户端。
客户端展示结果: 您的客户端应用接收到服务器返回的数据后，通常会将生成的 Markdown 文件和 JSON 文件保存在您的项目目录中，并在客户端界面中展示生成的内容供您查阅和使用。

例如，通过客户端调用生成待办事项工具，可能在后台触发一个类似以下的 MCP 请求：

{
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "name": "generateBacklog",
    "arguments": {
      "projectName": "我的新应用",
      "projectDescription": "一个用于管理个人任务和日程的移动端应用...",
      "outputPath": "./path/to/your/project" // 根据客户端环境和配置决定
    }
  },
  "id": 1 // 请求 ID
}

服务器处理后，会将生成的待办事项文件（Markdown 和 JSON）保存在指定的 'outputPath' 目录下。

关键词

项目简介

主要功能点

安装步骤

服务器配置（用于 MCP 客户端）

基本使用方法

信息