docs-kit 0.1.1__py3-none-any.whl

docs_kit-0.1.1.dist-info/METADATA

@@ -0,0 +1,268 @@
+Metadata-Version: 2.3
+Name: docs-kit
+Version: 0.1.1
+Summary: Fetch docs, embed locally, expose via MCP for AI agents.
+License: MIT License
+        
+        Copyright (c) 2026 Docs Kit Limited
+        
+        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.
+Requires-Python: >=3.11
+Requires-Dist: click>=8.0.0
+Requires-Dist: fastembed>=0.6.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: mcp>=1.0.0
+Requires-Dist: pydantic-settings>=2.2.1
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: qdrant-client>=1.10.0
+Requires-Dist: tomli-w>=1.0.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: starlette>=0.36.0; extra == 'dev'
+Requires-Dist: uvicorn>=0.27.0; extra == 'dev'
+Provides-Extra: sse
+Requires-Dist: starlette>=0.36.0; extra == 'sse'
+Requires-Dist: uvicorn>=0.27.0; extra == 'sse'
+Description-Content-Type: text/markdown
+
+# docs-kit
+
+[![PyPI version](https://img.shields.io/pypi/v/docs-kit)](https://pypi.org/project/docs-kit/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+[![Python](https://img.shields.io/pypi/pyversions/docs-kit)](https://pypi.org/project/docs-kit/)
+[![CI](https://github.com/docs-kit/docs-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/docs-kit/docs-kit/actions/workflows/ci.yml)
+
+Fetch docs from GitBook, Mintlify, or local files, embed them locally, and expose retrieval to AI tools over MCP.
+
+No API keys are required for the default local embedding path.
+
+## What it does
+
+- Fetches public docs from GitBook and Mintlify sites via `llms-full.txt` / `llms.txt` (with sitemap.xml fallback for Mintlify)
+- Ingests local `.md` and `.txt` files
+- Stores vectors in local Qdrant by default
+- Serves an MCP server over `stdio` or SSE
+- Exposes MCP tools to ingest, remove, and list sources at runtime
+- Installs MCP config for supported AI clients
+
+## Install
+
+```bash
+pip install docs-kit
+```
+
+Or with `npx`:
+
+```bash
+npx docs-kit ingest https://docs.example.com
+```
+
+## Quickstart
+
+```bash
+# 1. Create a config file
+docs-kit init
+
+# 2. Ingest docs (GitBook or Mintlify — auto-detected)
+docs-kit ingest https://docs.elevenlabs.io
+
+# 3. Check the collection
+docs-kit inspect
+
+# 4. Install into your client
+docs-kit install claude-code
+```
+
+## Commands
+
+### `docs-kit init`
+
+Create `docs-kit.yaml`.
+
+```bash
+docs-kit init
+docs-kit init --dir ./sandbox
+```
+
+### `docs-kit ingest <path-or-url>`
+
+Ingest a local file, directory, or documentation URL into the vector store. Supports GitBook and Mintlify sites out of the box — auto-detected by default.
+
+```bash
+docs-kit ingest ./docs
+docs-kit ingest https://docs.example.com
+docs-kit ingest https://docs.mintlify-site.com --provider mintlify
+docs-kit ingest https://docs.gitbook-site.com --provider gitbook
+docs-kit ingest ./docs --recreate
+```
+
+`--provider` accepts `auto` (default), `gitbook`, or `mintlify`. In `auto` mode, the fetcher tries `/llms-full.txt` → `/llms.txt` → `/sitemap.xml` in order.
+
+### `docs-kit fetch <url>`
+
+Download GitBook docs as Markdown without ingesting them.
+
+```bash
+docs-kit fetch https://docs.example.com
+docs-kit fetch https://docs.example.com --output ./downloaded-docs
+```
+
+### `docs-kit serve`
+
+Run the MCP server. `stdio` is the default. Use SSE for HTTP clients.
+
+```bash
+docs-kit serve
+docs-kit serve --transport sse --port 3001
+docs-kit serve --config ./docs-kit.yaml
+```
+
+### `docs-kit install <agent>`
+
+Install docs-kit into a supported client config.
+
+```bash
+docs-kit install claude-code
+docs-kit install codex
+docs-kit install claude-code --project
+docs-kit install cursor --config ./docs-kit.yaml
+```
+
+### `docs-kit query <text>`
+
+Run retrieval directly from the CLI.
+
+```bash
+docs-kit query "How do I authenticate?"
+docs-kit query "getting started" --limit 3
+```
+
+### `docs-kit inspect`
+
+Show collection and embedding configuration details.
+
+```bash
+docs-kit inspect
+docs-kit inspect --config ./docs-kit.yaml
+```
+
+### `docs-kit doctor`
+
+Check environment variables, config presence, and Qdrant connectivity.
+
+```bash
+docs-kit doctor
+docs-kit doctor --config ./docs-kit.yaml
+```
+
+### `docs-kit list`
+
+List ingested sources with their ingestion timestamps.
+
+```bash
+docs-kit list
+docs-kit list --config ./docs-kit.yaml
+```
+
+### `docs-kit remove <source>`
+
+Remove an ingested source by URL or file path.
+
+```bash
+docs-kit remove https://docs.example.com/page
+docs-kit remove ./docs/getting-started.md
+```
+
+## MCP Tools
+
+When connected to an MCP client, docs-kit exposes:
+
+| Tool | Description |
+|------|-------------|
+| `search_docs(query, limit=5)` | Hybrid dense + BM25 retrieval |
+| `list_sources()` | List all ingested source URLs/paths |
+| `list_ingested_sources()` | List sources with ingestion timestamps |
+| `get_collection_info()` | Collection stats (exists, point count) |
+| `get_full_document(source)` | Retrieve full stored document by source |
+| `ingest_urls(urls, provider="auto")` | Ingest comma-separated URLs at runtime |
+| `remove_source(source)` | Remove a source and all its chunks |
+
+## Install Targets
+
+Local config install is supported for:
+
+- `claude-code`
+- `claude-desktop`
+- `cursor`
+- `codex`
+
+Codex aliases:
+
+- `codex-app`
+
+ChatGPT aliases are accepted for guidance only:
+
+- `chatgpt`
+- `chatgpt-desktop`
+
+`chatgpt` and `chatgpt-desktop` do not currently use a local stdio config written by this command. The installer prints guidance for the current OpenAI flow, which uses remote MCP apps/connectors in ChatGPT settings.
+
+## Configuration
+
+`docs-kit.yaml` created by `docs-kit init`:
+
+```yaml
+embedding:
+  provider: fastembed
+  model: BAAI/bge-small-en-v1.5
+
+vector_store:
+  provider: qdrant
+  local_path: .docs-kit/qdrant
+  collection_name: knowledge_base
+
+ingestion:
+  chunk_size: 800
+  chunk_overlap: 120
+  bm25_model: Qdrant/bm25
+
+mcp:
+  transport: stdio
+  host: localhost
+  port: 3001
+```
+
+## Supported Sources
+
+| Source | Strategy |
+|--------|----------|
+| GitBook sites | `/llms-full.txt` → `/llms.txt` |
+| Mintlify sites | `/llms-full.txt` → `/llms.txt` → `/sitemap.xml` |
+| Local `.md` files | Direct file read |
+| Local `.txt` files | Direct file read |
+
+Both GitBook and Mintlify support the [`llms.txt` standard](https://llmstxt.org), so in most cases the same auto strategy works for both. The Mintlify fetcher adds a `/sitemap.xml` fallback for sites where `llms.txt` is disabled.
+
+## Requirements
+
+- Python 3.11+
+- Disk space for the local embedding model download
+- Local Qdrant storage under `.docs-kit/` by default

docs_kit-0.1.1.dist-info/RECORD

@@ -0,0 +1,37 @@
+docs_kit/__init__.py,sha256=Ju6_YlS3DNr3it6mY0Z0NmHoFurexx-2k-1sF0ImR1c,843
+docs_kit/__main__.py,sha256=N9j2trAOPKXRqvBrcq59fe9UtlxvCr28bxaL9vuzO9g,76
+docs_kit/_version.py,sha256=rnObPjuBcEStqSO0S6gsdS_ot8ITOQjVj_-P1LUUYpg,22
+docs_kit/agent.py,sha256=Ee-PvlZsS_-FbrV3edSepnBRJlNF6-lts30Cx57bJdY,8270
+docs_kit/cli/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docs_kit/cli/__main__.py,sha256=gxVzgiELaOi3IMLr8am4XUzqBnSHcaCBRBH6wqyZ3-0,1071
+docs_kit/cli/commands.py,sha256=JAMUhUH9BOPmSYsxLXuWnFqHZTuFQqayEnR1RHC0MF0,19560
+docs_kit/cli/help.py,sha256=Aad7SZMvx73sQ25JnOPRu3xVInV5ZOh54sg8-Zfa698,5242
+docs_kit/connectors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docs_kit/connectors/embeddings/__init__.py,sha256=ePxSyg5IL1oJ6Y4m0p-dn_2cDCbBzt7mhzfGu1uLkHA,170
+docs_kit/connectors/embeddings/base.py,sha256=zQzAFYjZModSrjDuVzht9inixfxvFwjDsCeM3KGpR78,317
+docs_kit/connectors/embeddings/fastembed.py,sha256=LeO58DAgrtup3hPm-IuffBd4ZaEWji_hua6C-1bhUwE,1222
+docs_kit/connectors/fetchers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docs_kit/connectors/fetchers/base.py,sha256=5MgXNkRM4myTO5M9Z7ykDO4wTEoyuYh1l6_ZfZCeIQw,223
+docs_kit/connectors/fetchers/gitbook.py,sha256=WC7m-0PbLM90zPIkJSfICeZsQdZWdGvnQ-ZooEy2ruQ,224
+docs_kit/connectors/fetchers/llms_txt.py,sha256=o9zNlvogwFWwXN2DzdPWwpDehBdqZrsZFW1TsMJ48q0,3275
+docs_kit/connectors/fetchers/mintlify.py,sha256=Bj2OAySUFmDJKCrQqVyi4xE_H1an3uV1NctLqrluzoU,3565
+docs_kit/connectors/parsers/__init__.py,sha256=_zLpEQsMYt5kUZMgbFRlFDnx_hmI2COntUjlMvunqZM,164
+docs_kit/connectors/parsers/base.py,sha256=2Eb4kyPqb8kpUY8_CGpAorT-IzTbrW2ITsR8LOYtzA8,247
+docs_kit/connectors/parsers/markdown.py,sha256=h8qxmoOCO--__8OgwVOZm_bHSKl7A4s_eLoLFZ8XsJg,288
+docs_kit/connectors/parsers/text.py,sha256=vFnKyxdR_B0v-GT-Iz7uCYWB73gqqPf11_X0dfC3IQg,285
+docs_kit/connectors/vector_stores/__init__.py,sha256=HVhPoG5DOhrc1b1NrRhCG0SME3bzWEOwdvrTxECmc_M,92
+docs_kit/connectors/vector_stores/base.py,sha256=5Z6vV4DCaDJ33TfUVp8ZXY9BTPLV9MGi9hnvFZrgMgs,961
+docs_kit/connectors/vector_stores/qdrant.py,sha256=YkYmEailguY1wp3MVapuRPjq7tkIhwk7Yg3uVj1cbFA,12854
+docs_kit/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docs_kit/core/chunking.py,sha256=vatKS8FzDBbqH2e0PgnH7-57_iFXZl4a2HxGVIwX4n8,7735
+docs_kit/core/config.py,sha256=sQbFA2Ojdca8t2uXSF1VHWj7a2CZOWpP4ZOBUrfaGx4,2201
+docs_kit/core/html_utils.py,sha256=1VftGb3fn4rjUPlbAqDILROjJE5fzTOgHyn9IBa15m4,2358
+docs_kit/core/models.py,sha256=teeBraRU-uWxugO2YN6fNtPoZ44iFPL-bwjy3WLfzyw,636
+docs_kit/mcp/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+docs_kit/mcp/server.py,sha256=uFrX4heZG1NEAKyZUsHO8XM6Fks_po7OS5Qc6s48CIw,3929
+docs_kit/mcp/tools.py,sha256=9xYeZh7AJmI8VDuVFuPsuCnG8U6-DCIP0s6LVgo8j28,413
+docs_kit-0.1.1.dist-info/METADATA,sha256=tsNk4nczg8t9AUsNETRAfkR-_97EJLxxtIzm_uxrznQ,7650
+docs_kit-0.1.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+docs_kit-0.1.1.dist-info/entry_points.txt,sha256=RhCUnf0jJen8J_vEtUPLeSMoGDijS1dZMAGKj75q4H8,55
+docs_kit-0.1.1.dist-info/licenses/LICENSE,sha256=nebWVE48X1TP4rEUOkbPvawhavjs6i-XAAjLkjECi1U,1073
+docs_kit-0.1.1.dist-info/RECORD,,

docs_kit-0.1.1.dist-info/WHEEL

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

docs_kit-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+docs-kit = docs_kit.cli.__main__:cli

docs_kit-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Docs Kit Limited
+
+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.