docpull 2.4.0__tar.gz → 2.5.1__tar.gz

{docpull-2.4.0/src/docpull.egg-info → docpull-2.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docpull
-Version: 2.4.0
+Version: 2.5.1
 Summary: Pull documentation from the web and convert to clean markdown
 Author-email: Zachary Roth <support@raintree.technology>
 Maintainer-email: Raintree Technology <support@raintree.technology>
@@ -222,7 +222,7 @@ pip install 'docpull[mcp]'
 docpull mcp  # starts the stdio server
 ```
 
-Add to Claude Desktop or Claude Code:
+Add to Claude Desktop or Claude Code manually:
 
 ```json
 {
@@ -235,13 +235,39 @@ Add to Claude Desktop or Claude Code:
 }
 ```
 
-Tools exposed:
+Or, if you use Claude Code, install the plugin instead — it bundles the MCP
+server, five slash commands (`/docs-add`, `/docs-search`, `/docs-list`,
+`/docs-refresh`, `/docs-remove`), and a meta-skill that teaches Claude
+when to reach for docpull automatically:
 
-- `fetch_url(url, max_tokens?)` — one-shot fetch, no crawl
-- `ensure_docs(source, force?)` — fetch a named library (cached 7 days)
+```bash
+# 1. Install docpull with the MCP extra (required for the plugin)
+pip install 'docpull[mcp]'
+```
+
+```
+# 2. Then in Claude Code:
+/plugin marketplace add raintree-technology/docpull
+/plugin install docpull@docpull
+```
+
+See [plugin/README.md](plugin/README.md) for details.
+
+Tools exposed (8 total — read tools advertise `readOnlyHint` so hosts that auto-approve safe tools won't prompt):
+
+Read:
+- `fetch_url(url, max_tokens?)` — one-shot fetch, no crawl. HTTPS-only, SSRF-validated.
 - `list_sources(category?)` — show available aliases (react, nextjs, fastapi, …)
-- `list_indexed()` — what has been fetched locally
-- `grep_docs(pattern, library?)` — regex search across fetched Markdown
+- `list_indexed()` — what has been fetched locally, with last-fetched age
+- `grep_docs(pattern, library?, limit?, context?)` — regex search across fetched Markdown (length-capped + wall-clock budgeted to mitigate ReDoS)
+- `read_doc(library, path, line_start?, line_end?)` — read a specific cached file, optionally line-sliced
+
+Write:
+- `ensure_docs(source, force?, profile?)` — fetch a named library (cached 7 days). Forwards progress to clients that supply a `progressToken`.
+- `add_source(name, url, description?, category?, max_pages?, force?)` — register a user alias (HTTPS-only, atomic write to `sources.yaml`).
+- `remove_source(name, delete_cache?)` — drop a user alias and (optionally) its cached docs.
+
+All tools that carry data also return `structuredContent` validated against an `outputSchema` for clients that prefer typed output.
 
 User-defined sources live in `~/.config/docpull-mcp/sources.yaml`:
 

{docpull-2.4.0 → docpull-2.5.1}/README.md

@@ -140,7 +140,7 @@ pip install 'docpull[mcp]'
 docpull mcp  # starts the stdio server
 ```
 
-Add to Claude Desktop or Claude Code:
+Add to Claude Desktop or Claude Code manually:
 
 ```json
 {
@@ -153,13 +153,39 @@ Add to Claude Desktop or Claude Code:
 }
 ```
 
-Tools exposed:
+Or, if you use Claude Code, install the plugin instead — it bundles the MCP
+server, five slash commands (`/docs-add`, `/docs-search`, `/docs-list`,
+`/docs-refresh`, `/docs-remove`), and a meta-skill that teaches Claude
+when to reach for docpull automatically:
 
-- `fetch_url(url, max_tokens?)` — one-shot fetch, no crawl
-- `ensure_docs(source, force?)` — fetch a named library (cached 7 days)
+```bash
+# 1. Install docpull with the MCP extra (required for the plugin)
+pip install 'docpull[mcp]'
+```
+
+```
+# 2. Then in Claude Code:
+/plugin marketplace add raintree-technology/docpull
+/plugin install docpull@docpull
+```
+
+See [plugin/README.md](plugin/README.md) for details.
+
+Tools exposed (8 total — read tools advertise `readOnlyHint` so hosts that auto-approve safe tools won't prompt):
+
+Read:
+- `fetch_url(url, max_tokens?)` — one-shot fetch, no crawl. HTTPS-only, SSRF-validated.
 - `list_sources(category?)` — show available aliases (react, nextjs, fastapi, …)
-- `list_indexed()` — what has been fetched locally
-- `grep_docs(pattern, library?)` — regex search across fetched Markdown
+- `list_indexed()` — what has been fetched locally, with last-fetched age
+- `grep_docs(pattern, library?, limit?, context?)` — regex search across fetched Markdown (length-capped + wall-clock budgeted to mitigate ReDoS)
+- `read_doc(library, path, line_start?, line_end?)` — read a specific cached file, optionally line-sliced
+
+Write:
+- `ensure_docs(source, force?, profile?)` — fetch a named library (cached 7 days). Forwards progress to clients that supply a `progressToken`.
+- `add_source(name, url, description?, category?, max_pages?, force?)` — register a user alias (HTTPS-only, atomic write to `sources.yaml`).
+- `remove_source(name, delete_cache?)` — drop a user alias and (optionally) its cached docs.
+
+All tools that carry data also return `structuredContent` validated against an `outputSchema` for clients that prefer typed output.
 
 User-defined sources live in `~/.config/docpull-mcp/sources.yaml`:
 

{docpull-2.4.0 → docpull-2.5.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "docpull"
-version = "2.4.0"
+version = "2.5.1"
 dynamic = []
 description = "Pull documentation from the web and convert to clean markdown"
 readme = {file = "README.md", content-type = "text/markdown"}

{docpull-2.4.0 → docpull-2.5.1}/src/docpull/__init__.py

@@ -14,7 +14,7 @@ Usage:
             print(event)
 """
 
-__version__ = "2.4.0"
+__version__ = "2.5.1"
 
 from .cache import CacheManager, StreamingDeduplicator
 from .conversion.chunking import Chunk, TokenCounter, chunk_markdown