Octocode MCP

🚀 Octocode MCP

Octocode MCP 是一款完美的 AI 代碼助手，具備高級搜索功能，可在 GitHub 上進行全面的代碼發現。它能讓你的 AI 助手瞬間變身專業的代碼研究員，讓你能即時訪問 GitHub 和 npm 生態系統中的數百萬個代碼庫和軟件包。

🚀 快速開始

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，並能自動檢測路徑。
• 通用訪問：可與公共、私有和組織代碼庫無縫協作。

📦 安裝指南

安裝先決條件

• macOS/Linux：使用 brew 命令安裝 Node.js 和 GitHub CLI。
• Windows：可使用 WinGet、Chocolatey 或 Scoop 進行安裝。

身份驗證

使用 gh auth login 登錄 GitHub，使用 npm login 登錄 NPM。

添加到 Claude Desktop 或手動配置

可通過命令添加到 Claude Desktop，也可手動修改配置文件。

💻 使用示例

基礎用法

你可以向 Octocode MCP 提出以下問題：

• “React 是如何實現併發渲染的？”
• “給我展示 Next.js 應用程序中的身份驗證模式”
• “查找使用此特定 API 的示例”
• “這個庫的架構是什麼樣的？”
• “如何有效地使用這個 MCP 工具？”

📚 詳細文檔

深入的項目研究與分析

• 問題搜索與分析：瞭解項目挑戰、功能請求和錯誤模式。
• 提交歷史研究：跟蹤功能實現和錯誤修復的時間線。
• 拉取請求與代碼審查分析：查看實際的代碼差異，理解開發工作流程。
• 項目進度跟蹤：監控開發速度和團隊協作模式。

核心 GitHub 研究

• 代碼庫發現：按主題、語言和活動查找代碼庫。
• 代碼搜索：在數百萬個代碼庫中查找確切的模式和實現。
• 跨代碼庫流程理解：關聯多個代碼庫中的相關更改。
• 代碼庫架構：導航並理解項目結構。

軟件包生態系統工具

• NPM 軟件包發現：分析 Node.js 軟件包的綜合元數據。
• Python 軟件包集成：通過跨生態系統比較探索 PyPI 軟件包。
• 軟件包分析：深入研究版本、依賴項和代碼庫連接。

高級研究能力

• 代碼模式發現：識別實現模式和最佳實踐。
• 安全與合規研究：在代碼庫中搜索安全模式。
• 團隊協作分析：理解代碼審查流程和團隊動態。
• 即時文檔生成：根據即時代碼為任何主題生成自定義文檔。

🔧 技術細節

本地優先架構

• 100% 本地運行：完全在你的機器上運行。
• 零數據收集：不進行遙測或數據傳輸。
• 安全身份驗證：使用 GitHub CLI OAuth，無需個人令牌。

企業安全

• 內容保護：進行輸入驗證和內容清理。
• 秘密檢測：自動檢測並編輯敏感數據模式。
• 僅安全命令：僅使用預批准的 GitHub CLI 和 NPM 命令。

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 認證，無需個人令牌。

企業安全

• 內容保護：輸入驗證和內容清理。
• 秘密檢測：自動檢測和編輯敏感數據。
• 安全命令：僅使用預批准的命令。

💭 背景

該項目最初是作者在 Wix 工作時的個人工具，源於在大型代碼庫中導航和跟上快速發展的技術環境的挑戰。從一個副業項目逐漸演變成了這個能幫助理解任何代碼的完美代碼助手。目標是讓代碼探索變得像有一位資深開發者指導你瀏覽任何代碼庫一樣智能。

📄 許可證

本項目採用 MIT 許可證，詳情請見 LICENSE。

🌟 特色展示

modelcontextprotocol - 官方社區 MCP 服務器

社區集合

MCP 目錄與工具

🌐 更多詳情

請訪問 octocode.ai。

🐳 Docker 支持

可在 Docker 容器中運行 Octocode MCP，同時保持完整的 GitHub CLI 身份驗證，非常適合一致的環境和部署。

💬 加入我們的社區

點擊 Discord 加入社區，獲取有用的更新並參與討論。

💡 使用建議

提出自然問題

可以像與資深開發者交流一樣，提出如 “這個項目中的身份驗證是如何工作的？” 等問題。

讓 AI 引導發現

• 從寬泛的查詢開始，系統會智能縮小範圍。
• 相信智能回退機制，自動嘗試替代方案。
• 基於之前的搜索繼續深入探索，保持上下文連貫。
• 可在公共、私有和組織代碼庫中使用。

⚠️ 重要提示 如需詳細的技術架構、工具規格和實現細節，請參閱 技術總結。如需全面的安全架構細節，也請參閱 技術總結。