Most AI agents still explore documentation the expensive way:
open file → skim hundreds of irrelevant paragraphs → open another file → repeat
That burns tokens, floods context windows with noise, and forces models to reason through a lot of text they never needed in the first place.
jDocMunch-MCP lets AI agents navigate documentation by section instead of reading files by brute force.
It indexes a documentation set once, then retrieves exactly the section the agent actually needs, with byte-precise extraction from the original file.
| Task | Traditional approach | With jDocMunch |
|---|---|---|
| Find a configuration section | ~12,000 tokens | ~400 tokens |
| Browse documentation structure | ~40,000 tokens | ~800 tokens |
| Explore a full doc set | ~100,000 tokens | ~2,000 tokens |
Index once. Query cheaply forever.
Precision context beats brute-force context.
jCodeMunch-MCP is free for non-commercial use. Tip jar: (https://gravelle.gumroad.com/coffee)
Commercial use requires a paid license.
jCodeMunch-only licenses
Want both code and docs retrieval?
Stop dumping documentation files into context windows. Start navigating docs structurally.
jDocMunch indexes documentation once by heading hierarchy and section structure, then gives MCP-compatible agents precise access to the explanations they actually need instead of forcing them to brute-read files.
It is built for workflows where token efficiency, context hygiene, and agent reliability matter.
Large context windows do not fix bad retrieval.
Agents waste money and reasoning bandwidth when they:
- open entire documents to find one configuration block
- repeatedly re-read headings, boilerplate, and unrelated sections
- lose important explanations inside oversized context payloads
- consume documentation as flat text instead of structured knowledge
jDocMunch fixes that by changing the unit of access from file to section.
Instead of handing an agent an entire document, it can retrieve exactly:
- an installation section
- a configuration section
- an API explanation
- a troubleshooting section
- a specific subtree of related headings
That makes documentation exploration cheaper, faster, and more stable.
Search and retrieve documentation by section, not just file path or keyword match.
Full content is pulled on demand from exact byte offsets into the original file.
Sections retain durable identities across re-indexing when path, heading text, and heading level remain unchanged.
Indexes and raw docs are stored locally. No hosted dependency required.
Works with Claude Desktop, Claude Code, Google Antigravity, and other MCP-compatible clients.
Every section stores:
- title and heading level
- one-line summary
- extracted tags and references
- SHA-256 content hash for drift detection
- byte offsets into the original file
This allows agents to discover documentation structurally, then request only the specific section they need.
Traditional doc retrieval methods all break in different ways:
- File scanning loads far too much irrelevant text
- Keyword search finds terms but often loses context
- Chunking breaks authored hierarchy and separates explanations from examples
jDocMunch preserves the structure the human author intended:
- heading hierarchy
- parent/child relationships
- section boundaries
- coherent explanatory units
Agents do not need bigger context windows.
They need better navigation.
-
Discovery
GitHub API or local directory walk -
Security filtering
Traversal protection, secret exclusion, binary detection -
Parsing
Heading-based section splitting (#, setext, and MDX-aware preprocessing) -
Hierarchy wiring
Parent/child relationships established -
Summarization
Heading text → AI batch summaries → title fallback -
Storage
JSON index + raw files stored locally under~/.doc-index/ -
Retrieval
O(1) byte-offset seeking via stable section IDs
{repo}::{doc_path}::{slug}#{level}
Examples:
owner/repo::docs/install.md::installation#1owner/repo::README.md::quick-start#2local/myproject::guide.md::configuration#2
IDs remain stable across re-indexing when the file path, heading text, and heading level do not change.
- Python 3.10+
pip
pip install jdocmunch-mcpVerify:
jdocmunch-mcp --helpPATH note: MCP clients often run with a restricted environment where
jdocmunch-mcpmay not be found even if it works in your shell. Usinguvxis the recommended approach because it resolves the package on demand without relying on your system PATH. If you preferpip install, use the absolute path to the executable instead.
- Linux:
/home/<username>/.local/bin/jdocmunch-mcp - macOS:
/Users/<username>/.local/bin/jdocmunch-mcp - Windows:
C:\\Users\\<username>\\AppData\\Roaming\\Python\\Python3xx\\Scripts\\jdocmunch-mcp.exe
Config file location:
| OS | Path |
|---|---|
| macOS | ~/Library/Application Support/Claude/claude_desktop_config.json |
| Linux | ~/.config/claude/claude_desktop_config.json |
| Windows | %APPDATA%\Claude\claude_desktop_config.json |
{
"mcpServers": {
"jdocmunch": {
"command": "uvx",
"args": ["jdocmunch-mcp"]
}
}
}{
"mcpServers": {
"jdocmunch": {
"command": "uvx",
"args": ["jdocmunch-mcp"],
"env": {
"GITHUB_TOKEN": "ghp_...",
"ANTHROPIC_API_KEY": "sk-ant-..."
}
}
}
}After saving the config, restart Claude Desktop / Claude Code.
- Open the Agent pane
- Click the
⋯menu → MCP Servers → Manage MCP Servers - Click View raw config to open
mcp_config.json - Add the entry below, save, then restart the MCP server
{
"mcpServers": {
"jdocmunch": {
"command": "uvx",
"args": ["jdocmunch-mcp"]
}
}
}index_local: { "path": "/path/to/docs" }
index_repo: { "url": "owner/repo" }
get_toc: { "repo": "owner/repo" }
get_toc_tree: { "repo": "owner/repo" }
get_document_outline: { "repo": "owner/repo", "doc_path": "docs/config.md" }
search_sections: { "repo": "owner/repo", "query": "authentication" }
get_section: { "repo": "owner/repo", "section_id": "owner/repo::docs/config.md::authentication#1" }| Tool | Purpose |
|---|---|
index_local |
Index a local documentation folder |
index_repo |
Index a GitHub repository’s docs |
list_repos |
List indexed documentation sets |
get_toc |
Flat section list in document order |
get_toc_tree |
Nested section tree per document |
get_document_outline |
Section hierarchy for one document |
search_sections |
Weighted search returning summaries only |
get_section |
Full content of one section |
get_sections |
Batch content retrieval |
delete_index |
Remove a doc index |
Search and retrieval tools include a _meta envelope with timing, token savings, and cost avoided.
Example:
"_meta": {
"latency_ms": 12,
"sections_returned": 5,
"tokens_saved": 1840,
"total_tokens_saved": 94320,
"cost_avoided": { "claude_opus": 0.0276, "gpt5_latest": 0.0184 },
"total_cost_avoided": { "claude_opus": 1.4148, "gpt5_latest": 0.9432 }
}total_tokens_saved and total_cost_avoided accumulate across tool calls and persist to ~/.doc-index/_savings.json.
| Format | Extensions | Notes |
|---|---|---|
| Markdown | .md, .markdown |
ATX (# Heading) and setext headings |
| MDX | .mdx |
JSX tags, frontmatter, import/export stripped before parsing |
| Plain text | .txt |
Paragraph-block section splitting |
| RST | .rst |
Treated as plain text for now; richer heading detection planned |
See ARCHITECTURE.md for parser details.
Built-in protections include:
- path traversal prevention
- symlink escape protection
- secret file exclusion (
.env,*.pem, and similar) - binary file detection
- configurable file size limits
- storage path injection prevention via
_safe_content_path() - atomic index writes
See SECURITY.md for details.
- agent-driven documentation exploration
- finding configuration and API reference sections
- onboarding to unfamiliar frameworks
- token-efficient multi-agent documentation workflows
- large documentation sets with dozens of files
- source code symbol indexing (use jCodeMunch for that)
- real-time file watching
- cross-repository global search
- semantic/vector similarity search as a standalone product goal
| Variable | Purpose | Required |
|---|---|---|
GITHUB_TOKEN |
GitHub API auth | No |
ANTHROPIC_API_KEY |
Section summaries via Claude Haiku | No |
GOOGLE_API_KEY |
Section summaries via Gemini Flash | No |
DOC_INDEX_PATH |
Custom cache path | No |
JDOCMUNCH_SHARE_SAVINGS |
Set to 0 to disable anonymous community token savings reporting |
No |
Each tool call can contribute an anonymous delta to a live global counter at j.gravelle.us. Only two values are sent:
- tokens saved
- a random anonymous install ID
No content, file paths, repo names, or identifying material are sent.
The anonymous install ID is generated once and stored in ~/.doc-index/_savings.json.
To disable reporting, set:
JDOCMUNCH_SHARE_SAVINGS=0This repository is free for non-commercial use under the terms below. Commercial use requires a paid commercial license.
Copyright (c) 2026 J. Gravelle
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to use, copy, modify, merge, publish, and distribute the Software for personal, educational, research, hobby, or other non-commercial purposes, subject to the following conditions:
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
- Any modifications made to the Software must clearly indicate that they are derived from the original work, and the name of the original author (J. Gravelle) must remain intact. He's kinda full of himself.
- Redistributions of the Software in source code form must include a prominent notice describing any modifications from the original version.
Commercial use of the Software requires a separate paid commercial license from the author.
“Commercial use” includes, but is not limited to:
- use of the Software in a business environment
- internal use within a for-profit organization
- incorporation into a product or service offered for sale
- use in connection with revenue generation, consulting, SaaS, hosting, or fee-based services
For commercial licensing inquiries: j@gravelle.us https://j.gravelle.us
Until a commercial license is obtained, commercial use is not permitted.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHOR OR COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.