octocode-mcp 5.0.0 → 6.0.0

package/README.md

@@ -1,11 +1,15 @@
 # Octocode MCP - AI-Powered GitHub Intelligence
 
-**Transform your AI assistant into a code research expert**
+**Transform your AI assistant into a code research expert with the Model Context Protocol (MCP)**
 
 <div align="center">
   <a href="https://octocode.ai" style="font-size: 1.1em; font-weight: bold; text-decoration: none;">
     🌐 Visit octocode.ai for guides, examples & community →
   </a>
+  <br>
+  <a href="https://www.youtube.com/@Octocode-ai" style="font-size: 1.1em; font-weight: bold; text-decoration: none; color: #ff0000;">
+    📺 YouTube Tutorials & Demos →
+  </a>
 </div>
 
 <div align="center">
@@ -21,32 +25,65 @@
 
 <div align="center">
   
-  [![Version](https://img.shields.io/badge/version-4.1.0-blue.svg)](./package.json)
+  [![Version](https://img.shields.io/badge/version-6.0.0-blue.svg)](./package.json)
   [![License](https://img.shields.io/badge/license-MIT-green.svg)](./package.json)
   [![Node.js Version](https://img.shields.io/badge/node-%3E%3D18.12.0-brightgreen)](https://nodejs.org/)
   [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/bgauryy/octocode-mcp)
-  [![X/Twitter](https://img.shields.io/badge/X-Follow%20@guy__bary-1DA1F2.svg?logo=x&logoColor=white)](https://x.com/guy_bary)
+[![Trust Score](https://archestra.ai/mcp-catalog/api/badge/quality/bgauryy/octocode-mcp)](https://archestra.ai/mcp-catalog/bgauryy__octocode-mcp)
 
 </div>
 
+## 🤖 What is MCP?
+
+**Model Context Protocol (MCP)** is an open standard that enables AI assistants to securely connect to external data sources and tools. Octocode MCP is an official community server that gives your AI assistant superpowers for code research to add quality context for your AI agents.
+
+
+## 🚀 Quick Start
 
-### Local Setup
+Get up and running in 2 minutes with your preferred authentication method:
 
-For local development:
+### Option 1: GitHub CLI (Recommended)
+**Perfect for developers who already use GitHub CLI**
 
 ```bash
-# 1. Authenticate with GitHub
+# 1. Install GitHub CLI (if not already installed)
+# macOS: brew install gh
+# Windows: winget install --id GitHub.cli
+# Linux: See https://github.com/cli/cli#installation
+
+# 2. Authenticate with GitHub
 gh auth login
 
-# 2. Add to your MCP configuration
+# 3. Add to your MCP configuration
+```
+
+```json
+{
+  "mcpServers": {
+    "octocode": {
+      "command": "npx",
+      "args": ["octocode-mcp@latest"]
+    }
+  }
+}
 ```
 
+### Option 2: GitHub Personal Access Token
+**Great for CI/CD, Windows users, or when you prefer token-based auth**
+
+1. **Create a token**: Go to [GitHub Settings → Developer settings → Personal access tokens](https://github.com/settings/tokens)
+2. **Select scopes**: `repo`, `read:user`, `read:org` (see [detailed scope guide](./docs/AUTHENTICATION.md))
+3. **Configure MCP**:
+
 ```json
 {
   "mcpServers": {
     "octocode": {
       "command": "npx",
-      "args": ["octocode-mcp"]
+      "args": ["octocode-mcp@latest"],
+      "env": {
+        "GITHUB_TOKEN": "ghp_xxxxxxxxxxxx"
+      }
     }
   }
 }
@@ -59,6 +96,7 @@ gh auth login
   style="font-size: 1.1em; font-weight: bold; text-decoration: none;">
     📚 View Usage Examples & Best Practices →
   </a>
+  <br><br>
 </div>
 
 ## What can Octocode do?
@@ -70,53 +108,28 @@ gh auth login
 - **Node.js** >= 18.12.0 - [Download here](https://nodejs.org/)
 - **GitHub Authentication** - GitHub CLI (recommended) or Personal Access Token
 
-## 🔧 Alternative Setup Options
+## 🔗 MCP Assistant Integration
 
-**Need a different setup?** Choose your preferred method:
+Octocode MCP works with any MCP-compatible AI assistant:
 
-### GitHub Token (for Windows/CI/Production)
-```json
-{
-  "mcpServers": {
-    "octocode": {
-      "command": "npx",
-      "args": ["octocode-mcp"],
-      "env": {
-        "GITHUB_TOKEN": "ghp_xxxxxxxxxxxx"
-      }
-    }
-  }
-}
-```
+## 🏢 Enterprise & Advanced Setup
 
-### Enterprise Setup
-```json
-{
-  "mcpServers": {
-    "octocode": {
-      "command": "npx", 
-      "args": ["octocode-mcp"],
-      "env": {
-        "GITHUB_TOKEN": "ghp_xxxxxxxxxxxx",
-        "GITHUB_ORGANIZATION": "your-org"
-      }
-    }
-  }
-}
+### Advanced Configuration Options
+```bash
+export GITHUB_TOKEN="ghp_xxxxxxxxxxxx"              # GitHub token
+export TOOLS_TO_RUN="githubSearchCode,githubSearchPullRequests" # Run ONLY these tools (exclusive)
+export ENABLE_TOOLS="additionalTool1,additionalTool2" # Add non-default tools  
+export DISABLE_TOOLS="unwantedTool1,unwantedTool2"    # Disable default tools
+export BETA="1"                                      # Enable experimental features
 ```
 
-**📚 Need detailed setup help?**
-- **[Complete Authentication Guide](./docs/AUTHENTICATION.md)** - All authentication methods, OAuth, GitHub Apps, and enterprise features
-- **[Installation Guide](./docs/INSTALLATION.md)** - Step-by-step setup for all environments
+**⚠️ Important:** `TOOLS_TO_RUN` cannot be used together with `ENABLE_TOOLS`/`DISABLE_TOOLS`. When `TOOLS_TO_RUN` is set, it runs ONLY the specified tools, ignoring all other tool configuration.
 
-## 🔗 AI Assistant Integration
+## 🔒 Security & Privacy
 
-**Claude Desktop setup:**
-```bash
-claude mcp add -s user octocode npx 'octocode-mcp@latest'
-```
-
-Octocode works with any MCP-compatible AI assistant.
+Octocode MCP is built with security-first principles:
+- **Content Sanitization**: Automatically detects and redacts API keys, tokens, and sensitive data
+- **Smart File Filtering**: Ignores sensitive paths, binaries, and non-searchable files for cleaner results
 
 ## 🚀 What You Can Do
 
@@ -146,50 +159,40 @@ For organizations: audit logging, access controls, rate limiting, and compliance
 | `githubGetFileContent` | Fetch file content from GitHub repositories | ✅ Yes | Content |  
 | `githubViewRepoStructure` | View GitHub repository structure and navigation | ✅ Yes | Content |
 | `githubSearchRepositories` | Search and discover GitHub repositories | ✅ Yes | Search |
-| `githubSearchCommits` | Search GitHub commits and change history | ❌ No | History |
 | `githubSearchPullRequests` | Search GitHub pull requests and code reviews | ❌ No | History |
-| `packageSearch` | Search NPM and Python package registries | ❌ No | NPM |
 
 **Default tools** are automatically enabled and provide core GitHub research functionality. **Non-default tools** can be enabled using the configuration options below.
 
-## ⚙️ Configuration & Advanced Setup
 
-**Most common settings:**
-```bash
-export GITHUB_TOKEN="ghp_xxxxxxxxxxxx"              # GitHub token
-export TOOLS_TO_RUN="githubSearchCode,packageSearch" # Run ONLY these tools (exclusive)
-export ENABLE_TOOLS="additionalTool1,additionalTool2" # Add non-default tools  
-export DISABLE_TOOLS="unwantedTool1,unwantedTool2"    # Disable default tools
-export BETA="1"                                      # Enable experimental features
-```
+## 📚 Complete Documentation
 
-**⚠️ Important:** `TOOLS_TO_RUN` cannot be used together with `ENABLE_TOOLS`/`DISABLE_TOOLS`. When `TOOLS_TO_RUN` is set, it runs ONLY the specified tools, ignoring all other tool configuration.
-
-**📚 For complete configuration options:**
-- **[Environment Variables Reference](./docs/AUTHENTICATION.md)** - All settings, OAuth, enterprise features
-- **[Tool Configuration Guide](./docs/TOOL_SCHEMAS.md)** - Available tools and parameters
-
-## 🚨 Troubleshooting
+### 🚀 Getting Started
+| Resource | Description |
+|----------|-------------|
+| **[🌐 octocode.ai](https://octocode.ai)** | Interactive tutorials and community |
+| **[🔐 Authentication Guide](./docs/AUTHENTICATION.md)** | Complete setup for GitHub CLI, tokens, OAuth, and enterprise |
+| **[📚 Usage Guide](./docs/USAGE_GUIDE.md)** | Examples, best practices, and prompt templates |
 
-**Common Issues:**
-- **"No GitHub token found"** → [Setup GitHub authentication](./docs/AUTHENTICATION.md)
-- **Rate limiting** → [Configure rate limits](./docs/AUTHENTICATION.md)
-- **Enterprise setup** → [Enterprise guide](./docs/AUTHENTICATION.md)
+### 🛠️ Technical Reference
+| Resource | Description |
+|----------|-------------|
+| **[🔧 Tool Schemas](./docs/TOOL_SCHEMAS.md)** | Complete API reference for all 7 tools with parameters |
+| **[🏗️ Architecture Overview](./docs/summary.md)** | System design, security, and performance details |
 
-## 📚 Documentation & Help
+### 🎯 Quick Links by Use Case
+- **Want examples?** → [Usage Guide](./docs/USAGE_GUIDE.md) with 20+ prompt examples
+- **Need API details?** → [Tool Schemas](./docs/TOOL_SCHEMAS.md) for bulk operations and advanced parameters
+- **Enterprise deployment?** → [Authentication Guide](./docs/AUTHENTICATION.md) for audit logging and access controls
+- **Understanding MCP?** → [Architecture Overview](./docs/summary.md) for system design
 
-| Resource | Purpose |
-|----------|---------|
-| **[🌐 octocode.ai](https://octocode.ai)** | Tutorials, community & latest updates |
-| **[📚 Usage Guide](./docs/USAGE_GUIDE.md)** | Examples and best practices |
-| **[🔐 Authentication](./docs/AUTHENTICATION.md)** | Setup for all auth methods |
-| **[🛠️ Tool Reference](./docs/TOOL_SCHEMAS.md)** | Complete API reference |
-| **[🏗️ Architecture](./docs/SUMMARY.md)** | System design overview |
-
-**Need help?** [GitHub Issues](https://github.com/bgauryy/octocode-mcp/issues) • [Discord](https://discord.gg/octocode) • [octocode.ai](https://octocode.ai)
+## 🚨 Troubleshooting
 
+**Need help?** [GitHub Issues](https://github.com/bgauryy/octocode-mcp/issues)
 ---
 
+ <a href="https://glama.ai/mcp/servers/@bgauryy/octocode-mcp">
+  <img width="380" height="200" src="https://glama.ai/mcp/servers/@bgauryy/octocode-mcp/badge" />
+
 <div align="center">
   <p>Built with ❤️ for developers</p>
   <p>