Coderide

使用 CodeRide 任务管理增强你的 AI 助手或 IDE

为你的 AI 编码搭档赋予 CodeRide 的强大能力！ CodeRide MCP 可将你喜爱的 AI 开发工具（如 Cursor、Cline、Windsurf 和其他 MCP 客户端）直接连接到 CodeRide 这个 AI 原生任务管理系统。

想象一下，你的 AI 不只是编写代码，还能真正理解项目上下文、自主管理任务，并与你无缝协作。告别无休止的复制粘贴和手动更新。借助 CodeRide MCP，你的 AI 将成为 CodeRide 工作流中的正式一员。

🚀 为什么 CodeRide MCP 能带来变革

• 让 AI 深入理解项目： 为 AI Agent 提供来自 CodeRide 项目和任务的丰富结构化上下文，让它们了解全局。
• 无缝实现 AI 驱动的任务自动化： 让 AI 直接在 CodeRide 中获取、解读和更新任务，自动处理日常项目管理工作。
• 弥合人类与 AI 开发者之间的鸿沟： 通过更顺畅的交接、一致的任务理解和协调一致的工作，促进真正的协作。
• 针对大模型效率进行了优化： 精简的 JSON 响应可最大限度减少令牌用量，确保 AI 交互更快速、更经济。
• 安全设计： 基于工作区范围的 API 密钥身份验证可确保数据完整性，并将 AI 操作限制在正确的项目上下文中。
• 即插即用集成： 通过 npx 即可在任何兼容 MCP 的环境中轻松设置，几分钟内即可连接 AI！
• 让工作流面向未来： 基于开放的 Model Context Protocol 标准，采用 AI 原生的开发方式。

✨ 核心功能

CodeRide MCP 服务为 AI 提供以下功能：

• 任务管理： 获取指定任务、列出项目中的所有任务，以及获取序列中的下一个任务。
• 任务更新： 修改任务描述和状态。
• 提示词访问： 获取特定任务对应的提示词和说明。
• 项目管理： 列出所有项目、获取项目详情，以及管理项目知识。
• 项目知识管理： 更新项目知识图谱和架构图。
• 项目启动： 获取项目的第一个任务，以启动工作。
• 工作流自动化： 通过智能的下一任务建议，在任务序列中推进。

⚙️ 开始使用

通过 Smithery 安装（推荐）

如需通过 Smithery 自动为 Claude Desktop 安装 Coderide MCP Server：

npx -y @smithery/cli install @PixdataOrg/coderide --client claude

Smithery 部署模式

CodeRide MCP 支持双模式运行，兼顾开发和生产用途：

🔧 开发/测试模式（模拟）

非常适合探索功能、测试集成，或为项目做贡献，无需拥有真实的 CodeRide 账户。

激活方式： 在 Smithery playground 或配置中，选择以下任一方式：

• 将 CODERIDE_API_KEY 字段留空
• 提供任意占位值（例如 mock-key、test 等）

你将获得：

• 可使用全部 9 个工具，并提供逼真的模拟数据
• 示例项目（ABC、XYZ）和任务（ABC-1、ABC-2 等）
• 用于测试和开发的完整 MCP 功能
• 不会进行真实 API 调用，可放心试用

🚀 生产模式（真实 API）

适用于希望将 CodeRide 与真实项目和任务集成的用户。

激活方式： 提供有效的 CodeRide API 密钥，且密钥以 CR_API_KEY_ 开头

你将获得：

• 与 CodeRide 工作区的完整集成
• 真实的项目和任务数据
• 更新任务和项目的能力
• 完整的工作流自动化

传统 MCP 配置

对于非 Smithery 部署，请将此配置添加到 MCP 客户端：

{
  "mcpServers": {
    "CodeRide": {
      "command": "npx",
      "args": ["-y", "@coderide/mcp"],
      "env": {
        "CODERIDE_API_KEY": "YOUR_CODERIDE_API_KEY_HERE"
      }
    }
  }
}

前提条件：

1. Node.js 和 npm： 确保已安装 Node.js（其中包含 npm）。
2. CodeRide 账户和 API 密钥（仅限生产环境）： 如需在生产环境中使用，你需要拥有有效的 CodeRide 账户，并从 app.coderide.ai 获取 API 密钥。

配置完成后，MCP 客户端会根据你的配置自动连接到相应模式下的 CodeRide MCP 服务。

🤖 适用对象

CodeRide MCP 适用于：

• 使用 AI 编码助手的开发者： 将你的 AI 工具（Cursor、Cline、Windsurf 等）与 CodeRide 任务管理深度集成。
• 采用 AI 驱动开发的团队： 统一 AI Agent 获取项目信息和参与任务的方式。
• 任何使用 MCP 构建产品的人： 借助一个连接到真实 SaaS 平台的强大 MCP 服务示例。

如果你希望让 AI 助手成为开发团队中效率更高、集成度更高的一员，那么 CodeRide MCP 正适合你。

🔨 可用工具

下面介绍 CodeRide MCP 提供的工具及其用法：

get_task

根据任务编号（例如 “TCA-3”）获取特定任务的详细信息。

输入架构：

{
  "number": "task-number (e.g., 'TCA-3')",
  "status": "to-do|in-progress|done", // Optional: filter by status
}

使用示例：

• 用户提示词：“嘿，AI，任务 APP-101 的详细信息是什么？”
• **AI 操作：**调用 get_task，并传入 arguments: { "number": "APP-101" }。
• **结果：**AI 会收到任务 APP-101 的标题、描述、状态、优先级及其他上下文信息。

update_task

更新现有任务的描述、状态或其他可变字段。

输入架构：

{
  "number": "task-number-identifier",
  "description": "updated-task-description", // Optional
  "status": "to-do|in-progress|done"   // Optional
}

使用示例：

• 用户提示词：“AI，请将任务 BUG-42 标记为 ‘done’，并添加备注：‘修复了差一错误。’”
• **AI 操作：**调用 update_task，并传入 arguments: { "number": "BUG-42", "status": "done", "description": "Fixed the off-by-one error." }。
• **结果：**CodeRide 中的任务 BUG-42 已更新。

get_prompt

获取为 AI Agent 处理指定任务量身定制的提示词或指令。

输入架构：

{
  "number": "task-number (e.g., 'TCA-3')"
}

使用示例：

• 用户提示词：“AI，我准备开始处理任务 ETF-7。主要目标是什么？”
• **AI 操作：**调用 get_prompt，并传入 arguments: { "slug": "ETF", "number": "ETF-7" }。
• **结果：**AI 会收到针对 FEAT-7 的具体可执行提示词，从而能够在明确指引下开始工作。

get_project

根据项目的 slug 获取特定项目的详细信息。

输入架构：

{
  "slug": "project-slug (e.g., 'TCA')",
  "name": "optional-project-name" // Can also retrieve by name
}

使用示例：

• 用户提示词：“AI，可以给我介绍一下 ‘Omega Initiative’ 项目吗？”
• **AI 操作：**调用 get_project，并传入 arguments: { "slug": "omega-initiative" }。
• **结果：**AI 会收到项目名称、描述，以及可能指向其知识库或图表的链接。

update_project

更新项目的高层信息，例如知识图谱或系统架构图。

输入架构：

{
  "slug": "project-slug-identifier",
  "project_knowledge": { /* JSON object representing the knowledge graph */ }, // Optional
  "project_diagram": "/* Mermaid diagram string or similar */"             // Optional
}

使用示例：

• 用户提示词：“AI，我更新了用户身份验证流程。请更新项目 ‘APB’ 的项目图。”
• AI 操作：（生成或接收新图后）调用 update_project，并传入 arguments: { "slug": "APB", "project_diagram": "/* new mermaid diagram */" }。
• **结果：**CodeRide 中的 ‘AlphaProject’ 现在包含更新后的架构图。

start_project

获取指定项目的第一个或下一个推荐任务，以便 AI 开始工作。

输入架构：

{
  "slug": "project-slug (e.g., 'TCA')"
}

使用示例：

• 用户提示词：“AI，让我们开始 ‘MobileAppV2’ 项目吧。第一个任务是什么？”
• **AI 操作：**调用 start_project，并传入 arguments: { "slug": "MBC" }。
• **结果：**AI 收到 ‘MBC’ 项目的初始任务详情，可以开始工作。

list_projects ✨ 新增

列出用户工作区中的所有项目，概览可用项目，并提供智能工作流指导。

输入架构：

{
  // No input required - automatically uses workspace from API key
}

使用示例：

• 用户提示词：“AI，显示我的所有项目。”
• **AI 操作：**不带参数调用 list_projects。
• **结果：**AI 收到工作区中所有项目的列表，其中包含项目代号、名称和基本详情，以及有关项目选择和工作流启动的智能指导。

list_tasks ✨ 新增

显示特定项目中的所有任务，按状态整理，并通过智能数字排序优化工作流。

输入架构：

{
  "slug": "project-slug (e.g., 'CRD')"
}

使用示例：

• 用户提示词：“AI，CRD 项目有哪些可用任务？”
• **AI 操作：**调用 list_tasks，并传入 arguments: { "slug": "CRD" }。
• **结果：**AI 收到 CRD 项目中的所有任务，按数字顺序排序（CRD-1、CRD-2、CRD-3……），并按状态列整理，同时提供智能任务选择指导。

next_task ✨ 新增

获取工作流自动化中的下一个任务，适用于具备智能排序功能的持续开发流程。

输入架构：

{
  "number": "current-task-number (e.g., 'CRD-1')"
}

使用示例：

• 用户提示词：“AI，我刚完成 CRD-1。接下来是什么？”
• **AI 操作：**调用 next_task，并传入 arguments: { "number": "CRD-1" }。
• **结果：**AI 收到 CRD-2 的详情，并可在验证前置条件和获取上下文指导的基础上，无缝继续工作流。

👩‍💻 贡献者与开发者

想要添加新工具或修改现有工具？请查看全面的 工具开发指南，内容涵盖：

• 命名约定，确保工具设计一致
• 描述指南（“是什么 + 何时使用”模式）
• 输入架构最佳实践，包含详细的属性说明
• 元数据结构，提升工具的可发现性
• 完整示例，助你快速上手

本指南确保所有工具都遵循 Anthropic 的工具搜索最佳实践，同时保持向后兼容性。

💡 技术亮点

• 🧠 AI 原生工作流优化： 先进的 Agent 指令系统，结合 MCP 2025 结构化工具输出和智能工作流编排，提升 AI 生产力。
• 🔄 智能任务排序： 前置条件验证、状态感知指导，以及自动化工作流阶段（发现 → 上下文 → 分析 → 实施 → 完成）。
• 安全优先设计： 全面的输入验证、带重试逻辑的安全 API 客户端，以及工作区范围的身份验证，确保数据完整性和 AI 操作安全。
• 可用于生产环境的可靠性： 指数退避重试机制、90 秒超时，以及稳定的 MCP SDK 版本（^1.0.3），提供企业级稳定性。
• 以工作区为中心的身份验证： API 密钥与特定工作区绑定。所有操作都会自动限定在相应工作区内，简化请求并增强安全性。无需传递 workspaceId！
• 用户友好的标识符： 使用易读的编号（例如“ TCA-3”）和 slug（例如“TCA”）与任务和项目交互，而非内部 UUID。
• 针对 AI 效率进行了优化： 精简的 JSON 响应可最大限度地减少 token 用量，智能错误处理可避免在验证错误时进行不必要的重试。
• 稳健的 API 交互： 使用官方 CodeRide API（默认地址为 https://api.coderide.ai），并为所有操作提供全面的日志记录和错误处理。

🛡️ 安全

CodeRide MCP 高度重视安全。我们欢迎负责任的安全研究，并已设立全面的漏洞赏金计划，奖励金额从 €9 到 €119 不等。

如需报告安全漏洞，请参阅我们的安全政策，了解报告指南和奖励信息。

🔧 最新改进

v0.9.3 - 交互式安装向导 🧙

• 🎯 CLI 安装向导：使用 npx @coderide/mcp add 进行交互式设置，轻松完成配置
• 🔍 自动检测：自动检测已安装的 MCP 客户端（Cursor、Claude Desktop、Claude Code、VS Code、Codex CLI）
• 🎨 增强的用户体验：清晰的向导输出，带有状态指示器和品牌色彩
• ⚙️ 智能配置管理：检测配置是否未发生变化，避免不必要的写入，并自动创建备份
• 🚀 CLI 标志：使用 --no-open 跳过打开浏览器，使用 --force 显示所有客户端
• 📝 多格式支持：同时支持 JSON（大多数客户端）和 TOML（Codex CLI）配置格式
• 🔒 默认安全：以限制性权限（0o600）写入配置文件，并验证 API 密钥

v0.9.0 - 全面的 Agent 工作流增强 🚀

• 🧠 NLP 识别系统：智能识别自然语言中的项目引用和用户意图，提升 Agent 理解能力
• 🧪 强制测试验证：全面的测试流程，支持单元测试和集成测试，并验证覆盖率（单元测试 80%，集成测试 90%）
• 📝 自动 Git 提交：全面遵循 Conventional Commits 1.0.0，支持语义化版本控制和自动生成提交
• 🎯 项目知识优化：通过一致性验证和标准化架构，智能管理项目知识
• ⚡ 增强的 Agent 指令：MCP 2025 结构化工具输出，提供工作流智能支持和基于阶段的指导
• 🔒 安全与性能：输入验证、防止命令注入、单例模式和全面的错误处理
• 🔄 完整的工作流自动化：包含发现 → 上下文 → 分析 → 实施 → 完成阶段，并进行智能排序

v0.8.0 - Agent 工作流优化

• 🧠 智能 Agent 指令：实现了全面的 Agent 指令系统，并支持 MCP 2025 结构化工具输出
• 🔄 工作流编排：新增前置条件验证、状态感知指导和自动化工作流阶段
• 📁 工具组织优化：统一工具命名（project_list → list_projects、task_list → list_tasks）
• ⚡ 提升 AI 生产力：全部 9 个工具现在都包含上下文指导、自动化提示和工作流智能能力
• 🔒 保持兼容性：与现有集成和安全系统 100% 向后兼容

以往改进

• 增强可靠性：实现指数退避重试逻辑，提升连接稳定性
• 优化超时设置：将 API 超时时间增加到 90 秒，以便更好地处理复杂操作
• 稳定依赖项：将 MCP SDK 固定为稳定版本（^1.0.3），确保行为一致
• MCP 协议优化：减少超时错误（-32001）和 SSE 流断连

🔥 关于 CodeRide

CodeRide 是 AI 与人类开发者携手并进、更快构建优质软件的地方。

它不只是一个任务管理工具，而是一个原生面向 AI 的平台，从底层构建，旨在支持 AI 辅助软件开发的独特工作流。CodeRide 提供 AI Agent 理解复杂项目、有意义地参与开发并与人类伙伴有效协作所需的结构化上下文、项目知识和外部记忆。

借助真正理解人类创造力与人工智能协同效应的工具，变革您的开发流程。

在 coderide.ai 探索软件开发的未来。

🔧 故障排除

常见问题

连接超时或 MCP 错误 -32001：

• 最近的改进已大幅减少此类问题
• 确保使用的是最新版本：npx -y @coderide/mcp@latest
• 检查环境配置中是否正确设置了 API 密钥

身份验证错误：

• 确认您的 CodeRide API 密钥有效且具有正确的权限
• 确保已在 MCP 客户端配置中正确设置 API 密钥
• API 密钥的作用范围限于工作区，请确保使用正确的工作区

找不到工具错误：

• 配置更改后，重启 MCP 客户端
• 确认服务器已在 MCP 客户端设置中正确配置

如需更多支持，请附上详细的错误信息提交问题。

🤝 参与贡献

欢迎贡献！您可以提交问题、复刻仓库并创建拉取请求。

有关安全相关贡献，请参阅我们的安全策略。

🔖 许可证

保留所有权利。详情请参阅 LICENSE 文件。

🤗 支持与社区

• 对 @coderide/mcp 有疑问或需要帮助？请在我们的 GitHub 仓库中提交问题。
• 想进一步了解 CodeRide？请访问 coderide.ai 或加入我们的社区（如有社区论坛或 Discord，请在此提供链接）。