[{"_1":2,"_469":-5,"_470":-5},"loaderData",{"_3":4,"_24":25,"_302":303},"root",{"_5":6,"_7":8},"toasts",[],"visitor",{"_9":10,"_11":12},"viewportWidth",1280,"visitorSession",{"_13":14,"_16":17,"_18":-5,"_19":20,"_21":22,"_23":-5},"attributes",[15],"bot","id",28696684,"membership","referenceId","019acd2b-7918-736f-b37c-c39fdfea91a9","unreadReleaseNotesCount",2,"userAccount","routes/_public/mcp/servers/~namespace/~slug/_pages/_layout",{"_26":27,"_28":-5,"_29":30,"_31":43,"_221":222,"_301":203},"availableLocales",[],"githubUser","locale",{"_31":32,"_39":40,"_41":42},"mcpServer",{"_33":34,"_35":36,"_37":38},"description","Docdex is a lightweight, local documentation indexer/search daemon. It runs per-project, keeps an on-disk index of your markdown/text docs, and serves top-k snippets over HTTP or CLI for any coding assistant or tool—no external services or uploads required.","displayName","docdex","readme","# Docdex\n\n[![smithery badge](https://smithery.ai/badge/@bekirdag/docdex)](https://smithery.ai/server/@bekirdag/docdex)\n\nDocdex is a lightweight, local documentation indexer/search daemon. It runs per-project, keeps an on-disk index of your markdown/text docs, and serves top-k snippets over HTTP or CLI for any coding assistant or tool—no external services or uploads required.\n\n## Install via npm\n- Requires Node.js >= 18.\n- Install: `npm i -g docdex` (or run `npx docdex --version` to verify).\n- Commands: `docdex` (alias `docdexd`) downloads the right binary for your platform from the matching GitHub release.\n- Supported targets: macOS (arm64, x64), Linux glibc (arm64, x64), Linux musl (arm64, x64), Windows (x64, arm64); installer fetches the matching platform release asset.\n- If you publish from a fork, set `DOCDEX_DOWNLOAD_REPO=` before installing so the downloader fetches your release assets.\n- Distribution: binaries stay in GitHub Releases (small npm package); postinstall fetches `docdexd-.tar.gz` matching the npm version.\n- Publishing uses npm Trusted Publishing (OIDC) — no NPM token needed; see `.github/workflows/release.yml`.\n\n## Features at a glance\n- Per-repo, local indexing of Markdown/text files (tantivy-backed; no network calls).\n- HTTP API (`/search`, `/snippet`, `/healthz`) and CLI (`query`, `ingest`, `self-check`) share the same index.\n- Live file watching while serving for incremental updates.\n- Security knobs: TLS (manual certs or Certbot), auth token required by default (disable with `--secure-mode=false`), loopback-only allowlist by default, default rate limiting, request-size limits, strict state-dir perms, audit log, chroot/privilege drop/unshare net (Unix).\n- Output ready for coding assistants: summaries, snippets, and doc metadata.\n- AI-friendly: `GET /ai-help` returns a JSON playbook (endpoints, CLI commands, limits, best practices) for agents.\n\n## What it does\n- Indexes Markdown/text docs inside a repo and stores them locally (tantivy-based index under `/.docdex/index` by default).\n- Serves the same index over HTTP (`/search`, `/snippet`, `/healthz`) and via CLI (`query`, `ingest`, `self-check`), so automation and interactive use share one dataset.\n- Watches files while serving to incrementally ingest changes.\n- Hardened defaults: loopback binding, TLS enforcement on non-loopback, auth token required by default (disable with `--secure-mode=false`), loopback-only allowlist and default rate limit (60 req/min) in secure mode, audit log enabled, and strict state-dir perms.\n\n## How it works\n1) `docdexd index` builds the on-disk index for your repo (or reuses a legacy `.gpt-creator/docdex/index` if present). \n2) `docdexd serve` loads that index, starts a file watcher for incremental updates, and exposes the HTTP API. \n3) HTTP clients or the CLI (`docdexd query`) read from the same index; `ingest` can update a single file without full reindexing. \n4) Optional TLS/auth/rate-limit settings secure remote access; audit logging can record access actions.\n\n## Quick start\n```bash\n# install (npm)\nnpm i -g docdex\n# or use once\nnpx docdex --version\n\n# full index for a repo/workspace\ndocdexd index --repo /path/to/repo\n\n# serve HTTP API with live file watching (secure mode requires an auth token)\ndocdexd serve --repo /path/to/repo --host 127.0.0.1 --port 46137 --log info --auth-token \n# for local, token-free use, add --secure-mode=false\n# docdexd serve --repo /path/to/repo --host 127.0.0.1 --port 46137 --log info --secure-mode=false\n\n# ad-hoc search via CLI (JSON)\ndocdexd query --repo /path/to/repo --query \"otp flow\" --limit 5\n```\n\n## TL;DR for agents\n- Use Docdex for repo docs: run `docdexd index --repo .` once, then either `docdexd serve --repo . --host 127.0.0.1 --port 46137` for HTTP, or `docdexd mcp --repo . --log warn` for MCP.\n- Add `.docdex/` to `.gitignore` so indexes aren't committed.\n- When MCP-aware, register a server named `docdex` that runs `docdexd mcp --repo . --log warn --max-results 8`, then call `docdex_search` before coding and `docdex_index` when stale.\n- Prefer summary-first (snippets=false), fetch specific snippets only when needed, keep queries short, and respect token estimates.\n\n## Usage cheat sheet\n- Build index: `docdexd index --repo ` (add `--exclude-*` to skip paths).\n- Serve with watcher: `docdexd serve --repo --host 127.0.0.1 --port 46137 --log warn --auth-token ` (secure mode also allowlists loopback and rate-limits by default; add `--allow-ip`/`--secure-mode=false`/`--rate-limit-per-min` as needed for remote use).\n- Secure serving: add `--auth-token ` (required by default); use TLS with `--tls-cert/--tls-key` or `--certbot-domain `.\n- Single-file ingest: `docdexd ingest --repo --file docs/new.md` (honors excludes).\n- Query via CLI: `docdexd query --repo --query \"term\" --limit 4`.\n- Git hygiene: add `.docdex/` (and especially `.docdex/index/`) to your repo's `.gitignore` so index artifacts never get committed.\n- Health check: `curl http://127.0.0.1:46137/healthz`.\n- Summary-only search responses: `curl \"http://127.0.0.1:46137/search?q=foo&snippets=false\"`; fetch snippets only for top hits.\n- Token budgets: `curl \"http://127.0.0.1:46137/search?q=foo&max_tokens=800\"` to drop hits that would exceed your prompt budget; pair with `snippets=false` then fetch 1–2 snippets you keep.\n- Text-only snippets: append `text_only=true` to `/snippet/:doc_id` or start `serve` with `--strip-snippet-html` (or `--disable-snippet-text` to return metadata only).\n- Keep requests compact: defaults enforce `max_query_bytes=4096` and `max_request_bytes=16384`; keep queries short and leave `--max-limit` low (default 8) to avoid oversized responses.\n- Prompt hygiene: in agent prompts, normalize whitespace and include only `rel_path`, `summary`, and trimmed `snippet` (omit `score`/`token_estimate`/`doc_id`).\n- Trim noise early: use `--exclude-dir` and `--exclude-prefix` to keep vendor/build/cache/secrets out of the index so snippets stay relevant and short.\n- Quiet logging for agents: run `docdexd serve --log warn --access-log=false` if you marshal responses elsewhere to cut log overhead.\n- Cache hits client-side: store `doc_id` ↔ `rel_path` ↔ `summary` to avoid repeat snippet calls; fetch snippets only for new doc_ids.\n- Agent help: `curl http://127.0.0.1:46137/ai-help` (requires auth if configured; include `Authorization: Bearer ` when you've set `--auth-token`). The response includes a short MCP registration recipe.\n\n## Versioning\n- Semantic versioning with tagged releases (`vX.Y.Z`). The Rust crate and npm package share the same version.\n- Conventional Commits drive release notes via Release Please; it opens release PRs that bump `Cargo.toml` and `npm/package.json`, update changelogs, and creates the tag/release on merge.\n- Pin to a released version when integrating (e.g., in scripts or Dockerfiles) so upgrades are explicit and reversible.\n- If you build from source, the version comes from `Cargo.toml` in this repo; the npm wrapper uses the matching version to fetch binaries.\n\n## Paths and defaults\n- State/index directory: `/.docdex/index` (if missing but legacy `/.gpt-creator/docdex/index` exists, Docdex will reuse it and warn). The directory is created with `0700` permissions by default.\n- HTTP API: defaults to `127.0.0.1:46137` when serving.\n- Docdex data and logs stay inside the repo; no external services.\n\n## Configuration knobs\n- `--repo `: workspace root to index (defaults to `.`).\n- `--state-dir ` / `DOCDEX_STATE_DIR`: override index storage path (relative paths are resolved under `repo`).\n- `--exclude-prefix a,b,c` / `DOCDEX_EXCLUDE_PREFIXES`: extra relative prefixes to skip.\n- `--exclude-dir a,b,c` / `DOCDEX_EXCLUDE_DIRS`: extra directory names to skip anywhere in the tree.\n- `--auth-token ` / `DOCDEX_AUTH_TOKEN`: bearer token required in secure mode (default); omit only when starting with `--secure-mode=false`.\n- `--secure-mode ` / `DOCDEX_SECURE_MODE`: default `true`; when enabled, requires an auth token, loopback allowlist by default, and default rate limiting (60 req/min).\n- `--allow-ip a,b,c` / `DOCDEX_ALLOW_IPS`: optional comma-separated IPs/CIDRs allowed to reach the HTTP API (default: loopback-only in secure mode; allow all when secure mode is disabled).\n- `--tls-cert` / `DOCDEX_TLS_CERT` and `--tls-key` / `DOCDEX_TLS_KEY`: serve HTTPS with the provided cert/key. With TLS enforcement on, non-loopback binds must use HTTPS unless you explicitly opt out.\n- `--certbot-domain ` / `DOCDEX_CERTBOT_DOMAIN`: point TLS at `/etc/letsencrypt/live//{fullchain.pem,privkey.pem}` (Certbot). Conflicts with manual `--tls-*`.\n- `--certbot-live-dir ` / `DOCDEX_CERTBOT_LIVE_DIR`: use a specific Certbot live dir containing `fullchain.pem` and `privkey.pem`.\n- `--require-tls ` / `DOCDEX_REQUIRE_TLS`: default `true`. Enforce TLS for non-loopback binds; set to `false` when TLS is already terminated by a trusted proxy.\n- `--insecure` / `DOCDEX_INSECURE_HTTP=true`: allow plain HTTP on non-loopback binds even when TLS is enforced (only use behind a trusted proxy).\n- `--max-limit ` / `DOCDEX_MAX_LIMIT`: clamp HTTP `limit` to at most `n` (default: 8).\n- `--max-query-bytes ` / `DOCDEX_MAX_QUERY_BYTES`: reject requests whose query string exceeds `n` bytes (default: 4096).\n- `--max-request-bytes ` / `DOCDEX_MAX_REQUEST_BYTES`: reject requests whose Content-Length or size hint exceeds `n` bytes (default: 16384).\n- `--rate-limit-per-min ` / `DOCDEX_RATE_LIMIT_PER_MIN`: per-IP request budget per minute (default 60 in secure mode when unset/0; 0 disables when secure mode is off).\n- `--rate-limit-burst ` / `DOCDEX_RATE_LIMIT_BURST`: optional burst capacity for the rate limiter (defaults to per-minute limit when 0).\n- `--audit-log-path ` / `DOCDEX_AUDIT_LOG_PATH`: write audit log JSONL to this path (default: `/audit.log`).\n- `--audit-max-bytes ` / `DOCDEX_AUDIT_MAX_BYTES`: rotate audit log after this many bytes (default: 5_000_000).\n- `--audit-max-files ` / `DOCDEX_AUDIT_MAX_FILES`: keep at most this many rotated audit files (default: 5).\n- `--audit-disable` / `DOCDEX_AUDIT_DISABLE=true`: disable audit logging entirely.\n- `--strip-snippet-html` / `DOCDEX_STRIP_SNIPPET_HTML=true`: omit `snippet.html` in responses to force text-only snippets (HTML is sanitized by default when present).\n- `--disable-snippet-text` / `DOCDEX_DISABLE_SNIPPET_TEXT=true`: omit snippet text/html in responses entirely (only doc metadata is returned).\n- `--access-log ` / `DOCDEX_ACCESS_LOG`: emit minimal structured access logs with query values redacted (default: true).\n- `--run-as-uid` / `DOCDEX_RUN_AS_UID`, `--run-as-gid` / `DOCDEX_RUN_AS_GID`: (Unix) drop privileges to the provided UID/GID after startup prep.\n- `--chroot ` / `DOCDEX_CHROOT`: (Unix) chroot into `path` before serving; repo/state paths must exist inside that jail.\n- `--unshare-net` / `DOCDEX_UNSHARE_NET=true`: (Linux only) unshare the network namespace before serving (requires CAP_SYS_ADMIN/root); no-op on other platforms.\n- Logging: `--log ` on `serve` (defaults to `info`), or `RUST_LOG=docdexd=debug` style filters.\n- Secure mode defaults: when `--secure-mode=true` (default), docdex requires an auth token, allows only loopback IPs unless overridden, and applies a 60 req/min rate limit. Set `--secure-mode=false` to opt out for local dev and adjust `--allow-ip`/rate limits as needed.\n\n## Indexing rules (see `index/mod.rs`)\n- File types: `.md`, `.markdown`, `.mdx`, `.txt` (extend `DEFAULT_EXTENSIONS` to add more).\n- Skipped directories: broad VCS/build/cache/vendor folders across ecosystems (e.g., `.git`, `.hg`, `.svn`, `node_modules`, `.pnpm-store`, `.yarn*`, `.nx`, `.rollup-cache`, `.webpack-cache`, `.tsbuildinfo`, `.next`, `.nuxt`, `.svelte-kit`, `.mypy_cache`, `.ruff_cache`, `.venv`, `target`, `go-build`, `.gradle`, `.mvn`, `pods`, `.dart_tool`, `.android`, `.serverless`, `.vercel`, `.netlify`, `_build`, `_opam`, `.stack-work`, `elm-stuff`, `library`, `intermediate`, `.godot`, etc.; see `DEFAULT_EXCLUDED_DIR_NAMES` for the full list).\n- Skipped relative prefixes: `logs/`, `.docdex/`, `.docdex/logs/`, `.docdex/tmp/`, `.gpt-creator/logs/`, `.gpt-creator/tmp/`, `.mastercoda/logs/`, `.mastercoda/tmp/`, `docker/.data/`, `docker-data/`, `.docker/`.\n- Snippet sizing: summaries ~360 chars (up to 4 segments); snippets ~420 chars.\n\n## HTTP API\n- `GET /healthz` — returns `ok`; this endpoint is unauthenticated and not rate-limited (IP allowlist still applies).\n- `GET /search?q=&limit=&snippets=&max_tokens=` — returns `{ hits: [...] }` with doc id, rel path, summary, snippet, score, token estimate. Set `snippets=false` for summary-only responses; set `max_tokens` to drop hits above your budget.\n- `GET /snippet/:doc_id?window=&q=&text_only=&max_tokens=` — returns `{ doc, snippet }` with optional highlighted snippet; falls back to preview when query highlighting is empty (default window: 40 lines). Set `text_only=true` to drop HTML and shrink payloads; set `max_tokens` to omit the snippet if the doc exceeds your budget.\n- `GET /ai-help` — returns a JSON quickstart for agents (endpoints, CLI commands, limits, best practices).\n- `GET /metrics` — returns Prometheus-style counters for rate-limit/auth/error metrics.\n- If `--auth-token` is set, include `Authorization: Bearer ` on HTTP calls (including `/ai-help`).\n\n## CLI commands\n- `serve --repo [--host 127.0.0.1] [--port 46137] [--log info]` — start HTTP API with file watching for incremental updates.\n- `index --repo ` — rebuild the entire index.\n- `ingest --repo --file ` — reindex a single file.\n- `query --repo --query \"\" [--limit 8]` — run a search and print JSON hits.\n- `self-check --repo --terms \"foo,bar\" [--limit 5]` — scan the index for sensitive terms before enabling access (fails with non-zero exit if any are found; reports sample hits and if more exist). Includes built-in token/password patterns by default; disable with `--include-default-patterns=false` if you only want your provided terms.\n\n## Help and command discovery\n- List all commands/flags: `docdexd --help`.\n- Dump help for every subcommand: `docdexd help-all`.\n- See `serve` options (TLS, auth, rate limits, watcher): `docdexd serve --help`.\n- Indexing options: `docdexd index --help` (exclude paths, custom state dir).\n- Ad-hoc queries: `docdexd query --help`.\n- Self-check scanner options: `docdexd self-check --help`.\n- Agent help endpoint: `curl http://127.0.0.1:46137/ai-help` (include `Authorization: Bearer ` if `--auth-token` is set) for a JSON listing of endpoints, limits, and best practices.\n- MCP help/registration: `docdexd mcp --help` lists MCP flags; register with your client using `docdexd mcp --repo --log warn`. Example Codex config snippet:\n ```json\n {\n \"mcpServers\": {\n \"docdex\": {\n \"command\": \"docdexd\",\n \"args\": [\"mcp\", \"--repo\", \".\", \"--log\", \"warn\", \"--max-results\", \"8\"],\n \"env\": {}\n }\n }\n }\n ```\n- MCP quick add commands (popular agents):\n - Docdex helper: `docdex mcp-add --repo /path/to/repo --log warn --max-results 8` auto-detects supported agents; add `--all` to attempt every known client and print manual steps for UI-only ones, or `--remove` to uninstall.\n - Codex CLI: `codex mcp add docdex -- docdexd mcp --repo /path/to/repo --log warn --max-results 8`.\n - Generic JSON config (Cursor, Continue, Windsurf, Cline, Claude Desktop devtools): add the `mcpServers.docdex` block above to your MCP config file (paths vary by client; most accept the `command`/`args` schema shown).\n - Manual/stdio-only clients: start `docdexd mcp --repo /path/to/repo --log warn --max-results 8` yourself and point the client at that command/binary.\n- Tools exposed (CallToolResult content: result.content[0].text contains JSON):\n - `docdex_search` — args: `{ \"query\": \"\", \"limit\": , \"project_root\": \"\" }`. Returns `{ \"results\": [...], \"repo_root\": \"...\", \"state_dir\": \"...\", \"limit\": , \"project_root\": \"...\", \"meta\": {...} }`.\n - `docdex_index` — args: `{ \"paths\": [\"relative/or/absolute\"], \"project_root\": \"\" }`. Empty `paths` reindexes everything; otherwise ingests the listed files.\n - `docdex_files` — args: `{ \"limit\": , \"offset\": , \"project_root\": \"\" }`. Returns `{ \"results\": [{ \"doc_id\", \"rel_path\", \"summary\", \"token_estimate\" }], \"total\", \"limit\", \"offset\", \"repo_root\", \"project_root\" }`.\n - `docdex_open` — args: `{ \"path\": \"\", \"start_line\": , \"end_line\": , \"project_root\": \"\" }`. Returns `{ \"path\", \"start_line\", \"end_line\", \"total_lines\", \"content\", \"repo_root\", \"project_root\" }` (rejects paths outside repo and large files).\n - `docdex_stats` — args: `{ \"project_root\": \"\" }`. Returns `{ \"num_docs\", \"state_dir\", \"index_size_bytes\", \"segments\", \"avg_bytes_per_doc\", \"generated_at_epoch_ms\", \"last_updated_epoch_ms\", \"repo_root\", \"project_root\" }`.\n- Example calls:\n - Initialize: `{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{}}`\n - Initialize with workspace root: `{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{\"workspace_root\":\"/path/to/repo\"}}` (must match the server repo; sets default project_root for later calls)\n - List tools: `{\"jsonrpc\":\"2.0\",\"id\":2,\"method\":\"tools/list\"}`\n - Reindex: `{\"jsonrpc\":\"2.0\",\"id\":3,\"method\":\"tools/call\",\"params\":{\"name\":\"docdex_index\",\"arguments\":{\"paths\":[]}}}`\n - Search: `{\"jsonrpc\":\"2.0\",\"id\":4,\"method\":\"tools/call\",\"params\":{\"name\":\"docdex_search\",\"arguments\":{\"query\":\"payment auth flow\",\"limit\":3,\"project_root\":\"/repo\"}}}`\n - List files: `{\"jsonrpc\":\"2.0\",\"id\":5,\"method\":\"tools/call\",\"params\":{\"name\":\"docdex_files\",\"arguments\":{\"limit\":10,\"offset\":0}}}`\n - Open file: `{\"jsonrpc\":\"2.0\",\"id\":6,\"method\":\"tools/call\",\"params\":{\"name\":\"docdex_open\",\"arguments\":{\"path\":\"docs/readme.md\",\"start_line\":1,\"end_line\":20}}}`\n - Stats: `{\"jsonrpc\":\"2.0\",\"id\":7,\"method\":\"tools/call\",\"params\":{\"name\":\"docdex_stats\",\"arguments\":{}}}`\n- Errors: invalid JSON → code -32700; unsupported/missing `jsonrpc` → -32600; unknown tool/method → -32601; invalid params (empty query, bad args, project_root mismatch) → -32602; internal errors include a `reason` string in `error.data`.\n- Agent guidance: call `docdex_search` with concise queries before coding; fetch only a few hits; if results look stale, call `docdex_index`; keep using HTTP/CLI if your stack isn't MCP-aware.\n- Help: `docdexd mcp --help` shows MCP flags and defaults; `docdexd help-all` includes an MCP section listing tools and usage.\n\n## Troubleshooting\n- Stale index: re-run `docdexd index --repo `.\n- Port conflicts: change `--host/--port`.\n\n## Security considerations\n- Default bind is `127.0.0.1`; keep it unless you are behind a trusted reverse proxy/firewall. Avoid `--host 0.0.0.0` on untrusted networks.\n- By default, non-loopback binds require TLS; opt out only with `--require-tls=false` or `--insecure` when traffic is already terminating at a trusted proxy.\n- If exposing externally, place a reverse proxy in front, terminate TLS, and require auth (basic/OAuth/mTLS) plus IP/VPN allowlisting. Example (nginx):\n ```\n server {\n listen 443 ssl;\n server_name docdex.example.com;\n ssl_certificate /path/fullchain.pem;\n ssl_certificate_key /path/privkey.pem;\n auth_basic \"Protected\";\n auth_basic_user_file /etc/nginx/.htpasswd; # or hook OAuth/mTLS instead\n allow 10.0.0.0/8;\n allow 192.168.0.0/16;\n deny all;\n location / {\n proxy_pass http://127.0.0.1:46137;\n proxy_set_header Host $host;\n }\n }\n ```\n- Trim the corpus: prefer a curated staging directory, or use `--exclude-dir` / `--exclude-prefix` to keep secrets/private paths out before indexing; the watcher will ingest any in-scope file change under `repo`.\n- Mind logs: avoid verbose logging in production if snippets/paths are sensitive; reverse-proxy access logs can also capture query terms and paths.\n- Least privilege: run docdex under a low-privilege user/container and keep the state dir on a path with restricted permissions.\n- Validate before publish: run `docdexd query` for sensitive keywords to confirm no hits; store indexes on encrypted disks if required.\n- Optional hardening: require an auth token on the HTTP API (or proxy); enforce TLS when not on localhost (default) or explicitly opt out with `--require-tls=false`/`--insecure` only behind a trusted proxy; enable rate limiting (`--rate-limit-per-min`) and clamp `limit`/request sizes (`--max-limit`, `--max-query-bytes`, `--max-request-bytes`); escape/sanitize snippet HTML if embedding or disable snippets entirely with `--disable-snippet-text`; state dir is created `0700` by default—keep it under an unprivileged user, optionally `--run-as-uid/--run-as-gid`, `--chroot`, or containerize; keep access logging minimal/redacted (`--access-log`), and run `self-check` for sensitive terms before exposing the service; for at-rest confidentiality, place the state dir on encrypted storage or use host-level disk encryption.\n\n## Integrating with LLM tools\nDocdex is tool-agnostic. Drop-in recipe for agents/codegen tools:\n- Start once per repo: `docdexd index --repo ` then `docdexd serve --repo --host 127.0.0.1 --port 46137 --log warn` (or use the CLI directly without serving).\n- Configure via env: `DOCDEX_STATE_DIR` (index location), `DOCDEX_EXCLUDE_PREFIXES`, `DOCDEX_EXCLUDE_DIRS`, `RUST_LOG=docdexd=debug` (optional verbose logs).\n- Query over HTTP: `GET /search?q=&limit=` returns `{\"hits\":[{\"doc_id\",\"rel_path\",\"score\",\"summary\",\"snippet\",\"token_estimate\"}...]}`; `GET /snippet/:doc_id` fetches a focused snippet plus doc metadata.\n- Or query via CLI: `docdexd query --repo --query \"\" --limit 8` (JSON to stdout).\n- Health check: `GET /healthz` should return `ok` before issuing search requests.\n- Inject snippets into prompts:\n```\n\"You are building features for this repo. Use the following documentation snippets for context. If a snippet cites a path, keep that path in your response. Snippets:\\n\\nQuestion: \"\n```\n\n### MCP (optional stdio server for MCP-aware clients)\nDocdex can run as an MCP tool provider over stdio; it does not replace the HTTP daemon—pick whichever fits your agent/editor. If your MCP client supports resource templates, Docdex advertises a `docdex_file` template (`docdex://{path}`) which delegates to `docdex_open`.\n- Run: `docdexd mcp --repo /path/to/repo --log warn --max-results 8` (alias: `--mcp-max-results 8`).\n- Env override: `DOCDEX_MCP_MAX_RESULTS` clamps `docdex_search` results (min 1).\n- Packaging: MCP server is built into the main `docdexd` binary (invoked via `docdexd mcp` or `docdex mcp` from the npm bin); no separate `docdex-mcp` download required.\n- Registering with MCP clients: add a server named `docdex` that runs `docdexd mcp --repo --log warn`. Example Codex config snippet:\n ```json\n {\n \"mcpServers\": {\n \"docdex\": {\n \"command\": \"docdexd\",\n \"args\": [\"mcp\", \"--repo\", \".\", \"--log\", \"warn\", \"--max-results\", \"8\"],\n \"env\": {}\n }\n }\n }\n ```\n- MCP quick add commands (popular agents):\n - Docdex helper: `docdex mcp-add --repo /path/to/repo --log warn --max-results 8` auto-detects supported agents; add `--all` to attempt every known client and print manual steps for UI-only ones, or `--remove` to uninstall.\n - Codex CLI: `codex mcp add docdex -- docdexd mcp --repo /path/to/repo --log warn --max-results 8`.\n - Generic JSON config (Cursor, Continue, Windsurf, Cline, Claude Desktop devtools): add the `mcpServers.docdex` block above to your MCP config file (paths vary by client; most accept the `command`/`args` schema shown).\n - Manual/stdio-only clients: start `docdexd mcp --repo /path/to/repo --log warn --max-results 8` yourself and point the client at that command/binary.\n- Tools exposed (CallToolResult content: result.content[0].text contains JSON):\n - `docdex_search` — args: `{ \"query\": \"\", \"limit\": , \"project_root\": \"\" }`. Returns `{ \"results\": [...], \"repo_root\": \"...\", \"state_dir\": \"...\", \"limit\": , \"project_root\": \"...\", \"meta\": {...} }`.\n - `docdex_index` — args: `{ \"paths\": [\"relative/or/absolute\"], \"project_root\": \"\" }`. Empty `paths` reindexes everything; otherwise ingests the listed files.\n - `docdex_files` — args: `{ \"limit\": , \"offset\": , \"project_root\": \"\" }`. Returns `{ \"results\": [{ \"doc_id\", \"rel_path\", \"summary\", \"token_estimate\" }], \"total\", \"limit\", \"offset\", \"repo_root\", \"project_root\" }`.\n - `docdex_open` — args: `{ \"path\": \"\", \"start_line\": , \"end_line\": , \"project_root\": \"\" }`. Returns `{ \"path\", \"start_line\", \"end_line\", \"total_lines\", \"content\", \"repo_root\", \"project_root\" }` (rejects paths outside repo and large files).\n - `docdex_stats` — args: `{ \"project_root\": \"\" }`. Returns `{ \"num_docs\", \"state_dir\", \"index_size_bytes\", \"segments\", \"avg_bytes_per_doc\", \"generated_at_epoch_ms\", \"last_updated_epoch_ms\", \"repo_root\", \"project_root\" }`.\n- Example calls:\n - Initialize: `{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{}}`\n - Initialize with workspace root: `{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"initialize\",\"params\":{\"workspace_root\":\"/path/to/repo\"}}` (must match the server repo; sets default project_root for later calls)\n - List tools: `{\"jsonrpc\":\"2.0\",\"id\":2,\"method\":\"tools/list\"}`\n - Reindex: `{\"jsonrpc\":\"2.0\",\"id\":3,\"method\":\"tools/call\",\"params\":{\"name\":\"docdex_index\",\"arguments\":{\"paths\":[]}}}`\n - Search: `{\"jsonrpc\":\"2.0\",\"id\":4,\"method\":\"tools/call\",\"params\":{\"name\":\"docdex_search\",\"arguments\":{\"query\":\"payment auth flow\",\"limit\":3,\"project_root\":\"/repo\"}}}`\n - List files: `{\"jsonrpc\":\"2.0\",\"id\":5,\"method\":\"tools/call\",\"params\":{\"name\":\"docdex_files\",\"arguments\":{\"limit\":10,\"offset\":0}}}`\n - Open file: `{\"jsonrpc\":\"2.0\",\"id\":6,\"method\":\"tools/call\",\"params\":{\"name\":\"docdex_open\",\"arguments\":{\"path\":\"docs/readme.md\",\"start_line\":1,\"end_line\":20}}}`\n - Stats: `{\"jsonrpc\":\"2.0\",\"id\":7,\"method\":\"tools/call\",\"params\":{\"name\":\"docdex_stats\",\"arguments\":{}}}`\n- Errors: invalid JSON → code -32700; unsupported/missing `jsonrpc` → -32600; unknown tool/method → -32601; invalid params (empty query, bad args, project_root mismatch) → -32602; internal errors include a `reason` string in `error.data`.\n- Agent guidance: call `docdex_search` with concise queries before coding; fetch only a few hits; if results look stale, call `docdex_index`; keep using HTTP/CLI if your stack isn't MCP-aware.\n- Help: `docdexd mcp --help` shows MCP flags and defaults; `docdexd help-all` includes an MCP section listing tools and usage.\n\n## HTTPS and Certbot\n- TLS accepts PKCS8, PKCS1/RSA, and SEC1/EC private keys (compatible with Certbot output).\n- Manual cert/key: `docdexd serve --repo --tls-cert /path/fullchain.pem --tls-key /path/privkey.pem`.\n- Certbot helper: `docdexd serve --repo --host 0.0.0.0 --port 46137 --certbot-domain docs.example.com` (uses `/etc/letsencrypt/live/docs.example.com/{fullchain.pem,privkey.pem}`), or pass `--certbot-live-dir /custom/live/dir`.\n- When using Certbot, set a deploy hook to restart/reload docdex after renewals (e.g., `certbot renew --deploy-hook \"systemctl restart docdexd.service\"` or kill -HUP your process supervisor).\n- If binding to 443 directly, you need privileges; otherwise, keep docdex on 127.0.0.1 and let a reverse proxy terminate TLS.","name","English","tag","en-US",{"_44":45,"_13":46,"_52":34,"_53":34,"_35":36,"_16":54,"_55":56,"_57":58,"_66":38,"_67":68,"_69":-5,"_70":71,"_210":211,"_216":-5,"_65":36,"_217":68,"_190":218,"_219":220},"addedAt","2025-11-29T13:56:43.252795Z",[47,48,49,50,51],"category:rag-systems","category:search","language:rust","license_grade:a","author:claimed","descriptionMarkdown","descriptionPlainText",14518,"integrations",[],"namespace",{"_59":60,"_65":64},"owner",{"_61":62},"githubAccount",{"_63":64},"login","bekirdag","slug","readmeMarkdown","recentUsage",0,"redditPostExternalId","repository",{"_72":73,"_174":175,"_178":179,"_198":199,"_202":203,"_204":-5,"_205":206},"argumentsJsonSchema",{"_74":75,"_171":172,"_79":173},"properties",{"_76":77,"_81":82,"_84":85,"_87":88,"_90":91,"_93":94,"_96":97,"_99":100,"_102":103,"_105":106,"_108":109,"_111":112,"_114":115,"_117":118,"_120":121,"_123":124,"_126":127,"_129":130,"_132":133,"_135":136,"_138":139,"_141":142,"_144":145,"_147":148,"_150":151,"_153":154,"_156":157,"_159":160,"_162":163,"_165":166,"_168":169},"RUST_LOG",{"_33":78,"_79":80},"Logging level filter (e.g., RUST_LOG=docdexd=debug).","type","string","DOCDEX_CHROOT",{"_33":83,"_79":80},"(Unix) Chroot into path before serving; repo/state paths must exist inside that jail.","DOCDEX_TLS_KEY",{"_33":86,"_79":80},"Serve HTTPS with the provided key file path.","DOCDEX_TLS_CERT",{"_33":89,"_79":80},"Serve HTTPS with the provided cert file path.","DOCDEX_ALLOW_IPS",{"_33":92,"_79":80},"Optional comma-separated IPs/CIDRs allowed to reach the HTTP API (default: loopback-only in secure mode; allow all when secure mode is disabled).","DOCDEX_MAX_LIMIT",{"_33":95,"_79":80},"Clamp HTTP limit to at most n (default: 8).","DOCDEX_STATE_DIR",{"_33":98,"_79":80},"Override index storage path (relative paths are resolved under repo).","DOCDEX_ACCESS_LOG",{"_33":101,"_79":80},"Emit minimal structured access logs with query values redacted (default: true).","DOCDEX_AUTH_TOKEN",{"_33":104,"_79":80},"Bearer token required in secure mode (default); omit only when starting with --secure-mode=false.","DOCDEX_RUN_AS_GID",{"_33":107,"_79":80},"(Unix) Drop privileges to the provided GID after startup prep.","DOCDEX_RUN_AS_UID",{"_33":110,"_79":80},"(Unix) Drop privileges to the provided UID after startup prep.","DOCDEX_REQUIRE_TLS",{"_33":113,"_79":80},"Default true. Enforce TLS for non-loopback binds; set to false when TLS is already terminated by a trusted proxy.","DOCDEX_SECURE_MODE",{"_33":116,"_79":80},"Default true; when enabled, requires an auth token, loopback allowlist by default, and default rate limiting (60 req/min).","DOCDEX_UNSHARE_NET",{"_33":119,"_79":80},"(Linux only) Unshare the network namespace before serving (requires CAP_SYS_ADMIN/root); no-op on other platforms.","DOCDEX_EXCLUDE_DIRS",{"_33":122,"_79":80},"Extra directory names to skip anywhere in the tree (comma-separated).","DOCDEX_AUDIT_DISABLE",{"_33":125,"_79":80},"Disable audit logging entirely.","DOCDEX_DOWNLOAD_REPO",{"_33":128,"_79":80},"If you publish from a fork, set DOCDEX_DOWNLOAD_REPO= before installing so the downloader fetches your release assets.","DOCDEX_INSECURE_HTTP",{"_33":131,"_79":80},"Allow plain HTTP on non-loopback binds even when TLS is enforced (only use behind a trusted proxy).","DOCDEX_AUDIT_LOG_PATH",{"_33":134,"_79":80},"Write audit log JSONL to this path (default: /audit.log).","DOCDEX_CERTBOT_DOMAIN",{"_33":137,"_79":80},"Point TLS at /etc/letsencrypt/live//{fullchain.pem,privkey.pem} (Certbot). Conflicts with manual --tls-*.","DOCDEX_AUDIT_MAX_BYTES",{"_33":140,"_79":80},"Rotate audit log after this many bytes (default: 5_000_000).","DOCDEX_AUDIT_MAX_FILES",{"_33":143,"_79":80},"Keep at most this many rotated audit files (default: 5).","DOCDEX_MAX_QUERY_BYTES",{"_33":146,"_79":80},"Reject requests whose query string exceeds n bytes (default: 4096).","DOCDEX_MCP_MAX_RESULTS",{"_33":149,"_79":80},"Clamps docdex_search results (min 1).","DOCDEX_CERTBOT_LIVE_DIR",{"_33":152,"_79":80},"Use a specific Certbot live dir containing fullchain.pem and privkey.pem.","DOCDEX_EXCLUDE_PREFIXES",{"_33":155,"_79":80},"Extra relative prefixes to skip (comma-separated).","DOCDEX_RATE_LIMIT_BURST",{"_33":158,"_79":80},"Optional burst capacity for the rate limiter (defaults to per-minute limit when 0).","DOCDEX_MAX_REQUEST_BYTES",{"_33":161,"_79":80},"Reject requests whose Content-Length or size hint exceeds n bytes (default: 16384).","DOCDEX_RATE_LIMIT_PER_MIN",{"_33":164,"_79":80},"Per-IP request budget per minute (default 60 in secure mode when unset/0; 0 disables when secure mode is off).","DOCDEX_STRIP_SNIPPET_HTML",{"_33":167,"_79":80},"Omit snippet.html in responses to force text-only snippets (HTML is sanitized by default when present).","DOCDEX_DISABLE_SNIPPET_TEXT",{"_33":170,"_79":80},"Omit snippet text/html in responses entirely (only doc metadata is returned).","required",[],"object","githubProject",{"_37":38,"_176":177},"url","https://github.com/bekirdag/docdex","githubRepository",{"_180":181,"_182":183,"_184":185,"_16":186,"_187":188,"_39":36,"_59":189,"_192":193,"_194":195,"_197":193},"defaultBranch","main","fullName","bekirdag/docdex","githubTreeId",3723726,43164,"language","Rust",{"_63":64,"_190":191},"uid","nf3x1w2axl","recentStargazers",4,"spdxLicense",{"_39":196},"MIT License","stargazers","glamaJson",{"_200":201},"maintainers",[64],"inspectable",false,"npmPackage","supportedPlatforms",[207,208,209],"MACOS","LINUX","WINDOWS","scores",{"_212":213,"_214":-5,"_215":-5},"license",100,"quality","security","simpleIcon","toolCount","0qe3apqywc","updatedAt","2025-11-29T14:13:07.938278Z","meta",[223,226,228,235,238,240,243,246,249,252,255,257,260,263,265,267,269,271,273],{"_224":225},"title","docdex | Glama",{"_227":34,"_39":33},"content",{"_229":230,"_231":232,"_233":234},"href","https://glama.ai/mcp/servers/@bekirdag/docdex","rel","canonical","tagName","link",{"_227":36,"_236":237},"property","og:title",{"_227":34,"_236":239},"og:description",{"_227":241,"_236":242},"https://glama.ai/logo.png","og:logo",{"_227":244,"_236":245},"https://glama.ai/mcp/servers/@bekirdag/docdex/og-image","og:image",{"_227":247,"_236":248},"630","og:image:height",{"_227":250,"_236":251},"1200","og:image:width",{"_227":253,"_236":254},"website","og:type",{"_227":230,"_236":256},"og:url",{"_227":258,"_236":259},"Glama – MCP Hosting Platform","og:site_name",{"_227":261,"_39":262},"summary_large_image","twitter:card",{"_227":258,"_39":264},"twitter:title",{"_227":34,"_39":266},"twitter:description",{"_227":244,"_39":268},"twitter:image",{"_227":247,"_39":270},"twitter:image:height",{"_227":250,"_39":272},"twitter:image:width",{"_274":275},"script:ld+json",{"_276":277,"_278":279},"@context","http://schema.org","@graph",[280],{"_276":281,"_282":283,"_284":285},"https://schema.org","@type","BreadcrumbList","itemListElement",[286,293,296,300],{"_282":287,"_288":289,"_39":290,"_291":292},"ListItem","item","https://glama.ai/","Glama","position",1,{"_282":287,"_288":294,"_39":295,"_291":22},"https://glama.ai/mcp","MCP",{"_282":287,"_288":297,"_39":298,"_291":299},"https://glama.ai/mcp/servers","Servers",3,{"_282":287,"_288":230,"_39":36,"_291":193},"visitorIsMaintainer","routes/_public/mcp/servers/~namespace/~slug/_pages/_explorer/blob/~commit/~/_route",{"_304":305,"_31":311,"_360":361,"_221":373,"_370":397,"_398":399},"blob",{"_227":306,"_307":308,"_309":310},"{\n \"name\": \"docdex-smithery-adapter\",\n \"version\": \"1.0.0\",\n \"type\": \"module\",\n \"dependencies\": {\n \"express\": \"^4.18.2\",\n \"body-parser\": \"^1.20.2\"\n }\n}","fileName","package.json","size",161,{"_44":45,"_13":312,"_52":34,"_53":34,"_35":36,"_16":54,"_55":313,"_57":314,"_66":38,"_67":68,"_69":-5,"_70":317,"_210":359,"_216":-5,"_65":36,"_217":68,"_190":218,"_219":220},[47,48,49,50,51],[],{"_59":315,"_65":64},{"_61":316},{"_63":64},{"_72":318,"_174":352,"_178":353,"_198":356,"_202":203,"_204":-5,"_205":358},{"_74":319,"_171":351,"_79":173},{"_76":320,"_81":321,"_84":322,"_87":323,"_90":324,"_93":325,"_96":326,"_99":327,"_102":328,"_105":329,"_108":330,"_111":331,"_114":332,"_117":333,"_120":334,"_123":335,"_126":336,"_129":337,"_132":338,"_135":339,"_138":340,"_141":341,"_144":342,"_147":343,"_150":344,"_153":345,"_156":346,"_159":347,"_162":348,"_165":349,"_168":350},{"_33":78,"_79":80},{"_33":83,"_79":80},{"_33":86,"_79":80},{"_33":89,"_79":80},{"_33":92,"_79":80},{"_33":95,"_79":80},{"_33":98,"_79":80},{"_33":101,"_79":80},{"_33":104,"_79":80},{"_33":107,"_79":80},{"_33":110,"_79":80},{"_33":113,"_79":80},{"_33":116,"_79":80},{"_33":119,"_79":80},{"_33":122,"_79":80},{"_33":125,"_79":80},{"_33":128,"_79":80},{"_33":131,"_79":80},{"_33":134,"_79":80},{"_33":137,"_79":80},{"_33":140,"_79":80},{"_33":143,"_79":80},{"_33":146,"_79":80},{"_33":149,"_79":80},{"_33":152,"_79":80},{"_33":155,"_79":80},{"_33":158,"_79":80},{"_33":161,"_79":80},{"_33":164,"_79":80},{"_33":167,"_79":80},{"_33":170,"_79":80},[],{"_37":38,"_176":177},{"_180":181,"_182":183,"_184":185,"_16":186,"_187":188,"_39":36,"_59":354,"_192":193,"_194":355,"_197":193},{"_63":64,"_190":191},{"_39":196},{"_200":357},[64],[207,208,209],{"_212":213,"_214":-5,"_215":-5},"member",{"_362":363,"_366":367,"_368":308,"_184":185,"_369":-5,"_370":308,"_371":372,"_309":310,"_79":304},"commit",{"_364":365},"sha","223001a4ae35eafa11b6fde78290ce1a9b237dec","contentStoredObjectPointerId",20552195,"fullPath","indexable","path","safeToDisplayAsText",true,[374,376,378,380,382,383,384,386,387,388,389,390,391,392,393,394,395,396],{"_224":375},"package.json | docdex | Glama",{"_227":377,"_39":33},"Enterprise-grade security, privacy, and features like agents, MCP, prompt templates, and more.",{"_229":379,"_231":232,"_233":234},"https://glama.ai/mcp/servers/@bekirdag/docdex/blob/223001a4ae35eafa11b6fde78290ce1a9b237dec/",{"_227":381,"_236":237},"package.json | docdex",{"_227":377,"_236":239},{"_227":241,"_236":242},{"_227":385,"_236":245},"https://glama.ai/generated-images/og?title=package.json+%7C+docdex",{"_227":247,"_236":248},{"_227":250,"_236":251},{"_227":253,"_236":254},{"_227":379,"_236":256},{"_227":258,"_236":259},{"_227":261,"_39":262},{"_227":258,"_39":264},{"_227":377,"_39":266},{"_227":385,"_39":268},{"_227":247,"_39":270},{"_227":250,"_39":272},"","treeMembers",[400,404,407,410,413,416,419,422,425,428,431,434,437,440,443,446,448,451,454,457,460,463,466],{"_362":401,"_368":402,"_370":402,"_79":403},{"_364":365},".github","tree",{"_362":405,"_368":406,"_370":406,"_79":403},{"_364":365},"npm",{"_362":408,"_368":409,"_370":409,"_79":403},{"_364":365},"src",{"_362":411,"_368":412,"_370":412,"_79":403},{"_364":365},"tests",{"_362":414,"_368":415,"_370":415,"_79":403},{"_364":365},".well-known",{"_362":417,"_368":418,"_370":418,"_79":304},{"_364":365},"AGENT_PROMPT.md",{"_362":420,"_368":421,"_370":421,"_79":304},{"_364":365},"Cargo.lock",{"_362":423,"_368":424,"_370":424,"_79":304},{"_364":365},"Cargo.toml",{"_362":426,"_368":427,"_370":427,"_79":304},{"_364":365},"CHANGELOG.md",{"_362":429,"_368":430,"_370":430,"_79":304},{"_364":365},"CLA.md",{"_362":432,"_368":433,"_370":433,"_79":304},{"_364":365},"CONTRIBUTING.md",{"_362":435,"_368":436,"_370":436,"_79":304},{"_364":365},"Dockerfile",{"_362":438,"_368":439,"_370":439,"_79":304},{"_364":365},".gitignore",{"_362":441,"_368":442,"_370":442,"_79":304},{"_364":365},"glama.json",{"_362":444,"_368":445,"_370":445,"_79":304},{"_364":365},"LICENSE",{"_362":447,"_368":308,"_370":308,"_79":304},{"_364":365},{"_362":449,"_368":450,"_370":450,"_79":304},{"_364":365},"README.md",{"_362":452,"_368":453,"_370":453,"_79":304},{"_364":365},"release-please-config.json",{"_362":455,"_368":456,"_370":456,"_79":304},{"_364":365},".release-please-manifest.json",{"_362":458,"_368":459,"_370":459,"_79":304},{"_364":365},"server.js",{"_362":461,"_368":462,"_370":462,"_79":304},{"_364":365},"server.json",{"_362":464,"_368":465,"_370":465,"_79":304},{"_364":365},"smithery.yaml",{"_362":467,"_368":468,"_370":468,"_79":304},{"_364":365},"v0.1.10","actionData","errors"]

MCP directory API