rtfm-mcp 0.8.0__py3-none-any.whl

rtfm_mcp-0.8.0.dist-info/METADATA

@@ -0,0 +1,122 @@
+Metadata-Version: 2.5
+Name: rtfm-mcp
+Version: 0.8.0
+Summary: Read The Full Manual — local document-corpus search MCP server.
+Project-URL: Homepage, https://github.com/canlin-zhang/rtfm
+Project-URL: Repository, https://github.com/canlin-zhang/rtfm
+Project-URL: Issues, https://github.com/canlin-zhang/rtfm/issues
+Author: Canlin Zhang
+License-Expression: MIT
+License-File: LICENSE
+Keywords: documentation,mcp,pdf,search
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.11
+Requires-Dist: mcp[cli]<2,>=1.28.1
+Requires-Dist: pymupdf
+Requires-Dist: pypdf
+Description-Content-Type: text/markdown
+
+# rtfm
+
+> **rtfm** — Read the ~~F-~~ **Full** Manual.
+
+A local MCP server and Claude Code plugin that makes large, can't-read-by-hand technical
+documentation searchable — PDF spec sets, documentation repositories (and, later, public
+doc sites) — and answers questions strictly from that material, with grounded citations.
+The server is also published as the `rtfm-mcp` Python package.
+
+The eternal advice "read the manual" falls apart when the manual is a 400-page protocol
+spec or a vendor doc-set no human can hold in their head. `rtfm` ingests the **full** manual
+so the answer is one cited query away.
+
+## Limitations
+
+`rtfm` indexes the **extractable text** a document already carries. It does not OCR images
+and does not execute JavaScript, so image-only/scanned PDFs and image-only or JS-rendered
+web pages are out of scope — they index as empty. (See [ADR 0005](https://github.com/canlin-zhang/rtfm/blob/main/docs/adr/0005-text-extraction-only-no-ocr.md).)
+
+## Install
+
+### Claude Code
+
+```bash
+# in Claude Code:
+/plugin marketplace add canlin-zhang/rtfm
+/plugin install rtfm
+```
+
+### Any MCP client (PyPI)
+
+The server is also published as `rtfm-mcp`:
+
+```bash
+uvx --from rtfm-mcp rtfm-server      # or: pipx install rtfm-mcp && rtfm-server
+```
+
+Point the client's MCP configuration at that command:
+
+```json
+{
+  "mcpServers": {
+    "rtfm": {
+      "command": "uvx",
+      "args": ["--from", "rtfm-mcp", "rtfm-server"]
+    }
+  }
+}
+```
+
+**Prerequisites:** `python3` on PATH is the only hard requirement for the plugin. It
+uses `uv` when available and otherwise builds a private venv under `~/.rtfm/venv` on
+first run. The PyPI path needs `uv` (for `uvx`) or `pipx`.
+*Optional:* install `poppler-utils` (`pdftotext`) for best-quality PDF extraction.
+
+## Two ways to use it
+
+**Quick-and-dirty (the `default` drop-dir).** Drop PDFs or Markdown/text into `~/.rtfm/default`
+and just `search` — the default dir re-indexes itself on search, so dropped files show up with
+no extra step. Keep it small; it's a scratch space.
+
+**Organized corpus (pointed-to folders).** For a large, structured doc set (e.g. a vendor's
+documentation tree), add a `dir` source in `~/.rtfm/manifest.toml` pointing at the folder, then
+build it once:
+
+```
+reindex("vendor-docs")
+```
+
+Searches are instant afterward. `dir` sources auto-reindex inline when the delta is small
+(`RTFM_AUTO_REINDEX_MAX`, default 10); a larger delta returns a warning telling you to run
+`reindex` once. `git_repo` sources are the exception to the budget: a stale or never-indexed
+source always auto-reindexes inline on search — no budget gate, warns loudly on failure —
+including the initial clone for managed sources, so the first search over a fresh corpus can
+take a while. Byte-identical files that repeat across version subfolders are extracted once;
+`find_duplicates` lists every path a given content lives at.
+
+## Use
+
+Drop PDFs / `.md` / `.mdx` / `.rst` / `.txt` into `~/.rtfm/default/`, then ask Claude to search them, or
+add more sources by editing `~/.rtfm/manifest.toml` (see `manifest.example.toml`).
+
+Or invoke the bundled **`read-the-manual`** skill (`/read-the-manual`) to have a question
+answered strictly from the corpus — verbatim quotes with page/line citations, no
+model-knowledge fallback.
+
+## Status
+
+Early but working. Today rtfm gives you zero-config search over a default drop-folder: PDF,
+Markdown, reStructuredText, and text files are indexed into one content-addressed full-text
+index with page/line citations, exposed through the `search` / `read` / `reindex` /
+`find_duplicates` / `list_sources` / `health_check` tools and the `read-the-manual` skill, with
+a uv-or-venv launcher and Claude Code plugin packaging. HTML with anchor citations, git-backed
+repo sources with auto-refresh, file-curation tools, and OCR are planned — see the
+[roadmap](https://github.com/canlin-zhang/rtfm/blob/main/docs/ROADMAP.md).
+
+Architecture decisions live in [docs/adr/](https://github.com/canlin-zhang/rtfm/tree/main/docs/adr/); domain language in
+[CONTEXT.md](https://github.com/canlin-zhang/rtfm/blob/main/CONTEXT.md).
+
+## License
+
+MIT © Canlin Zhang

rtfm_mcp-0.8.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+rtfm_server.py,sha256=Ha-yKmReSrTg4sZH7MR-qBX17O6hWUNW4S_hWxgpqdY,103420
+rtfm_mcp-0.8.0.dist-info/METADATA,sha256=KKpl_i49c5GbfrGhipd7V4jZnjSa5I9VO39opDg1ef8,4852
+rtfm_mcp-0.8.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+rtfm_mcp-0.8.0.dist-info/entry_points.txt,sha256=_zP_z1z0ZmzGDkUbamncYMo6bj2dRy4oyKdOTe7qF4A,49
+rtfm_mcp-0.8.0.dist-info/licenses/LICENSE,sha256=jJN24YU8u1-uJ-AslZpH46v8hLLc0co2Y7jNg4FM588,1069
+rtfm_mcp-0.8.0.dist-info/RECORD,,

rtfm_mcp-0.8.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

rtfm_mcp-0.8.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+rtfm-server = rtfm_server:main

rtfm_mcp-0.8.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Canlin Zhang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, 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.
+
+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
+AUTHORS OR COPYRIGHT HOLDERS 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.