使用说明
GitScrum MCP Server: Your AI Agent as a Project Manager 🚀
Turn your AI Agent into a full-scale Project Manager.
The Official Model Context Protocol (MCP) server for GitScrum provides AI assistants (Claude, Cursor, Windsurf, Copilot) with deep context and operational access to your entire project stack.
⚡ 托管(推荐)零安装。无处不在。 基于SSE的服务器托管在AWS上。只需将URL+令牌添加到您的AI客户端即可。 最适合: Claude Desktop、Cursor、Windsurf、任何与SSE兼容的客户端。 |
📦 本地(npm)通过npx自行托管。 通过stdio传输在本地运行。需要Node.js 18+。 最适合: VS Code、GitHub Copilot、离线环境。 |
概述
GitScrum Studio MCP服务器将AI助手连接到您的 GitScrum 通过工作空间 模型上下文协议。它为Claude、GitHub Copilot、Cursor和任何兼容MCP的客户端提供了对您的项目管理堆栈的完全操作访问权限——任务、冲刺、时间跟踪、用户故事、史诗、看板工作流、团队讨论、维基、笔记、客户CRM、发票、提案、预算跟踪、分析仪表板、站立报告和活动提要。
你的团队在GitScrum web应用程序中所做的一切,你的AI助手现在都可以通过对话来完成。
You: "What's on my plate today?"
Assistant: Fetches your tasks due today across all projects.
You: "Create a sprint for next week with the top 5 backlog items"
Assistant: Creates the sprint, assigns tasks, and sets the timeline.
You: "Show me which projects are over budget"
Assistant: Returns burn-down data and flags at-risk projects.
You: "Send the Q1 proposal to Acme Corp"
Assistant: Creates the proposal, attaches the client, and sends it.
You: "What did the team ship this week?"
Assistant: Generates a standup digest with completed work and blockers.
29个工具。160+次操作。零上下文切换。
快速开始
安装
npx -y @gitscrum-studio/mcp-server
配置您的客户端
Claude Desktop
编辑配置文件:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json - 窗户:
%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助手: “登录GitScrum”
服务器启动 OAuth 2.0设备授权授予 流动。您在浏览器中进行授权——凭据永远不会与MCP服务器共享。
工具
每个工具都使用一个整合的 action 参数,与单个工具定义相比,LLM上下文令牌减少了约80%。
核心
| 工具 | 操作 | 文档 |
|---|---|---|
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 |
notevault |
note_folder |
list create update move |
notevault |
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
安全
服务器是围绕 最小权限原则.
| 层 | 保护 |
|---|---|
| 运营 | 只创建、读取、更新。DELETE在MCP和API层被阻止。 |
| 认证 | OAuth 2.0设备授权——凭据永远不会接触服务器。 |
| 令牌存储 | 具有受限权限的本地文件系统。 |
| 速率限制 | 身份验证尝试失败后自动锁定。 |
必须在 GitScrum工作室.
详细信息: docs/SECURITY.md
发现漏洞?私下向 security@gitscrum.com.
文档
| 托管服务器 | Claude、Cursor、Windsurf等的SSE设置 |
| 使用指南 | 实例和常见工作流程 |
| 工具参考 | 所有29个带有参数和响应形状的工具 |
| 根据工具指南 | 深入了解每个工具模块 |
| 安全 | 安全模型、令牌处理、威胁缓解 |
| 发展 | 本地设置、架构、测试、贡献 |
| 更新日志 | 版本历史和迁移说明 |
发展
git clone https://github.com/gitscrum-core/mcp-server.git
cd mcp-server
npm install
npm run build
npm test # 378 tests across 22 suites
与MCP检查员一起进行本地检查:
npx @modelcontextprotocol/inspector node dist/index.js
| 要求 | 版本 |
|---|---|
| Node.js | >=18.0.0 |
| npm | >=8.0.0 |
完整指南: docs/DEVELOPMENT.md
贡献
看 贡献.md 作为指导方针。
git checkout -b feature/my-feature
# make changes, add tests
npm test
git commit -m "feat: describe your change"
许可证
麻省理工学院——见 许可证.
Website · Docs · Issues · Changelog
Built by GitScrum