使用说明

项目简介

MCP敏捷流程服务器（MCP Agile Flow Server）是一个基于Model Context Protocol (MCP) 构建的后端应用，旨在帮助用户管理敏捷项目生命周期和相关文档。它允许AI助手通过标准化的MCP协议访问和操作项目信息，从而在敏捷开发流程中发挥辅助作用。所有项目文档均以Markdown格式存储在本地项目根目录中，方便版本控制和管理。

主要功能点

敏捷文档管理: 以Markdown文件形式存储和管理敏捷项目文档，包括项目、史诗 (Epics)、故事 (Stories)、任务 (Tasks) 和项目进度等。
工作流管理: 支持创建、列出和更新史诗、故事和任务的状态，跟踪敏捷开发流程。
IDE集成: 能够根据项目文档自动生成特定于IDE（如Cursor和Cline）的规则文件，优化AI助手在集成开发环境中的表现。
本地存储: 所有项目数据和文档都存储在项目根目录下的 'agile-docs' 目录中，确保数据本地化和易于版本控制。
智能路径检测: 服务器能够自动检测项目根目录，无需繁琐的手动配置。
故障容错: 在遇到权限问题时，能够优雅地回退到用户主目录，保证服务器的稳定运行。

安装步骤

环境准备: 确保已安装 Python 3.10 或更高版本，并建议使用 'uv' (Python 包安装器)。
安装软件包:
- 使用 pip 从 PyPI 安装: 'pip install mcp-agile-flow'
- 或者从 GitHub 安装最新版本: 'pip install git+https://github.com/modelcontextprotocol/mcp-agile-flow.git'

开发环境安装 (可选): 如果需要进行开发或修改，请先克隆仓库：

git clone https://github.com/modelcontextprotocol/mcp-agile-flow.git
cd mcp-agile-flow
uv pip install -e .

服务器配置

要将 MCP 敏捷流程服务器配置到 MCP 客户端，您需要在客户端的 MCP 配置文件中添加以下 JSON 配置。请根据您的实际情况修改 'command' 字段中的路径。

{
  "mcpServers": {
    "agile-flow": {
      "command": "/path/to/run_server.sh",
      "args": [],
      "env": {},
      "disabled": false,
      "autoApprove": []
    }
  }
}

配置参数说明:

'server name': '"agile-flow"' (服务器名称，用户自定义，用于在客户端中标识该服务器)
'command': '"/path/to/run_server.sh"' (服务器启动命令。您需要创建一个 'run_server.sh' 脚本来执行 'server.py' 或 'agile_flow_sdk.py'，并在此处填写脚本的绝对路径)
'args': '[]' (启动参数，默认为空)
'env': '{}' (环境变量，默认为空。如果项目根目录未能自动检测，可以使用 'PROJECT_PATH' 环境变量显式指定项目路径)
'disabled': 'false' (设置为 'true' 可禁用该服务器)
'autoApprove': '[]' (自动批准执行的工具名称列表，默认为空，表示所有工具的调用都需要手动批准)

请注意: 您需要自行创建 'run_server.sh' 脚本，例如，脚本内容可以为 '#!/bin/bash\npython agile_flow_sdk.py'，并确保该脚本具有执行权限 ('chmod +x run_server.sh')。脚本路径需要根据您的实际安装位置进行调整。

基本使用方法

启动 MCP 客户端，客户端将根据配置连接到 MCP 敏捷流程服务器。
使用 MCP 客户端提供的界面或命令，调用服务器提供的工具。例如，可以使用 'create_project' 工具创建新的敏捷项目，使用 'list_projects' 工具查看已创建的项目列表，使用 'generate_cursor_rules' 或 'generate_cline_rules' 工具生成 IDE 规则文件。
项目的所有敏捷文档都将存储在您项目根目录下的 'agile-docs' 文件夹中。您可以使用文本编辑器或 Markdown 编辑器直接查看和编辑这些文档。
详细的工具列表和使用方法，请参考仓库中的 'docs' 目录下的文档，如 'Tool Reference' 和 'MCP Server Cheatsheet'。

关键词