Coderide MCP

🚀 用CodeRide任务管理为你的AI助手或IDE赋能

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

想象一下，你的AI不仅能编写代码，还能真正理解项目上下文、管理自身任务并与你无缝协作。再也无需无尽的复制粘贴或手动更新。有了CodeRide MCP，你的AI将成为CodeRide工作流程中的重要一员。

🚀 快速开始

为何CodeRide MCP是变革性工具

• 让AI深度理解项目：为你的AI代理提供来自CodeRide项目和任务的丰富、结构化上下文，使其能够把握全局。
• 实现无缝的AI任务自动化：使AI能够直接在CodeRide中获取、解释和更新任务，自动执行日常项目管理工作。
• 弥合人类与AI开发者之间的差距：通过更顺畅的交接、一致的任务理解和协同努力，促进真正的协作。
• 优化大语言模型效率：紧凑的JSON响应可减少令牌使用量，确保AI交互更快、成本更低。
• 设计安全可靠：工作区范围的API密钥认证可确保数据的完整性，并将AI操作限制在正确的项目上下文中。
• 即插即用集成：在任何兼容MCP的环境中使用npx即可轻松设置。几分钟内即可让你的AI连接就绪！
• 让工作流程面向未来：采用基于开放模型上下文协议标准构建的AI原生开发方法。

安装步骤

通过Smithery安装

要通过Smithery自动为Claude Desktop安装Coderide MCP服务器，请执行以下命令：

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

让CodeRide MCP运行并集成到你的AI代理环境中非常容易。

前提条件：

1. Node.js和npm：确保你已安装Node.js（其中包含npm）。npx随npm一起提供。
2. CodeRide账户和API密钥：此MCP服务器专为注册的CodeRide用户设计。你需要一个活跃的CodeRide账户和一个API密钥，你可以在app.coderide.ai的工作区设置中获取。

MCP配置： 将以下配置添加到你的MCP客户端（例如Claude Desktop的claude_desktop_config.json、Cursor、Cline、Windsurf、VS Code设置等）：

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

重要提示：

• 请将"YOUR_CODERIDE_API_KEY_HERE"替换为你实际的CodeRide API密钥。

配置完成后，你的MCP客户端将自动启动并连接到CodeRide MCP服务器，使其工具可用于你的AI与CodeRide上的项目和任务进行交互。

✨ 主要特性

核心功能

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

• 任务检索：通过唯一编号获取特定任务。
• 任务更新：修改任务描述和状态。
• 获取提示：获取针对特定任务的定制提示和说明。
• 项目详情：通过项目别名检索项目信息。
• 项目知识管理：更新项目的知识图谱和架构图。
• 项目启动：获取项目的第一个任务以启动工作。

适用人群

CodeRide MCP适用于：

• 使用AI编码助手的开发者：将你的AI工具（如Cursor、Cline、Windsurf等）与CodeRide任务管理深度集成。
• 采用AI驱动开发的团队：规范AI代理访问项目信息和参与任务的方式。
• 任何使用MCP进行开发的人员：利用一个强大的MCP服务器示例，该服务器可连接到实际的SaaS平台。

如果你希望让你的AI助手成为开发团队中更高效、更具集成性的成员，那么CodeRide MCP就是为你准备的。

💻 使用示例

可用工具

以下是CodeRide MCP提供的工具及其使用方法：

get_task

通过任务编号（例如 "TCA-3"）检索特定任务的详细信息。

输入架构：

{
  "number": "task-number (e.g., 'TCA-3')",
  "status": "to-do|in-progress|completed", // 可选：按状态过滤
}

示例用例：

• 用户提示：“嘿，AI，任务APP-101的详细信息是什么？”
• AI操作：调用get_task，参数为{ "number": "APP-101" }。
• 结果：AI获取任务APP-101的标题、描述、状态、优先级和其他上下文信息。

update_task

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

输入架构：

{
  "number": "task-number-identifier",
  "description": "updated-task-description", // 可选
  "status": "to-do|in-progress|completed"   // 可选
}

示例用例：

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

get_prompt

检索为AI代理处理给定任务而定制的特定提示或说明。

输入架构：

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

示例用例：

• 用户提示：“AI，我准备开始处理任务ETF-7。主要目标是什么？”
• AI操作：调用get_prompt，参数为{ "slug": "ETF", "number": "ETF-7" }。
• 结果：AI获取FEAT-7的特定可操作提示，从而能够明确开始工作。

get_project

使用项目别名检索特定项目的详细信息。

输入架构：

{
  "slug": "project-slug (e.g., 'TCA')",
  "name": "optional-project-name" // 也可以按名称检索
}

示例用例：

• 用户提示：“AI，你能给我介绍一下‘Omega Initiative’项目的概况吗？”
• AI操作：调用get_project，参数为{ "slug": "omega-initiative" }。
• 结果：AI获取项目的名称、描述以及可能的知识库或图表链接。

update_project

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

输入架构：

{
  "slug": "project-slug-identifier",
  "project_knowledge": { /* 表示知识图谱的JSON对象 */ }, // 可选
  "project_diagram": "/* Mermaid图表字符串或类似内容 */"             // 可选
}

示例用例：

• 用户提示：“AI，我已经更新了用户认证流程。请更新项目‘APB’的项目图表。”
• AI操作：（生成/接收新图表后）调用update_project，参数为{ "slug": "APB", "project_diagram": "/* new mermaid diagram */" }。
• 结果：CodeRide中的‘AlphaProject’现在具有更新后的架构图。

start_project

检索给定项目的第一个或下一个推荐任务，使AI能够开始工作。

输入架构：

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

示例用例：

• 用户提示：“AI，让我们开始‘MobileAppV2’项目。第一个任务是什么？”
• AI操作：调用start_project，参数为{ "slug": "MBC" }。
• 结果：AI获取‘MBC’项目的初始任务详细信息，准备开始工作。

🔧 技术细节

• 以工作区为中心的认证：API密钥与特定工作区绑定。所有操作自动限定范围，简化请求并增强安全性。无需传递workspaceId！
• 用户友好的标识符：使用人类可读的编号（例如 "TCA-3"）和别名（例如 "TCA"）与任务和项目进行交互，而不是使用内部UUID。
• 优化响应：所有工具均返回紧凑的JSON，减少大语言模型通信的令牌使用量。
• 强大的API交互：所有操作均使用官方CodeRide API（默认https://api.coderide.ai）。

📚 详细文档

关于CodeRide

CodeRide是AI与人类开发者携手合作、更快构建更好软件的平台。

它不仅仅是任务管理工具，更是一个从底层构建的AI原生平台，旨在支持AI辅助软件开发的独特工作流程。CodeRide提供了AI代理理解复杂项目、有意义地做出贡献并与人类同行有效协作所需的基本结构化上下文、项目知识和外部内存。

用一个真正理解人类智慧与人工智能协同作用的工具来改变你的开发过程。

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

贡献代码

欢迎贡献代码！请随时提交问题、分叉仓库并创建拉取请求。

许可证

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

支持与社区

• 对@coderide/mcp有疑问或需要帮助？请在我们的GitHub仓库提交问题。
• 想了解更多关于CodeRide的信息？请访问coderide.ai或加入我们的社区（如果有社区论坛/Discord链接）。