cudaq-docs-mcp 0.1.0__tar.gz

cudaq_docs_mcp-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.12", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - run: pip install -e ".[dev]"
+      - run: pytest

cudaq_docs_mcp-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write # trusted publishing (OIDC); no tokens stored anywhere
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Test
+        run: |
+          pip install -e ".[dev]"
+          pytest
+      - name: Build
+        run: |
+          pip install build
+          python -m build
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1

cudaq_docs_mcp-0.1.0/.github/workflows/refresh-index.yml

@@ -0,0 +1,33 @@
+name: Refresh docs index
+
+on:
+  schedule:
+    - cron: "17 6 * * *"
+  workflow_dispatch: {}
+
+permissions:
+  contents: write
+
+jobs:
+  refresh:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install -e .
+      - name: Build indexes
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          cudaq-docs-mcp build --version latest --out dist-index
+          gzip -f dist-index/*.sqlite3
+      - name: Publish to rolling release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release view index-v1 >/dev/null 2>&1 || \
+            gh release create index-v1 --title "Prebuilt docs indexes" \
+              --notes "Rolling release: nightly-refreshed prebuilt indexes downloaded by the server on first run."
+          gh release upload index-v1 dist-index/*.sqlite3.gz --clobber

cudaq_docs_mcp-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+*.sqlite3
+*.sqlite3.gz
+.DS_Store
+dist-index/

cudaq_docs_mcp-0.1.0/CLAUDE.md

@@ -0,0 +1,27 @@
+# cudaq-docs-mcp
+
+MCP server serving NVIDIA CUDA-Q docs to agents, version-pinned to the installed cudaq package.
+
+## Commands
+
+```bash
+.venv/bin/pytest                                  # unit tests, offline
+.venv/bin/cudaq-docs-mcp build --limit 25         # smoke index build (network)
+.venv/bin/cudaq-docs-mcp build --version latest   # full index build
+.venv/bin/cudaq-docs-mcp info                     # cache dir, indexed versions
+.venv/bin/python scripts/smoke_mcp.py             # end-to-end MCP stdio session
+```
+
+Commands assume the repo venv at `.venv`. Where the package is installed into a different environment (a codespace, for example), drop the prefix and call `cudaq-docs-mcp`, `pytest`, and `python` from that environment directly.
+
+## Architecture
+
+Pipeline: `inventory.py` parses CUDA-Q's Sphinx `objects.inv` (crawl manifest + API symbols) → `ingest.py` fetches the site's .md mirrors and repo example files → `clean.py` strips RTD theme chrome from the pandoc-converted mirrors, rebuilds fenced code blocks, extracts heading anchors, chunks by heading → `db.py` stores pages/chunks/api/examples in one SQLite file per docs version with FTS5 (porter, bm25). `server.py` exposes five tools + two resources on MCP SDK v2's `MCPServer`; `detect.py` resolves the default docs version from installed cudaq distribution metadata; `targets.py` + `data/targets.json` is the hand-curated backend matrix; `assets.py` downloads prebuilt indexes from GitHub release assets; `cli.py` wires serve/build/info.
+
+## Constraints
+
+- Runtime deps are exactly `mcp` and `httpx`; everything else is stdlib. Do not add deps casually.
+- Tests must stay offline; network behavior is exercised through the manual commands above.
+- Version resolution order (explicit arg → installed cudaq → latest) is the product thesis; do not change it silently.
+- `data/targets.json` is curated from the docs by hand; when editing, verify names against the backends pages and update `docs_reviewed`.
+- Repo prose (README, CONTRIBUTING) follows the maintainer's style: no em dashes, "via" is banned, Oxford comma, AP-style numbers.

cudaq_docs_mcp-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# Contributing
+
+Thanks for your interest. This is a small project with a small surface: five tools, two runtime dependencies (`mcp`, `httpx`), and the standard library for everything else. Keeping it that way is a feature.
+
+## Development setup
+
+```bash
+python3 -m venv .venv          # Python 3.10 or newer
+.venv/bin/pip install -e ".[dev]"
+.venv/bin/pytest
+```
+
+Tests run offline by design. Network-dependent behavior (index building, asset download) is exercised manually:
+
+```bash
+.venv/bin/cudaq-docs-mcp build --limit 25   # small smoke build
+.venv/bin/python scripts/smoke_mcp.py       # end-to-end MCP session
+```
+
+## Sign your commits (DCO)
+
+Every commit needs a Developer Certificate of Origin sign-off, the same convention the upstream CUDA-Q repository uses:
+
+```bash
+git commit -s -m "Describe the change"
+```
+
+The `-s` flag adds a `Signed-off-by` line certifying you have the right to contribute the change under the project license.
+
+## Ground rules
+
+- Open an issue before a feature PR, so the approach gets discussed first.
+- No new runtime dependencies without discussion.
+- Docs claims follow the docs: if a target name, option, or URL changes upstream, cite the page you verified it against.

cudaq_docs_mcp-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cudaq_docs_mcp-0.1.0/NOTICE

@@ -0,0 +1,12 @@
+cudaq-docs-mcp
+Copyright 2026 Roger Wong
+
+This is a community project. It is not affiliated with, sponsored by, or
+endorsed by NVIDIA Corporation. CUDA-Q is a trademark of NVIDIA Corporation.
+
+This software serves documentation content published by the NVIDIA CUDA-Q
+project (https://github.com/NVIDIA/cuda-quantum), which is licensed under
+the Apache License, Version 2.0, and is
+Copyright (c) NVIDIA Corporation & Affiliates.
+Served results link back to the canonical documentation pages at
+https://nvidia.github.io/cuda-quantum/.

cudaq_docs_mcp-0.1.0/PKG-INFO

@@ -0,0 +1,145 @@
+Metadata-Version: 2.5
+Name: cudaq-docs-mcp
+Version: 0.1.0
+Summary: MCP server serving NVIDIA CUDA-Q documentation, API reference, and runnable examples to AI agents, version-pinned to your installed cudaq.
+Project-URL: Homepage, https://github.com/rogerawong/cudaq-docs-mcp
+Project-URL: Repository, https://github.com/rogerawong/cudaq-docs-mcp
+Project-URL: Issues, https://github.com/rogerawong/cudaq-docs-mcp/issues
+Author-email: Roger Wong <rogerawong@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: agents,cuda-q,cudaq,documentation,llm,mcp,quantum
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: mcp<3,>=2.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# cudaq-docs-mcp
+
+An MCP server that serves NVIDIA [CUDA-Q](https://github.com/NVIDIA/cuda-quantum) documentation, API reference, and runnable examples to AI agents: version-pinned to the cudaq you actually have installed.
+
+Community project, not affiliated with or endorsed by NVIDIA. CUDA-Q is a trademark of NVIDIA Corporation.
+
+## Why
+
+Quantum SDKs move faster than model training data. Ask an AI assistant to write CUDA-Q code and it answers from whatever it memorized: renamed APIs, retired target names, install steps for a version you do not run. The failure is version skew, and it lands where onboarding matters most: the first ten minutes.
+
+This server gives any MCP-capable agent the current answer instead. Documentation search, exact API symbol resolution, complete runnable examples, and a backend-selection guide, all served from an index of the docs that match your installed cudaq package. No API keys and no embeddings: SQLite full-text search with BM25 ranking, on your machine, offline once the index exists.
+
+## Quick start
+
+One-time index build (about a minute; prebuilt downloads are on the roadmap):
+
+```bash
+uvx cudaq-docs-mcp build
+```
+
+Then register the server with your client.
+
+**Claude Code**
+
+```bash
+claude mcp add cudaq-docs -- uvx cudaq-docs-mcp
+```
+
+**Claude Desktop** (`claude_desktop_config.json`), **Cursor** (`.cursor/mcp.json`), or any client that takes a JSON server map:
+
+```json
+{
+  "mcpServers": {
+    "cudaq-docs": {
+      "command": "uvx",
+      "args": ["cudaq-docs-mcp"]
+    }
+  }
+}
+```
+
+**VS Code** (`.vscode/mcp.json`):
+
+```json
+{
+  "servers": {
+    "cudaq-docs": {
+      "type": "stdio",
+      "command": "uvx",
+      "args": ["cudaq-docs-mcp"]
+    }
+  }
+}
+```
+
+Prefer pip? `pip install cudaq-docs-mcp` and use `cudaq-docs-mcp` as the command.
+
+## Tools
+
+| Tool | What it returns |
+| --- | --- |
+| `search_docs(query, version?, limit?)` | Ranked doc excerpts with breadcrumbs and canonical URLs |
+| `get_page(path, version?)` | One full documentation page as clean markdown |
+| `find_api(name, language?, version?)` | Exact Python or C++ symbol, kind, doc URL, and an excerpt |
+| `search_examples(query, language?, version?, limit?)` | Complete runnable programs from the CUDA-Q repository at the matching release |
+| `list_targets(category?)` | All 24 execution targets: simulators, hardware providers, and clouds, with selection snippets and when-to-use guidance |
+
+Resources: `cudaq://versions` (installed and indexed versions) and `cudaq://llms.txt` (CUDA-Q's own llms.txt for the served version).
+
+## Version-pinned answers
+
+Every tool resolves its docs version in this order:
+
+1. An explicit `version` argument ("0.15.0", "latest")
+2. The installed cudaq package, detected from distribution metadata (cudaq is never imported)
+3. `latest`
+
+Indexes are per-version. When a pinned index is missing the server says so in the response and serves `latest` instead, with the one command that fixes it. Skew becomes visible instead of silent.
+
+## How it works
+
+CUDA-Q publishes the raw material: a Sphinx inventory (`objects.inv`) listing every page and API symbol, markdown mirrors of each docs page, a per-version `llms.txt`, and example sources in the repository. This server builds on that groundwork:
+
+- `objects.inv` is the crawl manifest and the API symbol table: no scraping heuristics
+- each markdown mirror is cleaned of theme chrome, code blocks are rebuilt with their language, and heading anchors are preserved for deep links
+- pages are chunked by heading and indexed in SQLite FTS5 (porter stemming, BM25 ranking)
+- examples, snippets, and application sources are fetched from the GitHub release tag that matches the docs version
+
+The whole index is one SQLite file per version in your cache directory (`cudaq-docs-mcp info` shows where). A nightly workflow rebuilds the `latest` index so refreshes stay a download, not a build.
+
+## CLI
+
+```bash
+cudaq-docs-mcp            # serve MCP on stdio (what clients run)
+cudaq-docs-mcp build      # build the index for your installed cudaq, else latest
+cudaq-docs-mcp build --version 0.15.0
+cudaq-docs-mcp info       # cache location, indexed versions, detected cudaq
+```
+
+Set `CUDAQ_DOCS_MCP_AUTOBUILD=1` to build automatically on first use, and `CUDAQ_DOCS_MCP_CACHE` to relocate the cache.
+
+## Roadmap
+
+- Prebuilt indexes as release assets, so first run is a download instead of a build
+- An eval set of real developer questions, with published retrieval scores
+- CUDA-QX library docs
+
+## Contributing
+
+Issues and PRs are welcome. Commits need a DCO sign-off (`git commit -s`); see [CONTRIBUTING.md](CONTRIBUTING.md). Built in the open with Claude Code.
+
+## License
+
+[Apache-2.0](LICENSE). Documentation content belongs to NVIDIA Corporation & Affiliates, originates from the Apache-2.0 licensed [NVIDIA/cuda-quantum](https://github.com/NVIDIA/cuda-quantum) repository, and every served result links back to the canonical page. See [NOTICE](NOTICE).

cudaq_docs_mcp-0.1.0/README.md

@@ -0,0 +1,114 @@
+# cudaq-docs-mcp
+
+An MCP server that serves NVIDIA [CUDA-Q](https://github.com/NVIDIA/cuda-quantum) documentation, API reference, and runnable examples to AI agents: version-pinned to the cudaq you actually have installed.
+
+Community project, not affiliated with or endorsed by NVIDIA. CUDA-Q is a trademark of NVIDIA Corporation.
+
+## Why
+
+Quantum SDKs move faster than model training data. Ask an AI assistant to write CUDA-Q code and it answers from whatever it memorized: renamed APIs, retired target names, install steps for a version you do not run. The failure is version skew, and it lands where onboarding matters most: the first ten minutes.
+
+This server gives any MCP-capable agent the current answer instead. Documentation search, exact API symbol resolution, complete runnable examples, and a backend-selection guide, all served from an index of the docs that match your installed cudaq package. No API keys and no embeddings: SQLite full-text search with BM25 ranking, on your machine, offline once the index exists.
+
+## Quick start
+
+One-time index build (about a minute; prebuilt downloads are on the roadmap):
+
+```bash
+uvx cudaq-docs-mcp build
+```
+
+Then register the server with your client.
+
+**Claude Code**
+
+```bash
+claude mcp add cudaq-docs -- uvx cudaq-docs-mcp
+```
+
+**Claude Desktop** (`claude_desktop_config.json`), **Cursor** (`.cursor/mcp.json`), or any client that takes a JSON server map:
+
+```json
+{
+  "mcpServers": {
+    "cudaq-docs": {
+      "command": "uvx",
+      "args": ["cudaq-docs-mcp"]
+    }
+  }
+}
+```
+
+**VS Code** (`.vscode/mcp.json`):
+
+```json
+{
+  "servers": {
+    "cudaq-docs": {
+      "type": "stdio",
+      "command": "uvx",
+      "args": ["cudaq-docs-mcp"]
+    }
+  }
+}
+```
+
+Prefer pip? `pip install cudaq-docs-mcp` and use `cudaq-docs-mcp` as the command.
+
+## Tools
+
+| Tool | What it returns |
+| --- | --- |
+| `search_docs(query, version?, limit?)` | Ranked doc excerpts with breadcrumbs and canonical URLs |
+| `get_page(path, version?)` | One full documentation page as clean markdown |
+| `find_api(name, language?, version?)` | Exact Python or C++ symbol, kind, doc URL, and an excerpt |
+| `search_examples(query, language?, version?, limit?)` | Complete runnable programs from the CUDA-Q repository at the matching release |
+| `list_targets(category?)` | All 24 execution targets: simulators, hardware providers, and clouds, with selection snippets and when-to-use guidance |
+
+Resources: `cudaq://versions` (installed and indexed versions) and `cudaq://llms.txt` (CUDA-Q's own llms.txt for the served version).
+
+## Version-pinned answers
+
+Every tool resolves its docs version in this order:
+
+1. An explicit `version` argument ("0.15.0", "latest")
+2. The installed cudaq package, detected from distribution metadata (cudaq is never imported)
+3. `latest`
+
+Indexes are per-version. When a pinned index is missing the server says so in the response and serves `latest` instead, with the one command that fixes it. Skew becomes visible instead of silent.
+
+## How it works
+
+CUDA-Q publishes the raw material: a Sphinx inventory (`objects.inv`) listing every page and API symbol, markdown mirrors of each docs page, a per-version `llms.txt`, and example sources in the repository. This server builds on that groundwork:
+
+- `objects.inv` is the crawl manifest and the API symbol table: no scraping heuristics
+- each markdown mirror is cleaned of theme chrome, code blocks are rebuilt with their language, and heading anchors are preserved for deep links
+- pages are chunked by heading and indexed in SQLite FTS5 (porter stemming, BM25 ranking)
+- examples, snippets, and application sources are fetched from the GitHub release tag that matches the docs version
+
+The whole index is one SQLite file per version in your cache directory (`cudaq-docs-mcp info` shows where). A nightly workflow rebuilds the `latest` index so refreshes stay a download, not a build.
+
+## CLI
+
+```bash
+cudaq-docs-mcp            # serve MCP on stdio (what clients run)
+cudaq-docs-mcp build      # build the index for your installed cudaq, else latest
+cudaq-docs-mcp build --version 0.15.0
+cudaq-docs-mcp info       # cache location, indexed versions, detected cudaq
+```
+
+Set `CUDAQ_DOCS_MCP_AUTOBUILD=1` to build automatically on first use, and `CUDAQ_DOCS_MCP_CACHE` to relocate the cache.
+
+## Roadmap
+
+- Prebuilt indexes as release assets, so first run is a download instead of a build
+- An eval set of real developer questions, with published retrieval scores
+- CUDA-QX library docs
+
+## Contributing
+
+Issues and PRs are welcome. Commits need a DCO sign-off (`git commit -s`); see [CONTRIBUTING.md](CONTRIBUTING.md). Built in the open with Claude Code.
+
+## License
+
+[Apache-2.0](LICENSE). Documentation content belongs to NVIDIA Corporation & Affiliates, originates from the Apache-2.0 licensed [NVIDIA/cuda-quantum](https://github.com/NVIDIA/cuda-quantum) repository, and every served result links back to the canonical page. See [NOTICE](NOTICE).