Octocode：以研究驱动的 AI 开发

停止猜测，开始洞察。

用资深技术专家的能力赋能你的 AI 助手。

octocode.ai

安装

先决条件：需要 GitHub 身份验证。请参阅 身份验证设置。

推荐：Octocode CLI

npx octocode-cli

交互式设置向导，支持 GitHub OAuth、MCP 服务器安装以及技能市场。

其他方法

{
  "mcpServers": {
    "octocode": {
      "command": "npx",
      "args": ["octocode-mcp@latest"]
    }
  }
}

npx add-skill https://github.com/bgauryy/octocode-mcp/tree/main/skills/octocode-research

MCP 服务器

Octocode MCP 服务器 将你的 AI 助手与代码连接起来：

• GitHub 和 GitLab：搜索仓库、查找使用模式、阅读实现、探索 PR
• 本地工具：搜索代码、浏览目录、在本地代码库中查找文件
• LSP 智能：跳转到定义、查找引用、调用层次结构——具备编译器级别的理解

https://github.com/user-attachments/assets/de8d14c0-2ead-46ed-895e-09144c9b5071

技能

Agent Skills 是一种轻量级、开放的格式，用于扩展 AI 代理的能力。 技能索引：skills/README.md

https://github.com/user-attachments/assets/5b630763-2dee-4c2d-b5c1-6335396723ec

文档

如需完整的文档索引，请从这里开始： docs/README.md

推荐快速链接：

• 身份验证设置
• 配置参考
• 本地工具 + LSP 参考
• CLI 技能指南
• 技能索引
• 故障排除

行动纲领

“代码是真理，但上下文才是地图。” —— 阅读 以研究驱动开发的行动纲领，了解 Octocode 背后的哲学。

贡献

请参阅 开发指南，了解 monorepo 设置、测试及贡献规范。

Octocode-MCP 快速上手指南

Octocode 是一款基于“研究驱动开发”理念的 AI 工具，旨在通过 MCP（Model Context Protocol）赋予 AI 助手资深工程师的能力。它支持连接 GitHub/GitLab、本地代码库及 LSP（语言服务器协议），让 AI 能够真正理解代码上下文、搜索实现模式并执行深度代码审查。

环境准备

在开始之前，请确保满足以下前置条件：

• 操作系统：支持 macOS、Linux 或 Windows (WSL)。
• Node.js 环境：需安装 Node.js (推荐 v18+) 以运行 npx 命令。
• GitHub 账号：必须拥有 GitHub 账号并完成认证配置。
  • 注意：首次使用前，请务必阅读并配置 GitHub 认证设置，否则无法拉取远程仓库数据。
• AI 编辑器：推荐使用支持 MCP 协议的编辑器（如 Cursor、VS Code + MCP 插件等）。

提示：国内开发者若遇到 npm 源连接缓慢问题，建议在终端临时配置淘宝镜像源：

export NPM_CONFIG_REGISTRY=https://registry.npmmirror.com

安装步骤

你可以根据需求选择以下任意一种方式进行安装：

方式一：使用 Octocode CLI（推荐）

这是最完整的安装方式，包含交互式向导、GitHub OAuth 授权、MCP 服务器安装及技能市场访问。

npx octocode-cli

运行后跟随终端提示完成配置即可。

方式二：Cursor 编辑器一键安装

如果你使用的是 Cursor 编辑器，可直接点击下方链接自动配置：

方式三：手动配置 MCP

如果你需要自定义 MCP 配置文件（通常在 ~/.mcp.json 或编辑器的 MCP 设置中），请添加以下内容：

{
  "mcpServers": {
    "octocode": {
      "command": "npx",
      "args": ["octocode-mcp@latest"]
    }
  }
}

基本使用

安装完成后，Octocode 将以“技能（Skills）”的形式增强你的 AI 助手。你可以在对话中直接调用这些能力。

1. 激活技能

在支持 MCP 的聊天窗口中，尝试询问以下类型的问题，AI 将自动调用相应的 Octocode 技能：

• 代码研究与探索：

  "帮我查找项目中所有使用 axios 发起 POST 请求的地方，并分析其错误处理逻辑。" (触发技能：Researcher / Research)

• 深度代码审查：

  "请作为资深工程师审查当前打开的文件，重点检查潜在的性能瓶颈和安全性问题。" (触发技能：Engineer / Roast / PR Reviewer)

• 技术方案规划：

  "我需要添加一个用户登录功能，请基于现有代码结构生成一份包含权衡分析的技术实施方案 (RFC)。" (触发技能：Plan / RFC Generator)

2. 核心能力示例

Octocode 不仅仅是聊天，它能执行具体操作：

• 跨仓库搜索：直接在对话中搜索 GitHub 上的开源项目实现模式。
• LSP 智能感知：利用编译器级别的理解为 AI 提供“跳转到定义”、“查找引用”和“调用层级”信息。
• 本地代码遍历：安全地浏览本地目录结构和文件内容。

3. 进阶：直接安装特定技能

如果你只需要某项特定能力（例如仅需要代码研究功能），可以直接安装该技能包：

npx add-skill https://github.com/bgauryy/octocode-mcp/tree/main/skills/octocode-research

更多详细技能列表与配置参考，请访问官方 Skills Index。