README
🚀 GitScrum MCP 服务器:让你的 AI 代理成为项目管理专家 🚀
GitScrum MCP 服务器能将你的 AI 代理转变为全面的项目管理专家。官方的模型上下文协议(MCP)服务器为 GitScrum 提供支持,使 AI 助手(如 Claude、Cursor、Windsurf、Copilot)能够深入了解项目上下文,并对整个项目栈进行操作。
🚀 快速开始
安装
npx -y @gitscrum-studio/mcp-server
配置客户端
Claude Desktop
编辑配置文件:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%\Claude\claude_desktop_config.json
{
"mcpServers": {
"gitscrum": {
"command": "npx",
"args": ["-y", "@gitscrum-studio/mcp-server"]
}
}
}
VS Code / Cursor
添加到 .vscode/mcp.json 或你的 MCP 设置中:
{
"servers": {
"gitscrum": {
"command": "npx",
"args": ["-y", "@gitscrum-studio/mcp-server"]
}
}
}
认证
告诉你的 AI 助手:"Login to GitScrum"
服务器将启动 OAuth 2.0 设备授权协议 流程。你在浏览器中进行授权,凭证不会与 MCP 服务器共享。
✨ 主要特性
- 通过 模型上下文协议 将 AI 助手连接到 GitScrum 工作区。
- 让 Claude、GitHub Copilot、Cursor 等 MCP 兼容客户端能够全面操作项目管理栈,包括任务、冲刺、时间跟踪、用户故事、史诗、看板工作流、团队讨论、维基、笔记、客户 CRM、发票、提案、预算跟踪、分析仪表板、站立会议报告和活动动态等。
- 减少约 80% 的 LLM 上下文令牌,每个工具使用统一的
action参数。
📦 安装指南
⚡ 托管模式(推荐)
无需安装,随处可用。
https://mcp.gitscrum.com/sse
基于 SSE 的服务器托管在 AWS 上。只需将 URL 和令牌添加到你的 AI 客户端即可。
适用场景:Claude Desktop、Cursor、Windsurf 以及任何支持 SSE 的客户端。
📦 本地模式(npm)
通过 npx 进行自托管。
npx -y @gitscrum-studio/mcp-server
通过标准输入输出传输在本地运行。需要 Node.js 18+。
适用场景:VS Code、GitHub Copilot、离线环境。
💻 使用示例
你:"今天我有哪些任务?"
助手:获取你所有项目中今天到期的任务。
你:"为下周创建一个包含前 5 个待办事项的冲刺"
助手:创建冲刺,分配任务并设置时间线。
你:"显示哪些项目超预算了"
助手:返回燃尽数据并标记有风险的项目。
你:"将第一季度的提案发送给 Acme 公司"
助手:创建提案,关联客户并发送。
你:"团队本周交付了什么?"
助手:生成站立会议摘要,包含已完成的工作和阻碍。
📚 详细文档
工具列表
核心工具
| 工具 | 操作 | 文档 |
|:-----|:--------|:-----|
| task | my today get create update complete subtasks filter by_code duplicate move notifications | 任务 |
| sprint | list all get kpis create update stats reports progress metrics | 冲刺 |
| workspace | list get | 项目 |
| project | list get stats tasks workflows types efforts labels members | 项目 |
| time | active start stop logs analytics team reports productivity timeline | 时间跟踪 |
规划工具
| 工具 | 操作 | 文档 |
|:-----|:--------|:-----|
| user_story | list get create update all | 用户故事 |
| epic | list create update | 史诗 |
| label | list create update attach detach toggle | 标签 |
| task_type | list create update assign | 任务类型 |
| workflow | create update | 工作流 |
协作工具
| 工具 | 操作 | 文档 |
|:-----|:--------|:-----|
| discussion | all channels channel messages send search unread mark_read create_channel update_channel | 讨论 |
| comment | list add update | 评论 |
| wiki | list get create update search | 维基 |
| note | list get create update share revisions | 笔记库 |
| note_folder | list create update move | 笔记库 |
| search | — | 搜索 |
客户流 CRM
| 工具 | 操作 | 文档 |
|:-----|:--------|:-----|
| client | list get create update contacts interactions add_interaction | 客户流 |
| invoice | list get stats create update issue send mark_paid | 客户流 |
| proposal | list get stats create update send approve reject convert | 客户流 |
| clientflow_dashboard | 8 个报告 | 客户流 |
| clientflow_cross_workspace | 4 个报告 | 客户流 |
洞察(专业版)
| 工具 | 操作 | 文档 |
|:-----|:--------|:-----|
| standup | summary completed blockers team stuck digest contributors | 站立会议 |
| analytics | 10 个报告 | 分析 |
| activity | feed user_feed notifications activities task_workflow | 活动 |
| budget | projects_at_risk overview consumption burn_down alerts events | 预算 |
认证工具
| 工具 | 描述 | 文档 |
|:-----|:------------|:-----|
| auth_login | 启动设备代码流程 | 认证 |
| auth_complete | 完成授权 | 认证 |
| auth_status | 检查会话状态 | 认证 |
| auth_logout | 清除存储的凭证 | 认证 |
完整参考:docs/TOOLS.md
其他文档
| 文档 | 说明 | |:--|:--| | 托管服务器 | 为 Claude、Cursor、Windsurf 等设置 SSE | | 使用指南 | 实际示例和常见工作流 | | 工具参考 | 所有 29 个工具的参数和响应格式 | | 各工具指南 | 深入了解每个工具模块 | | 安全 | 安全模型、令牌处理、威胁缓解 | | 开发 | 本地设置、架构、测试、贡献 | | 更新日志 | 版本历史和迁移说明 |
🔧 技术细节
安全
服务器遵循 最小权限原则 进行设计。
| 层次 | 保护措施 | |:------|:-----------| | 操作 | 仅支持 CREATE、READ、UPDATE,DELETE 在 MCP 和 API 层被阻止。 | | 认证 | 使用 OAuth 2.0 设备授权协议,凭证不会接触服务器。 | | 令牌存储 | 存储在具有受限权限的本地文件系统中。 | | 速率限制 | 认证失败尝试后自动锁定。 |
破坏性操作必须在 GitScrum Studio 中执行。
完整详情:docs/SECURITY.md
开发
git clone https://github.com/gitscrum-core/mcp-server.git
cd mcp-server
npm install
npm run build
npm test # 22 个套件共 378 个测试
使用 MCP 检查器进行本地检查:
npx @modelcontextprotocol/inspector node dist/index.js
| 要求 | 版本 | |:------------|:--------| | Node.js | >= 18.0.0 | | npm | >= 8.0.0 |
完整指南:docs/DEVELOPMENT.md
📄 许可证
本项目采用 MIT 许可证,请参阅 LICENSE。
由 GitScrum 构建
微信扫一扫