🔍🐙 Octocode

Use Octocode. Smart Search. Any Code.

Octocode.ai • GitHub Repository • Report Issues

Overview

Transform GitHub into instant AI knowledge.

Octocode is the leading AI-powered GitHub code intelligence platform. This extension configures the Octocode MCP Server as a local agent, enabling your AI assistant (Cursor, Windsurf, VS Code Copilot, Claude) to perform deep research, architectural analysis, and pattern discovery across millions of public and private repositories.

Requirements

• Node.js: v20 or higher
• GitHub Account: Authorized user
  • gh CLI -> gh auth login
  • GITHUB_TOKEN env param

Prompts Menu

Start with /help or /init to get started!

/init

Context Gathering Interactive interview to establish user role, goals, and constraints. Creates .octocode/context/context.md.

/research

Code Forensics & Discovery Deep code discovery, pattern analysis, and bug investigation. Uses parallel bulk queries & staged analysis to prove flows.

/plan

Adaptive Research & Implementation Research, Plan & Implement complex tasks. Breaks down tasks, finds patterns, and guides execution (Interactive/Auto).

/generate

App Scaffolding Research-driven stack selection and project setup. "Measure twice, cut once" approach to new projects.

/review_pull_request

PR Review (Args: prUrl) Defects-First PR review. Focuses on bugs, security, complexity, and code quality.

/review_security

Security Audit (Args: repoUrl) Risk assessment and vulnerability surfacing. Maps attack surface and investigates specific risks.

Tools Available

All tools support bulk operations (1-3 queries).

Note: Octocode also supports NPM for smart research and dependency analysis.

Installation Example

You can configure Octocode manually in your MCP settings (Cursor, Claude, etc.) using the examples below.

Prerequisites

• GitHub CLI: https://cli.github.com/ (Recommended)
• Tokens (only repo read permission is required!):
  • Classic Token: https://github.com/settings/tokens/new
  • Fine-grained Token: https://github.com/settings/personal-access-tokens/new

Mac / Linux Default (GitHub CLI)

Use this if you have gh installed and authenticated (gh auth login).

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

Windows Default / With PAT

Use this if you need to provide a Personal Access Token directly.

{
  "octocode": {
    "command": "npx",
    "args": [
      "octocode-mcp@latest"
    ],
    "env": {
      "GITHUB_TOKEN": "ghp_your_token_here"
    }
  }
}

Troubleshooting

For any issues with installation or authentication, please visit: https://octocode.ai/?auth=cli#installation

For more details on features, prompts, and documentation, visit octocode.ai.

Supported IDEs & AI Assistants

This extension works with all major AI-powered editors and assistants:

Editors (Auto-Detection)

AI Assistants & Other Clients (Manual Install)

GitHub Token Configuration

Option 1: Via VS Code Extension (Recommended)

The easiest way to configure your GitHub token:

1. Open VS Code Settings (Cmd/Ctrl + ,)
2. Search for "Octocode"
3. Enter your GitHub token in "Octocode: Github Token"
4. Restart your editor

The extension automatically:

• Detects your editor type
• Writes the token to the correct MCP config file
• Passes GITHUB_TOKEN as an environment variable to the MCP server

Option 2: Via GitHub CLI (Zero Config)

If you have gh CLI installed and authenticated:

gh auth login

Octocode automatically uses your gh CLI credentials - no token configuration needed!

Option 3: Manual MCP Configuration

Add directly to your MCP config file:

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

Token Permissions Required

Only read permissions are needed:

• repo (for private repos) or public_repo (for public only)
• Create tokens at: github.com/settings/tokens

What This Extension Does

This extension automatically configures the Octocode MCP server for your editor and AI assistants:

Commands

Note: The extension auto-installs the MCP configuration on first activation. Restart your editor to enable it.