Octocode - Agentic Research Platform

<div align="center"> <img src="https://github.com/bgauryy/octocode/raw/main/packages/octocode-mcp/assets/logo_white.png" width="400px" alt="Octocode Logo">

</div>

Evidence-first code research for AI agents and developers.

Octocode researches your local code and external code alike (GitHub repos, PRs, npm) with one toolset: ripgrep + AST search, trees, precise reads, and LSP. Use it as a CLI or MCP server, backed by a Rust engine for fast, token-efficient results across single files or mega-repos.

---

Table of Contents

• Quick Start
• Why Octocode
• Built for Research (Benchmarks)
• Tools
• MCP
• CLI
• Configuration
• Authentication Methods
• Security
• Language Support
• Skills
• Architecture
• Documentation
• Troubleshooting
• Agent Workflows

---

Quick Start

Prerequisites: Node.js 20.12+

1. Run the Octocode CLI with npx

npx octocode --help

2. Authenticate with GitHub - optional, but unlocks private repositories and higher API rate limits:

npx octocode auth login
npx octocode status       # verify the active token source

3. Choose your interface. Same tools and Rust engine on both. (Clone is on by default in the CLI, opt-in for MCP.)

🖥️ CLI - research straight from your terminal:

npx octocode

🤖 MCP - one-click install:

• <img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">
• <img src="https://img.shields.io/badge/VS_Code-Install_Server-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white" alt="Install in VS Code">

<details> <summary><b>Show more install options (Windsurf, Kiro, Goose, LM Studio, Claude Code)</b></summary> <br>

• <img src="https://img.shields.io/badge/VS_Code_Insiders-Install_Server-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white" alt="Install in VS Code Insiders">
• <img src="https://img.shields.io/badge/Windsurf-Install_Server-1a1a1a?style=flat-square&logoColor=white" alt="Install in Windsurf">
• <img src="https://kiro.dev/images/add-to-kiro.svg" alt="Install in Kiro">
• <img src="https://goose-docs.ai/img/extension-install-dark.svg" alt="Install in Goose">
• <img src="https://files.lmstudio.ai/deeplink/mcp-install-light.svg" alt="Install in LM Studio">

Claude Code:

claude mcp add-json octocode --scope user '{"command":"npx","type":"stdio","args":["octocode-mcp@latest"]}'

</details>

Any other client: npx octocode install

---

Use it as an MCP server

Add to your MCP client config (or use a one-click install above):

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

Put a GitHub token and options under env (see Configuration).

Use it as an agentic-friendly CLI

Just run npx octocode, agents figure out the rest. The bare command prints built-in usage and the full tool catalog, so any coding agent knows how to drive it out of the box, no MCP client or extra wiring required.

npx octocode                                         # self-describing usage for agents
npx octocode tools                                   # list every tool
npx octocode tools localSearchCode --scheme          # inspect a tool's schema

Every MCP tool is also a plain command: JSON in, token-efficient YAML out. Local paths route to local tools; owner/repo[/path] routes to GitHub.

npx octocode tools localSearchCode \
  --queries '{"path":".","searchText":"authenticate","maxFiles":20}'

results:
  - id: localSearchCode-1
    data:
      files:
        - path: src/auth.ts
          matches:
            - line: 12
              value: "export async function authenticate(req: Request) {"

Learn more at octocode.ai.

---

Why Octocode

Agents code better from evidence than from guesses. Octocode researches two worlds with one flow, your local code and external code on GitHub and npm, and hands back compact, citable context before an agent changes, reviews, or explains code. Code is truth; context is the map.

Most tools do one slice (web search, or grep your repo) and hand back a fixed blob. Octocode covers the whole loop and lets the agent decide what data it needs next:

• Agent-driven, efficient flows. Instead of one-shot dumps, Octocode chains cheap steps into an optimized research flow: broad code search, then fetch only the exact matched lines/region, with smart pagination and out-of-the-box minification so the model never over-fetches. Every result carries next-step hints to the cheapest follow-up.
• Scales to monorepos. Spot a pattern in one repo, follow the PR that introduced it, then trace it across other repos and your own files, without leaving the chat. Clone any repo and study it locally.
• Smart GitHub flow. Parallel bulk queries across code, PRs, commits, issues, and repos, all with the same search-broad, read-narrow, trace-semantically discipline.
• Works without GitHub. Clone any repo and point the local tools (search, AST, LSP, content) at it, same evidence-first flow.
• Reads shape, not noise. On-the-fly minify/skeletonize across 70+ languages: a 100 KB file in a few hundred tokens, not walls of boilerplate.
• Fast, self-contained. Search, parsing, navigation, and redaction run in one prebuilt Rust engine: quick on a laptop or a mega-repo, nothing extra to install.
• Safe by default. Every byte to the model is scanned and secrets redacted first (see Security).

What you can do (whenever the next step needs proven context, not a guess):

| Need | Use Octocode to | |------|-----------------| | Codebase questions | Search local or GitHub code, read exact regions, browse trees, and carry file/line anchors into the answer. | | Implementation research | Compare patterns across repositories, npm packages, pull requests, commits, and local files before changing code. | | Semantic navigation | Resolve definitions, references, callers/callees, call hierarchy, hovers, symbols, diagnostics, and type relationships through LSP. | | Structural matching | Run AST-shaped searches with patterns or YAML rules so comments and strings do not become false positives. | | Large-file context | Minify, skeletonize, or paginate code so agents spend tokens on relevant structure instead of boilerplate. | | Agent workflows | Same engine via MCP, CLI, and Agent Skills. |

---

Built for Research (Benchmarks)

A blind, head-to-head test on research-oriented flows — not simple lookups (multi-hop traces, dependency/call-graph chains, commit ranges, blast-radius, PR reviews across repos).

How it works: 30 GitHub questions × 3 passes; Octocode vs gh, gh+Headroom, and gh+RTK on identical questions (only the CLI differs). A blind judge (gpt-5.5) grades correctness; the metric is characters through the model, counted from instrumented logs (chars ≈ tokens). Result: at near-parity correctness, Octocode answers with far fewer characters than every baseline.

▶ Open the interactive report · run it / method · questions · all reports

---

Tools

17 tools in the full catalog. MCP registers 14 by default; the CLI exposes 15 because clone is enabled there by default. ghCloneRepo is opt-in on MCP (ENABLE_CLONE=true), while ghListReleases and ghSearchDiscussions are opt-in on both surfaces. Local tools default on for the CLI and off for the MCP server (ENABLE_LOCAL=true enables them on MCP; ENABLE_LOCAL=false disables on CLI). Flags: Configuration.

Token knobs. concise:true returns path/title-only lists. minify controls file read density: symbols = skeleton with line numbers, standard = comments/blanks stripped (default), none = exact bytes.

GitHub Tools

| Tool | What it does | Knob | |------|--------------|------| | ghSearchCode | Code and path search across GitHub by owner, repo, path, filename, extension, and match filters. Accepts 1 to 5 parallel queries. | concise | | ghGetFileContent | Read a GitHub file or region: full file, line range, match slice, or paginated chars. | minify | | ghViewRepoStructure | Browse a repository's directory tree, plus opt-in repo enrichments. | include | | ghSearchRepos | Discover repositories by keywords, owner, topic, language, stars, updated, license, visibility. | concise | | ghSearchPullRequests | Search pull requests, or deep-read one PR: files, patches, comments, reviews, commits. | content | | ghSearchIssues | Search issues, or read one issue's body and comments. | content | | ghSearchCommits | Walk a repo's commit history, or compare two refs (base+head). | includeDiff | | ghListReleases | List releases + latest, with opt-in assets. Opt-in (ENABLE_RELEASES=true). | includeAssets | | ghSearchDiscussions | Search a repo's Discussions (Q&A, RFCs, announcements) via GraphQL. Opt-in (ENABLE_DISCUSSIONS=true). | keywordsToSearch | | ghCloneRepo | Clone a repo or sparse subtree into the local cache for local/LSP analysis. Opt-in on MCP (