octocode-mcp 9.0.0-alpha.2 → 9.2.0

package/README.md

@@ -137,7 +137,19 @@ https://github.com/user-attachments/assets/c184d5d4-c9b6-40a1-a55a-41cb9b3ecc4f
 
 ## Installation
 
-### Prerequisites
+### Standalone Binary (No Node.js Required)
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/bgauryy/octocode-mcp/main/install/install.sh | sh
+```
+
+**[Full Binary Installation Guide →](../../docs/BINARY_INSTALLATION.md)** — Manual downloads, MCP configs, troubleshooting
+
+---
+
+### npm / npx (Requires Node.js)
+
+#### Prerequisites
 
 - **Node.js** >= 18.12.0
 - **GitHub Authentication** (choose one):
@@ -551,140 +563,6 @@ Demonstrates progressive research workflow:
 
 ---
 
-## Overview
-
-Octocode is an **agentic code research platform** that bridges the gap between AI assistants and real-world code implementations. By providing structured access to GitHub's vast repository ecosystem, it enables AI systems to learn from production codebases rather than relying solely on training data.
-
-### Core Capabilities
-
-| Capability | Implementation | Benefit |
-|------------|----------------|---------|
-| **Code Discovery** | Multi-dimensional search across repositories, code, and pull requests | Find relevant implementations in seconds |
-| **Context Extraction** | Smart content retrieval with pattern matching and line-range targeting | Get exactly the context you need |
-| **Token Optimization** | Advanced minification strategies (50+ language support) | 30-70% reduction in token consumption |
-| **Security** | Automatic secrets detection and content sanitization | Enterprise-grade data protection |
-| **Progressive Research** | Workflow-driven exploration (Discover → Explore → Analyze) | Deep understanding of complex systems |
-| **Access Control** | GitHub permission-based access to public and private repositories | Organization-wide code research |
-
----
-
-## Tools
-
-Octocode provides five specialized research tools designed to work together for comprehensive code analysis:
-
-### 🔍 githubSearchCode
-
-**Find code implementations across repositories**
-
-Search for specific code patterns, functions, or implementations across millions of repositories.
-
-**Key Features**:
-- **Content Search**: Find code inside files by keywords (AND logic)
-- **Path Search**: Discover files/directories by name (25x faster)
-- **Smart Filtering**: Scope by repository, path, file extension, or popularity
-- **Context-Rich Results**: Returns code snippets with surrounding context
-
-**Common Use Cases**:
-```
-• Find implementation examples: "How do popular repos implement OAuth?"
-• Discover patterns: "Search for React custom hooks in vercel repos"
-• Locate functions: "Find error handling patterns in Express apps"
-```
-
----
-
-### 📚 githubSearchRepositories
-
-**Discover repositories by topics and keywords**
-
-Your starting point for repository discovery - find the right projects to analyze.
-
-**Key Features**:
-- **Topic-Based Discovery**: Search by exact GitHub topics (most precise)
-- **Keyword Search**: Find repos by name, description, or README content
-- **Quality Filters**: Filter by stars, language, size, activity
-- **Sorting Options**: By popularity, recency, or relevance
-
-**Common Use Cases**:
-```
-• Find popular implementations: "Discover TypeScript CLI tools with >1000 stars"
-• Research ecosystems: "Find all React state management libraries"
-• Organization research: "List all repos from microsoft with topic 'ai'"
-```
-
----
-
-### 🗂️ githubViewRepoStructure
-
-**Explore repository directory structure**
-
-Understand how a project is organized before diving into specific files.
-
-**Key Features**:
-- **Directory Tree**: Visual representation of folder structure
-- **File Sizes**: See file sizes to identify important components
-- **Depth Control**: Explore 1 level (overview) or 2 levels (detailed)
-- **Path Targeting**: Navigate directly to specific directories
-
-**Common Use Cases**:
-```
-• Project overview: "Show me the structure of facebook/react"
-• Find entry points: "Explore src/ directory in a monorepo"
-• Understand architecture: "Navigate to the API implementation folder"
-```
-
----
-
-### 📄 githubGetFileContent
-
-**Read file contents with smart extraction**
-
-Retrieve specific content from files efficiently - full files or targeted sections.
-
-**Key Features**:
-- **Pattern Matching**: Extract sections matching specific patterns with context
-- **Line Range Reading**: Read specific line ranges for efficiency
-- **Full Content Access**: Get entire file when needed
-- **Content Minification**: Automatic optimization for token efficiency
-
-**Common Use Cases**:
-```
-• Read specific functions: "Get the validateUser function from auth.ts"
-• Extract sections: "Show me all the middleware definitions in app.js"
-• Read configuration: "Get the full package.json file"
-• Analyze specific code: "Read lines 100-150 from the API handler"
-```
-
----
-
-### 🔀 githubSearchPullRequests
-
-**Analyze pull requests, changes, and discussions**
-
-Understand how code evolved, why decisions were made, and learn from production changes.
-
-**Key Features**:
-- **PR Discovery**: Search by state, author, labels, dates
-- **Direct Access**: Fetch specific PR by number (10x faster)
-- **Code Diffs**: Include full diff content or targeted file patches (smart token management)
-- **Discussions**: Access comment threads and review discussions
-- **Merged Code**: Filter for production-ready, merged changes
-
-**Common Use Cases**:
-```
-• Learn from changes: "Show recent merged PRs about authentication"
-• Understand decisions: "Find PRs discussing the API redesign with comments"
-• Track implementations: "See how feature X was implemented with diffs"
-• Expert contributions: "Find PRs by @author in the last 6 months"
-```
-
----
-
-
-**[Full Documentation →](./README.md)**
-
----
-
 ## Commands
 
 Octocode MCP provides intelligent prompt commands that enhance your research workflow:
@@ -787,6 +665,7 @@ Comprehensive security analysis of a repository. Identifies vulnerabilities, rev
 | Resource | Description | Link |
 |----------|-------------|------|
 | **Official Website** | Interactive tutorials, demos, community | [octocode.ai](https://octocode.ai) |
+| **Binary Installation** | Standalone binary download and setup | [BINARY_INSTALLATION.md](../../docs/BINARY_INSTALLATION.md) |
 | **Configuration Guide** | Environment variables and server configuration | [CONFIGURATION.md](../../docs/CONFIGURATION.md) |
 | **Authentication Guide** | Setup instructions and troubleshooting | [AUTH_GUIDE.md](../../docs/AUTH_GUIDE.md) |
 | **YouTube Channel** | Video tutorials and demonstrations | [Octocode on YouTube](https://www.youtube.com/@Octocode-ai) |