Documentation Code Extractor with MCP integration for documentation crawling and code search
Project description
CodeDox - AI-Powered Documentation Search & Code Extraction
Transform any documentation site into a searchable code database - CodeDox crawls documentation websites, intelligently extracts code snippets with context, and provides lightning-fast search via PostgreSQL full-text search and MCP (Model Context Protocol) integration for AI assistants.
📚 Documentation
For full documentation, installation guides, API reference, and more, visit:
https://chriswritescode-dev.github.io/codedox/
Quick Start
Docker Setup (Recommended)
# Clone the repository
git clone https://github.com/chriswritescode-dev/codedox.git
cd codedox
# Configure environment
cp .env.example .env
# Edit .env to add your CODE_LLM_API_KEY (optional for AI-enhanced extraction)
# Run the automated setup
./docker-setup.sh
# Access the web UI at http://localhost:5173
# MCP tools available at http://localhost:8000/mcp
Manual Installation
See the full installation guide for detailed instructions.
Key Features
- Intelligent Web Crawling: Depth-controlled crawling with URL pattern filtering and domain restrictions
- Smart Code Extraction: Dual-mode extraction (Automatic Title / Description or LLM Generated Titles and Descriptions)
- Enhanced Search Modes: Standard code search with intelligent markdown fallback for comprehensive results
- Lightning-Fast Search: PostgreSQL full-text search with fuzzy matching
- GitHub Repository Processing: Clone and extract documentation from GitHub repositories with full path support (e.g.,
/tree/main/docs) - HTTP-First MCP Integration: MCP tools via HTTP endpoints with Streamable HTTP transport support (MCP 2025-03-26 spec)
- Full Documentation Access: Get complete markdown content from any documentation page for full context
- Modern Web Dashboard: React + TypeScript UI for visual management
- Version Support: Track multiple versions of documentation
- Real-time Monitoring: Live crawl progress and health monitoring
- Upload Support: Upload documentation directly or from GitHub repositories (useful for repos with doc sites)
Demo - MCP Integration Example - OpenCode TUI
Screenshots
Dashboard
Markdown Search with Highlighting
Source Detail View
Documentation
Contributing
See our Contributing Guide for details on how to contribute to CodeDox.
Author
Chris Scott - chriswritescode.dev
License
This project is licensed under the MIT License - see the LICENSE file for details.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file iflow_mcp_chriswritescode_dev_codedox-0.3.9.tar.gz.
File metadata
- Download URL: iflow_mcp_chriswritescode_dev_codedox-0.3.9.tar.gz
- Upload date:
- Size: 132.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
959893e31b57b74ab5f3dc3a5cb586cdb85199d9f69906487637aa82abe437e7
|
|
| MD5 |
77a289ce53eb02096cfb5c25f7bfc397
|
|
| BLAKE2b-256 |
f2c62e814bec9bf86712ee45f21b1e4b86419d9917e2ccba2e7425af53250307
|
File details
Details for the file iflow_mcp_chriswritescode_dev_codedox-0.3.9-py3-none-any.whl.
File metadata
- Download URL: iflow_mcp_chriswritescode_dev_codedox-0.3.9-py3-none-any.whl
- Upload date:
- Size: 170.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.27 {"installer":{"name":"uv","version":"0.9.27","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d17f801d36c552502e9079bfcdfae50c5bbf407eda5d00a56dd0d0d907620b88
|
|
| MD5 |
5abc7b794c06a0d93f0f9473cdb9c51e
|
|
| BLAKE2b-256 |
de3f9f69fade13156a53a2208b5f396ec06f8b4f0a896d0b4e791a1f869e981a
|
