octocode-mcp 3.0.1 β 4.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +285 -161
- package/dist/index.js +1 -1
- package/manifest.json +1 -1
- package/package.json +8 -4
- package/CHANGELOG.md +0 -1115
package/README.md
CHANGED
|
@@ -2,50 +2,87 @@
|
|
|
2
2
|
|
|
3
3
|
**The Perfect AI Code Assistant - Advanced Search & Discovery Across GitHub**
|
|
4
4
|
|
|
5
|
-
<div>
|
|
6
|
-
<
|
|
5
|
+
<div align="center">
|
|
6
|
+
<a href="https://github.com/modelcontextprotocol/servers">
|
|
7
|
+
<img src="https://avatars.githubusercontent.com/u/182288589?s=48&v=4" width="20" height="20" alt="MCP Logo" style="vertical-align: middle; margin-right: 6px;">
|
|
8
|
+
<img src="https://img.shields.io/badge/Model_Context_Protocol-Official_Community_Server-blue?style=flat-square" alt="MCP Community Server" style="vertical-align: middle;">
|
|
9
|
+
</a>
|
|
10
|
+
</div>
|
|
11
|
+
|
|
12
|
+
<div align="center">
|
|
13
|
+
<img src="./assets/logo_white.png" width="400px">
|
|
14
|
+
</div>
|
|
15
|
+
|
|
16
|
+
<div align="center">
|
|
17
|
+
|
|
7
18
|
|
|
8
|
-
[](./package.json)
|
|
9
20
|
[](./package.json)
|
|
10
|
-
[](https://discord.gg/beTNk8at)
|
|
12
|
-
[](https://buymeacoffee.com/bgauryy)
|
|
21
|
+
[](https://x.com/guy_bary)
|
|
13
22
|
|
|
14
23
|
</div>
|
|
15
24
|
|
|
16
|
-
##
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
25
|
+
## π Quick Links
|
|
26
|
+
- π **Website**: [octocode.ai](https://octocode.ai)
|
|
27
|
+
- π **Technical Details**: [Technical Summary](./docs/summary.md)
|
|
28
|
+
- π³ **Docker Setup**: [Docker Guide](./docker/README.Docker.md)
|
|
29
|
+
- π¦ **Follow**: [@guy_bary on X](https://x.com/guy_bary)
|
|
20
30
|
|
|
21
|
-
|
|
31
|
+
## π What is Octocode MCP?
|
|
22
32
|
|
|
23
|
-
|
|
24
|
-
- *"How did React implement concurrent rendering?"*
|
|
25
|
-
- *"Show me authentication patterns in Next.js applications"*
|
|
26
|
-
- *"Find examples of how to use this specific API"*
|
|
27
|
-
- *"What's the architecture of this library?"*
|
|
28
|
-
- *"How do I use this MCP tool effectively?"*
|
|
33
|
+
**The perfect AI code assistant for understanding anything in any codebase.** Transform your AI assistant into an expert code researcher with instant access to millions of repositories and packages across GitHub and npm ecosystems.
|
|
29
34
|
|
|
30
|
-
|
|
35
|
+
**π― Generate Quality Context from Any Resource** - Octocode automatically extracts and synthesizes comprehensive context from repositories, issues, PRs, commits, and packages to power superior code analysis, generation, and documentation creation. Turn any codebase into actionable intelligence for your AI assistant.
|
|
31
36
|
|
|
32
|
-
|
|
33
|
-
[](https://github.com/modelcontextprotocol/servers)
|
|
37
|
+
Discover code through natural language descriptions and intelligent context generation. Perfect for AI-assisted development workflows.
|
|
34
38
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
39
|
+
**What Octocode Can Do:**
|
|
40
|
+
- **π― Create Perfect AI Context** for vibecoding, custom documentation, and complex flow analysis
|
|
41
|
+
- **π’ Works on Private & Public Organizations** - seamlessly access your team's repositories
|
|
42
|
+
- **π Cross-Repository Analysis** - understand connections and dependencies across multiple projects
|
|
43
|
+
- **π» Generate Code** - leverage comprehensive context for superior code generation
|
|
44
|
+
- **π Custom Documentation** - automatically create docs from any codebase or resource
|
|
45
|
+
|
|
46
|
+
> **π See Octocode in Action:**
|
|
47
|
+
>
|
|
48
|
+
> **Three.js Example Generation:**
|
|
49
|
+
> *"Use Octocode to search for Three.js examples, get top examples from top repositories, then create a stunning, hyper-realistic video of a man walking through a futuristic city. Be creative! Blow my mind!"*
|
|
50
|
+
>
|
|
51
|
+
>
|
|
52
|
+
> **Live Code Example:** [View the generated Three.js implementation β](https://gist.github.com/bgauryy/093f9125937f30b00eac03fba688c008)
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
## β¨ Key Features & Benefits
|
|
56
|
+
|
|
57
|
+
**π Dual GitHub Integration** - Works with both GitHub CLI (`gh`) and API tokens (`GITHUB_TOKEN`) for maximum reliability and flexibility (local and hosted)
|
|
58
|
+
|
|
59
|
+
**π§ AI-Optimized Design** - Built specifically for AI assistants with:
|
|
60
|
+
- **Quality Context Generation** from any repository (private / public), issue, PR, commit, or package
|
|
61
|
+
- **Token-efficient responses**
|
|
62
|
+
- **Progressive discovery workflows** that guide exploration
|
|
63
|
+
- **Intelligent context synthesis** for superior code analysis and generation
|
|
64
|
+
- **Smart hint system** for next-step recommendations
|
|
38
65
|
|
|
39
|
-
|
|
40
|
-
[](https://github.com/appcypher/awesome-mcp-servers)
|
|
66
|
+
**π‘οΈ Production-Ready Security** - Automatic secret detection, content sanitization, and organizational permission respect
|
|
41
67
|
|
|
42
|
-
|
|
43
|
-
|
|
68
|
+
**π Universal Compatibility** - Cross-platform native support (Windows, macOS, Linux) with multiple deployment options
|
|
69
|
+
|
|
70
|
+
**π― Vibe Coding Excellence** - Perfect for modern AI-assisted development with natural language code discovery
|
|
71
|
+
|
|
72
|
+
## π Featured On
|
|
73
|
+
|
|
74
|
+
### Official MCP Server
|
|
75
|
+
[](https://github.com/modelcontextprotocol/servers) **modelcontextprotocol/servers**
|
|
76
|
+
|
|
77
|
+
### Community Collections
|
|
78
|
+
- [](https://github.com/punkpeye/awesome-mcp-servers) **punkpeye/awesome-mcp-servers**
|
|
79
|
+
- [](https://github.com/appcypher/awesome-mcp-servers) **appcypher/awesome-mcp-servers**
|
|
80
|
+
- [](https://github.com/Puliczek/awesome-mcp-security) **Puliczek/awesome-mcp-security**
|
|
44
81
|
|
|
45
82
|
### MCP Directories & Tools
|
|
46
|
-
[](https://mcp.so/server/octocode/bgauryy)
|
|
47
|
-
[](https://www.pulsemcp.com/servers/bgauryy-octocode)
|
|
48
|
-
[](https://devtool.io/tool/octocode-mcp)
|
|
83
|
+
- [](https://mcp.so/server/octocode/bgauryy)
|
|
84
|
+
- [](https://www.pulsemcp.com/servers/bgauryy-octocode)
|
|
85
|
+
- [](https://devtool.io/tool/octocode-mcp)
|
|
49
86
|
|
|
50
87
|
## π― Who Is This For?
|
|
51
88
|
|
|
@@ -61,106 +98,58 @@ Discover security patterns, vulnerabilities, and compliance issues across both p
|
|
|
61
98
|
### For Large Organizations
|
|
62
99
|
Dramatically increase development velocity by enabling teams to instantly learn from existing codebases, understand cross-team implementations, and replicate proven patternsβtransforming institutional knowledge into actionable development acceleration.
|
|
63
100
|
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
**Enterprise-Ready Security** - Respects organizational permissions with content sanitization
|
|
69
|
-
|
|
70
|
-
**AI Token Optimization** - Reduces AI costs by through intelligent content processing
|
|
71
|
-
|
|
72
|
-
**Cross-Platform Excellence** - Native Windows PowerShell support with automatic path detection
|
|
73
|
-
|
|
74
|
-
**Universal Access** - Works seamlessly with public, private, and organization repositories
|
|
75
|
-
|
|
76
|
-
## Quick Start π
|
|
101
|
+
### For Beginners & Advanced Vibe Coders
|
|
102
|
+
- **Beginners**: Take code from anywhere and understand it deeply. Learn from production codebases, discover proven patterns, and build confidence by seeing how experienced developers solve problems.
|
|
103
|
+
- **Advanced Vibe Coders**: Leverage quality context for superior code generation. Use comprehensive understanding from issues, PRs, and documentation to generate production-ready code that follows established patterns.
|
|
77
104
|
|
|
78
|
-
|
|
105
|
+
## π Installation
|
|
79
106
|
|
|
80
|
-
**
|
|
81
|
-
```bash
|
|
82
|
-
# Install Node.js 18.12+
|
|
83
|
-
brew install node
|
|
84
|
-
|
|
85
|
-
# Install GitHub CLI
|
|
86
|
-
brew install gh
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
**Windows:**
|
|
90
|
-
```powershell
|
|
91
|
-
# Install using WinGet (recommended)
|
|
92
|
-
winget install Microsoft.PowerShell # PowerShell 7+ for better security
|
|
93
|
-
winget install GitHub.cli
|
|
94
|
-
winget install OpenJS.NodeJS
|
|
95
|
-
|
|
96
|
-
# Or using Chocolatey
|
|
97
|
-
choco install powershell-core nodejs github-cli
|
|
98
|
-
|
|
99
|
-
# Or using Scoop
|
|
100
|
-
scoop install gh nodejs
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
### 2. Authenticate
|
|
104
|
-
```bash
|
|
105
|
-
# Login to GitHub (opens browser)
|
|
106
|
-
gh auth login
|
|
107
|
+
**Octocode supports dual GitHub authentication** - works with both GitHub tokens and GitHub CLI for maximum flexibility.
|
|
107
108
|
|
|
108
|
-
|
|
109
|
-
npm login
|
|
110
|
-
```
|
|
111
|
-
|
|
112
|
-
### 3. Add to Claude Desktop
|
|
109
|
+
### Quick Install
|
|
113
110
|
```bash
|
|
114
|
-
#
|
|
111
|
+
# Add to Claude Desktop (recommended)
|
|
115
112
|
claude mcp add octocode npx 'octocode-mcp@latest'
|
|
116
113
|
```
|
|
117
114
|
|
|
118
|
-
###
|
|
115
|
+
### Authentication Options
|
|
116
|
+
|
|
117
|
+
**Option 1: GitHub Token (Best for Production)**
|
|
118
|
+
1. Create token at [GitHub Settings > Personal access tokens](https://github.com/settings/tokens)
|
|
119
|
+
2. Add to MCP configuration:
|
|
119
120
|
```json
|
|
120
|
-
{
|
|
121
|
-
"
|
|
122
|
-
|
|
123
|
-
|
|
121
|
+
"octocode": {
|
|
122
|
+
"command": "npx",
|
|
123
|
+
"args": ["octocode-mcp"],
|
|
124
|
+
"env": {
|
|
125
|
+
"GITHUB_TOKEN": "ghp_YOUR_TOKEN"
|
|
124
126
|
}
|
|
125
127
|
}
|
|
126
128
|
```
|
|
127
129
|
|
|
128
|
-
**
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
130
|
+
**Option 2: GitHub CLI (Best for Local Development)**
|
|
131
|
+
1. Install GitHub CLI: `brew install gh` (macOS) or `winget install GitHub.cli` (Windows)
|
|
132
|
+
2. Authenticate: `gh auth login`
|
|
133
|
+
3. Add to MCP configuration:
|
|
134
|
+
```json
|
|
135
|
+
"octocode": {
|
|
136
|
+
"command": "npx",
|
|
137
|
+
"args": ["octocode-mcp"]
|
|
138
|
+
}
|
|
139
|
+
```
|
|
137
140
|
|
|
138
|
-
|
|
139
|
-
- **
|
|
140
|
-
- **
|
|
141
|
-
- **
|
|
142
|
-
- **
|
|
143
|
-
|
|
144
|
-
### Core GitHub Research
|
|
145
|
-
- **Repository Discovery**: Find repositories by topic, language, and activity
|
|
146
|
-
- **Code Search**: Find exact patterns and implementations across millions of repositories
|
|
147
|
-
- **Cross-Repository Flow Understanding**: Connect related changes across multiple repositories
|
|
148
|
-
- **Repository Architecture**: Navigate and understand project structures
|
|
149
|
-
|
|
150
|
-
### Package Ecosystem Tools
|
|
151
|
-
- **NPM Package Discovery**: Analyze Node.js packages with comprehensive metadata
|
|
152
|
-
- **Python Package Integration**: Explore PyPI packages with cross-ecosystem comparison
|
|
153
|
-
- **Package Analysis**: Deep-dive into versions, dependencies, and repository connections
|
|
154
|
-
|
|
155
|
-
### Advanced Research Capabilities
|
|
156
|
-
- **Code Pattern Discovery**: Identify implementation patterns and best practices
|
|
157
|
-
- **Security & Compliance Research**: Search for security patterns across codebases
|
|
158
|
-
- **Team Collaboration Analysis**: Understand code review processes and team dynamics
|
|
159
|
-
- **Real-time Documentation**: Generate custom docs from live code for any topic
|
|
141
|
+
**How It Works:**
|
|
142
|
+
- **Token Priority**: `GITHUB_TOKEN` β `GH_TOKEN` β GitHub CLI token (automatic fallback)
|
|
143
|
+
- **API Integration**: All GitHub operations use Octokit API with the retrieved token
|
|
144
|
+
- **CLI Integration**: GitHub CLI is used only for token retrieval, not for operations
|
|
145
|
+
- **Seamless Fallback**: Automatically switches between authentication methods
|
|
160
146
|
|
|
161
|
-
|
|
147
|
+
### Requirements
|
|
148
|
+
- **Node.js**: v20+
|
|
149
|
+
- **GitHub Authentication**: Token OR GitHub CLI
|
|
150
|
+
- **NPM (Optional)**: For package research
|
|
162
151
|
|
|
163
|
-
## DXT Extension
|
|
152
|
+
## π¦ DXT Extension
|
|
164
153
|
|
|
165
154
|
This project is available as a **Desktop Extension (DXT)** for easy installation in AI applications like Claude Desktop.
|
|
166
155
|
|
|
@@ -181,71 +170,206 @@ The generated `octocode-mcp.dxt` file can be installed in Claude Desktop by simp
|
|
|
181
170
|
- `yarn dxt:pack` - Build and package the extension
|
|
182
171
|
- `yarn dxt:release` - Full release pipeline (build β pack β sign β verify)
|
|
183
172
|
|
|
184
|
-
##
|
|
173
|
+
## π οΈ What You Can Do
|
|
185
174
|
|
|
186
|
-
**
|
|
187
|
-
-
|
|
188
|
-
-
|
|
189
|
-
-
|
|
190
|
-
-
|
|
175
|
+
### π§ **Generate Context from Anything, Anywhere**
|
|
176
|
+
- **Universal Context Generation** - Extract rich context from ANY resource: live code, PR diffs, commit changes, issue discussions, package docs, or architectural decisions
|
|
177
|
+
- **Code-First Best Practices** - Analyze actual implementations (not just docs) to discover real-world patterns, anti-patterns, and proven solutions from top repositories
|
|
178
|
+
- **Time-Travel Code Analysis** - Navigate through repository history, compare different versions, and understand how code evolved across commits and releases
|
|
179
|
+
- **PR & Commit Content Mining** - Get actual code changes, review comments, and implementation details from pull requests and commit histories
|
|
180
|
+
- **Language & Project Universal** - Generate context from any programming language, framework, or project type without configuration
|
|
181
|
+
|
|
182
|
+
### π’ **Organization Intelligence**
|
|
183
|
+
- **Private Repository Mastery** - Deep insights into organizational codebases with full access to private repositories and internal projects
|
|
184
|
+
- **Cross-Repository Flow Understanding** - Map complex dependencies, data flows, and architectural connections between multiple repositories
|
|
185
|
+
- **Enterprise Pattern Recognition** - Discover organizational coding standards, architectural patterns, and best practices across teams
|
|
186
|
+
- **Team Knowledge Mining** - Extract institutional knowledge from commit histories, code reviews, and development discussions
|
|
187
|
+
|
|
188
|
+
### π **Deep Research & Time-Travel Capabilities**
|
|
189
|
+
- **Version Comparison & Time-Travel** - Compare any repository versions across time, analyze how implementations changed, and understand architectural evolution
|
|
190
|
+
- **Live Code vs Historical Analysis** - Examine current implementations alongside their historical development through commits and PR changes
|
|
191
|
+
- **Best Practices from Real Code** - Extract proven patterns directly from high-quality codebases, not documentation - see how top developers actually implement solutions
|
|
192
|
+
- **PR & Commit Deep Dive** - Access actual code diffs, review discussions, implementation rationale, and the complete context behind every change
|
|
193
|
+
- **Multi-Dimensional Discovery** - Find implementations using semantic search, code patterns, commit messages, or PR discussions with full context
|
|
194
|
+
|
|
195
|
+
### ποΈ **Repository & Project Intelligence**
|
|
196
|
+
- **Smart Discovery & Ranking** - Find the most relevant repositories by topic, language, activity, or quality metrics with advanced filtering
|
|
197
|
+
- **Project Architecture Mapping** - Navigate and understand complex project structures with intelligent filtering that focuses on essential code
|
|
198
|
+
- **Multi-Repository Comparison** - Analyze approaches, patterns, and implementations across multiple projects simultaneously
|
|
199
|
+
- **Access & Permission Validation** - Seamlessly work with both public and private organizational repositories
|
|
200
|
+
|
|
201
|
+
### π¦ **Ecosystem & Dependency Intelligence**
|
|
202
|
+
- **Multi-Platform Package Discovery** - Search and analyze NPM, Python, and other ecosystem packages with comprehensive metadata
|
|
203
|
+
- **Dependency Flow Analysis** - Understand how packages connect, their repository relationships, and ecosystem interactions
|
|
204
|
+
- **Version & Evolution Tracking** - Monitor how packages and their dependencies change over time
|
|
205
|
+
- **Repository Bridge Technology** - Seamlessly connect package discoveries to their source repositories for deeper code analysis
|
|
206
|
+
|
|
207
|
+
## ποΈ Architecture & Deployment Options
|
|
208
|
+
|
|
209
|
+
## π οΈ Available Tools
|
|
210
|
+
|
|
211
|
+
Octocode provides 8 specialized tools for comprehensive code research:
|
|
212
|
+
|
|
213
|
+
1. **`github_search_repositories`** - Discover repositories by topic, language, stars, or activity
|
|
214
|
+
2. **`github_search_code`** - Find code implementations with semantic search and actual snippets
|
|
215
|
+
3. **`github_fetch_content`** - Retrieve complete files or specific sections with context
|
|
216
|
+
4. **`github_view_repo_structure`** - Explore project architecture and directory layouts
|
|
217
|
+
5. **`github_search_commits`** - Analyze commit history and code evolution with diffs
|
|
218
|
+
6. **`github_search_issues`** - Research bugs, features, and project challenges
|
|
219
|
+
7. **`github_search_pull_requests`** - Examine code reviews, discussions, and implementations
|
|
220
|
+
8. **`package_search`** - Discover NPM and Python packages with repository connections
|
|
221
|
+
|
|
222
|
+
## π‘ Best Practices & Prompting Guide
|
|
223
|
+
|
|
224
|
+
### π **Essential Prompting Patterns**
|
|
225
|
+
|
|
226
|
+
**1. Start with Octocode Context**
|
|
227
|
+
```
|
|
228
|
+
Use Octocode to research [your topic]. Do a deep research across repositories,
|
|
229
|
+
PRs, commits, and documentation to generate comprehensive context.
|
|
230
|
+
```
|
|
191
231
|
|
|
192
|
-
**
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
232
|
+
**2. Private Organization Access**
|
|
233
|
+
```
|
|
234
|
+
Focus on repositories from "your-private-organization" organization.
|
|
235
|
+
Analyze internal patterns and organizational best practices.
|
|
236
|
+
```
|
|
197
237
|
|
|
198
|
-
|
|
238
|
+
**3. Complex Flow Analysis**
|
|
239
|
+
```
|
|
240
|
+
Check package X from frontend, trace how it interacts with servers,
|
|
241
|
+
and identify which database schema stores the audit trail.
|
|
242
|
+
Map the complete data flow across repositories.
|
|
243
|
+
```
|
|
199
244
|
|
|
200
|
-
**
|
|
201
|
-
```
|
|
202
|
-
|
|
203
|
-
|
|
245
|
+
**4. Deep Research Directive**
|
|
246
|
+
```
|
|
247
|
+
Do a deep research - don't just find surface-level information.
|
|
248
|
+
Analyze commits, PRs, issues, and actual implementations.
|
|
249
|
+
Compare different approaches and extract proven patterns.
|
|
250
|
+
```
|
|
204
251
|
|
|
205
|
-
|
|
206
|
-
|
|
252
|
+
**5. Documentation Generation**
|
|
253
|
+
```
|
|
254
|
+
Create a comprehensive .md document from this research.
|
|
255
|
+
Include code examples, architectural decisions, and implementation patterns.
|
|
256
|
+
Use this documentation as context for further analysis.
|
|
257
|
+
```
|
|
207
258
|
|
|
208
|
-
|
|
209
|
-
|
|
259
|
+
**6. Follow-up Research Strategy**
|
|
260
|
+
```
|
|
261
|
+
Based on the previous research, now investigate [specific aspect].
|
|
262
|
+
Build upon the existing context rather than starting from scratch.
|
|
210
263
|
```
|
|
211
264
|
|
|
212
|
-
**
|
|
213
|
-
```
|
|
214
|
-
|
|
215
|
-
|
|
265
|
+
**7. PR Review with Rules**
|
|
266
|
+
```
|
|
267
|
+
Review this PR against our documented coding standards and security guidelines.
|
|
268
|
+
Check for compliance with organizational patterns and best practices.
|
|
269
|
+
```
|
|
216
270
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
271
|
+
**8. Security & Pattern Auditing**
|
|
272
|
+
```
|
|
273
|
+
Scan our organization's repositories for security vulnerabilities and
|
|
274
|
+
anti-patterns. Focus on authentication, data handling, and access controls.
|
|
220
275
|
```
|
|
221
276
|
|
|
222
|
-
**
|
|
223
|
-
- No results? Try broader search terms
|
|
224
|
-
- Private repos not found? Check `gh auth status` for organization membership
|
|
225
|
-
- Windows issues? Install PowerShell 7+ for better security
|
|
226
|
-
- Permission errors? Check executable permissions and PATH configuration
|
|
277
|
+
### π― **Smart Prompting Strategy**
|
|
227
278
|
|
|
228
|
-
|
|
279
|
+
**Octocode is built with smart fallbacks and error handling** - it will guide you through research automatically. However, **if you know what you need, help it avoid wasting LLM context on redundant searching:**
|
|
229
280
|
|
|
230
|
-
|
|
231
|
-
-
|
|
232
|
-
-
|
|
233
|
-
-
|
|
281
|
+
#### β
**Efficient Prompting**
|
|
282
|
+
- **Be Specific**: "Search for Redis caching patterns in TypeScript microservices" vs "Find caching examples"
|
|
283
|
+
- **Set Scope**: "Focus on repositories from organization 'company-name'" vs broad searches
|
|
284
|
+
- **Define Goals**: "Generate API documentation" vs "Research this API"
|
|
285
|
+
- **Use Context**: "Based on the previous research about auth patterns, now find rate limiting implementations"
|
|
234
286
|
|
|
235
|
-
|
|
236
|
-
-
|
|
237
|
-
-
|
|
238
|
-
-
|
|
287
|
+
#### β **Avoid Context Waste**
|
|
288
|
+
- Don't repeat broad searches if you already have repository context
|
|
289
|
+
- Don't ask for general overviews when you need specific implementations
|
|
290
|
+
- Don't search across all repositories when you know the target organization
|
|
291
|
+
- Don't start from scratch if you have existing research context
|
|
239
292
|
|
|
240
|
-
|
|
293
|
+
### π **Progressive Research Workflow**
|
|
294
|
+
|
|
295
|
+
**Phase 1: Discovery & Context**
|
|
296
|
+
```
|
|
297
|
+
Use Octocode to discover repositories related to [topic] in [organization].
|
|
298
|
+
Focus on active projects with recent commits and good documentation.
|
|
299
|
+
```
|
|
241
300
|
|
|
242
|
-
|
|
301
|
+
**Phase 2: Deep Analysis**
|
|
302
|
+
```
|
|
303
|
+
From the discovered repositories, analyze the implementation patterns for [specific feature].
|
|
304
|
+
Get actual code examples, PR discussions, and commit history.
|
|
305
|
+
```
|
|
243
306
|
|
|
244
|
-
|
|
307
|
+
**Phase 3: Documentation & Synthesis**
|
|
308
|
+
```
|
|
309
|
+
Create comprehensive documentation from the research. Include:
|
|
310
|
+
- Architecture overview
|
|
311
|
+
- Code examples with explanations
|
|
312
|
+
- Best practices and patterns
|
|
313
|
+
- Security considerations
|
|
314
|
+
```
|
|
245
315
|
|
|
246
|
-
|
|
316
|
+
**Phase 4: Application & Review**
|
|
317
|
+
```
|
|
318
|
+
Use the generated documentation to review [new code/PR/implementation].
|
|
319
|
+
Check for compliance with discovered patterns and organizational standards.
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
### π’ **Enterprise Research Patterns**
|
|
323
|
+
|
|
324
|
+
#### **Organization Intelligence**
|
|
325
|
+
- Map coding standards across teams
|
|
326
|
+
- Discover internal libraries and shared patterns
|
|
327
|
+
- Analyze architectural evolution over time
|
|
328
|
+
- Extract institutional knowledge from commit histories
|
|
329
|
+
|
|
330
|
+
#### **Security Auditing**
|
|
331
|
+
- Scan for vulnerability patterns across repositories
|
|
332
|
+
- Check compliance with security guidelines
|
|
333
|
+
- Analyze access control implementations
|
|
334
|
+
- Review authentication and authorization patterns
|
|
335
|
+
|
|
336
|
+
#### **Cross-Repository Analysis**
|
|
337
|
+
- Trace data flows between microservices
|
|
338
|
+
- Understand service dependencies and interactions
|
|
339
|
+
- Map API contracts and communication patterns
|
|
340
|
+
- Analyze deployment and infrastructure patterns
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
### Hosted/Production Deployment
|
|
345
|
+
**Perfect for:** Team environments, Docker containers, CI/CD, hosted AI services
|
|
346
|
+
|
|
347
|
+
- **Authentication:** GitHub Personal Access Tokens or GitHub App tokens
|
|
348
|
+
- **Rate Limits:** 5,000 requests/hour (can be higher with GitHub Apps)
|
|
349
|
+
- **Access:** Controlled by token scope and permissions
|
|
350
|
+
- **Setup:** Set `GITHUB_TOKEN` environment variable
|
|
351
|
+
|
|
352
|
+
## π³ Docker Support
|
|
353
|
+
|
|
354
|
+
Run Octocode MCP in a Docker container while maintaining full GitHub authentication. Perfect for consistent environments and deployment.
|
|
355
|
+
|
|
356
|
+
[**See Docker Setup Guide β**](./docker/README.Docker.md)
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
> **π For detailed technical architecture, tool specifications, and implementation details, see [Technical Summary](./docs/summary.md)**
|
|
360
|
+
|
|
361
|
+
## π‘οΈ Security & Privacy
|
|
362
|
+
|
|
363
|
+
### Enterprise Security
|
|
364
|
+
- **π‘οΈ Advanced Content Protection** - Multi-layer input validation and intelligent content sanitization
|
|
365
|
+
- **π Comprehensive Secret Detection** - Automatic detection and redaction of API keys, tokens, credentials, and sensitive patterns
|
|
366
|
+
- **βͺ Safe Commands Only** - Pre-approved GitHub CLI and NPM commands with parameter validation
|
|
367
|
+
- **π§Ή Malicious Content Filtering** - Automatic detection and sanitization of potentially harmful code patterns
|
|
368
|
+
- **π Security Pattern Analysis** - Built-in tools for identifying security vulnerabilities and compliance issues
|
|
369
|
+
|
|
370
|
+
> **π For comprehensive security architecture details, see [Technical Summary](./docs/summary.md)**
|
|
247
371
|
|
|
248
|
-
## License
|
|
372
|
+
## π License
|
|
249
373
|
|
|
250
374
|
MIT License - See [LICENSE](./LICENSE.md) for details.
|
|
251
375
|
|