README Documentation
Octocode: Research Driven Development for AI
Stop Guessing. Start Knowing.
Empower your AI assistant with the skills of a Senior Staff Engineer.
Installation
Prerequisites: GitHub authentication required. See Authentication Setup.
Recommended: Octocode CLI
npx octocode-cli
Interactive setup wizard with GitHub OAuth, MCP server installation, and skills marketplace.
Alternative Methods
One-Click Install (Cursor)
Manual MCP Configuration
Add to your MCP configuration file:
{
"mcpServers": {
"octocode": {
"command": "npx",
"args": ["octocode-mcp@latest"]
}
}
}
Research Skill (Direct Install)
npx add-skill https://github.com/bgauryy/octocode-mcp/tree/main/skills/octocode-research
MCP Server
The Octocode MCP Server connects your AI assistant to code:
- GitHub & GitLab: Search repositories, find usage patterns, read implementations, explore PRs
- Local Tools: Search code, browse directories, find files in your local codebase
- LSP Intelligence: Go to Definition, Find References, Call Hierarchy -- compiler-level understanding
https://github.com/user-attachments/assets/de8d14c0-2ead-46ed-895e-09144c9b5071
Skills
Agent Skills are a lightweight, open format for extending AI agent capabilities. Skills index: skills/README.md
| Skill | What it does |
|---|---|
| Research | Deep code exploration via LSP, local tools, GitHub API, packages, PRs |
| Local Search | Fast local codebase exploration with LSP semantic navigation |
| Plan | Evidence-based planning: Understand, Research, Plan, Implement |
| PR Reviewer | PR review across 7 domains with evidence-backed findings |
| Roast | Brutally honest code critique with file:line citations |
| Prompt Optimizer | Transform weak prompts into enforceable agent protocols |
| Documentation Writer | Generate comprehensive repo documentation in 6 phases |
https://github.com/user-attachments/assets/5b630763-2dee-4c2d-b5c1-6335396723ec
Documentation
For the full documentation index, start here: docs/README.md
Recommended quick links:
- Authentication Setup
- Configuration Reference
- Local Tools + LSP Reference
- CLI Skills Guide
- Skills Index
- Troubleshooting
The Manifest
"Code is Truth, but Context is the Map." -- Read the Manifest for Research Driven Development to understand the philosophy behind Octocode.
Contributing
See the Development Guide for monorepo setup, testing, and contribution guidelines.