Octocode MCP

🚀 Octocode MCP

Octocode MCP 是一款完美的 AI 代码助手，它具备高级搜索功能，可在 GitHub 上进行全方位的代码发现。借助它，你能瞬间访问 GitHub 和 npm 生态系统中的数百万个代码仓库和软件包，将你的 AI 助手转变为专业的代码研究员。

🚀 快速开始

1. 安装先决条件

macOS/Linux：

# 安装 Node.js 18.12+
brew install node

# 安装 GitHub CLI
brew install gh

Windows：

# 使用 WinGet 安装（推荐）
winget install Microsoft.PowerShell  # PowerShell 7+ 以获得更好的安全性
winget install GitHub.cli
winget install OpenJS.NodeJS

# 或者使用 Chocolatey 安装
choco install powershell-core nodejs github-cli

# 或者使用 Scoop 安装
scoop install gh nodejs

2. 进行身份验证

# 登录 GitHub（会打开浏览器）
gh auth login

# 登录 NPM（用于软件包研究）
npm login

3. 添加到 Claude Desktop

# 对于 Claude Desktop 用户
claude mcp add octocode npx 'octocode-mcp@latest'

或者手动添加到 MCP 配置

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

就是这么简单！ Octocode 会自动与你所在组织的私有代码仓库配合使用。

✨ 主要特性

广泛的适用人群

• 开发者：能够轻松应对复杂的多仓库架构，理解大规模的组织性问题，并根据实际代码示例按需生成自定义文档。可以直接在 IDE 中创建上下文相关的文档，或者让 OctoCode 从任何仓库中学习，并在当前项目中实现类似的模式。
• 产品与工程经理：通过语义代码搜索，深入了解应用程序的行为，跟踪团队的开发进度，掌握产品特性背后的实际实现。
• 安全研究人员：利用高级模式匹配和跨代码库分析，在公共和私有代码仓库中发现安全模式、漏洞和合规性问题。
• 大型组织：使团队能够立即从现有代码库中学习，理解跨团队的实现方式，并复制经过验证的模式，从而显著提高开发速度，将机构知识转化为可操作的开发加速动力。

关键优势

• 零配置设置：可与现有的 GitHub CLI 身份验证配合使用，无需个人访问令牌。
• 企业级安全：通过内容清理，尊重组织权限。
• AI 令牌优化：通过智能内容处理降低 AI 成本。
• 跨平台卓越性能：原生支持 Windows PowerShell，并能自动检测路径。
• 通用访问：可与公共、私有和组织代码仓库无缝协作。

强大的功能

• 深度项目研究与分析：
  • 问题搜索与分析：了解项目挑战、功能请求和错误模式。
  • 提交历史研究：跟踪功能实现和错误修复的时间线。
  • 拉取请求与代码审查分析：查看实际的代码差异，理解开发工作流程。
  • 项目进度跟踪：监控开发速度和团队协作模式。
• 核心 GitHub 研究：
  • 代码仓库发现：按主题、语言和活动查找代码仓库。
  • 代码搜索：在数百万个代码仓库中查找精确的模式和实现。
  • 跨代码仓库流程理解：关联多个代码仓库中的相关更改。
  • 代码仓库架构：浏览和理解项目结构。
• 软件包生态系统工具：
  • NPM 软件包发现：分析具有全面元数据的 Node.js 软件包。
  • Python 软件包集成：通过跨生态系统比较探索 PyPI 软件包。
  • 软件包分析：深入研究版本、依赖项和代码仓库连接。
• 高级研究能力：
  • 代码模式发现：识别实现模式和最佳实践。
  • 安全与合规研究：在代码库中搜索安全模式。
  • 团队协作分析：了解代码审查流程和团队动态。
  • 实时文档生成：根据实时代码为任何主题生成自定义文档。

特色展示

• modelcontextprotocol - 官方社区 MCP 服务器：
• 社区集合：
• MCP 目录与工具：

📦 安装指南

Docker 支持

可以在 Docker 容器中运行 Octocode MCP，同时保持完整的 GitHub CLI 身份验证。这非常适合创建一致的环境和进行部署。

💻 使用示例

最佳实践

提出自然的问题

• "这个项目中的身份验证是如何工作的？"
• "哪些库实现了这种模式？"
• "给我展示解决 X 问题的 NPM 软件包"
• "这种方法随着时间的推移是如何演变的？"

让 AI 引导发现

• 从宽泛的查询开始，系统会智能地缩小范围。
• 相信智能回退机制，它会自动尝试替代方案。
• 基于之前的搜索继续探索，保持上下文以进行更深入的研究。
• 适用于所有类型的代码仓库，包括公共、私有和组织代码仓库。

📚 详细文档

DXT 扩展

本项目提供了 桌面扩展 (DXT)，可方便地安装到像 Claude Desktop 这样的 AI 应用程序中。

快速 DXT 设置

# 安装依赖项
yarn install

# 构建 DXT 软件包
yarn dxt:pack

生成的 octocode-mcp.dxt 文件可以通过简单的点击操作安装到 Claude Desktop 中。

DXT 脚本：

• yarn dxt:validate - 验证 manifest.json 文件。
• yarn dxt:pack - 构建并打包扩展。
• yarn dxt:release - 完整的发布流程（构建 → 打包 → 签名 → 验证）。

故障排除

跨平台命令

# 检查 GitHub CLI 状态
gh auth status

# 如有需要，重新进行身份验证
gh auth logout && gh auth login

# 检查 NPM 访问权限
npm whoami

Windows 特定问题

# 检查 PowerShell 版本（推荐 7+）
$PSVersionTable.PSVersion

# 测试可执行文件检测
where.exe gh
where.exe npm

常见解决方案

• 没有搜索结果？尝试使用更宽泛的搜索词。
• 找不到私有代码仓库？检查 gh auth status 中的组织成员身份。
• Windows 出现问题？安装 PowerShell 7+ 以获得更好的安全性。
• 权限错误？检查可执行文件权限和 PATH 配置。

安全与隐私

本地优先架构

• 🏠 100% 本地运行 - 完全在你的机器上运行。
• 🚫 零数据收集 - 不进行遥测或数据传输。
• 🔑 安全身份验证 - 使用 GitHub CLI OAuth，无需个人令牌。

企业安全

• 🛡️ 内容保护 - 进行输入验证和内容清理。
• 🔐 秘密检测 - 自动检测并编辑敏感数据模式。
• ⚪ 仅使用安全命令 - 仅使用预先批准的 GitHub CLI 和 NPM 命令。

📚 有关全面的安全架构详细信息，请参阅 技术总结

背景

本项目最初是作者在 Wix 工作时的一个个人工具，源于在大型代码库中导航和跟上快速发展的技术领域的挑战。最初的一个副业项目逐渐演变成了 一款能够帮助理解任何代码的完美代码助手。

目标是：让代码探索变得像有一位资深开发者引导你浏览任何代码库一样智能。

🔧 技术细节

更多详情

• 🌐 更多信息 - octocode.ai
• 📚 技术细节 - 技术总结
• 💬 加入我们的社区 - Discord - 关注有用的更新和讨论

📄 许可证

本项目采用 MIT 许可证，详情请参阅 LICENSE。