Add GitBook MCP server documentation (#4080)

strickvl · web-flow · commit 07c82ef3ce75 · 2025-10-23T14:12:20.000+02:00
* Add GitBook MCP server documentation Adds documentation for ZenML's built-in GitBook MCP server that enables AI code agents (Claude Code, Cursor, etc.) to query ZenML documentation in real-time while coding. Changes: - docs/book/reference/llms-txt.md: Added comprehensive MCP server section with setup instructions for Claude Code and Cursor, positioned as the recommended approach alongside existing llms.txt documentation - docs/book/toc.md: Updated page title to "MCP Docs & llms.txt" for better discoverability - AGENTS.md: Added "Documentation Access via MCP" subsection in Development Workflow - CLAUDE.md: Added "Use ZenML Docs via MCP" section with CLI setup The MCP server endpoint (https://docs.zenml.io/~gitbook/mcp) provides live documentation queries, reducing hallucinations and improving feature discovery for AI coding assistants. * Add MCP server quick-win to documentation Adds a new quick-win entry (#14) showing developers how to connect AI coding assistants to live ZenML docs via the GitBook MCP server. This complements the MCP documentation added in the main PR by providing a quick-start guide in the productivity-focused quick-wins page. The entry includes setup instructions for Claude Code and Cursor, emphasizes the 5-minute setup time, and follows the established quick-wins format with Why/Setup/Features/Practices sections.
diff --git a/AGENTS.md b/AGENTS.md
@@ -62,6 +62,9 @@ Use filesystem navigation tools to explore the codebase structure as needed.
   - It resolves dependencies more quickly and reliably than pip
   - It can resolve dependency conflicts that pip sometimes struggles with or takes a long time to resolve
 
+### Documentation Access via MCP
+ZenML documentation is available via a built-in GitBook MCP server: https://docs.zenml.io/~gitbook/mcp. IDE agents like Cursor and Claude Code can add this as an HTTP MCP server named 'ZenML Docs' to answer questions directly from the docs while you code. This enables live, source-of-truth lookups with fewer hallucinations and faster feature discovery. Note that the MCP server indexes the latest released docs, not the develop branch. For full setup details and examples, see docs/book/reference/llms-txt.md.
+
 ### Environment Variables
 - Several environment variables are useful during ZenML development:
   - `ZENML_DEBUG=true`: Enables verbose debug logging
diff --git a/CLAUDE.md b/CLAUDE.md
@@ -12,6 +12,16 @@ This document provides guidance for Claude Code when working with the ZenML code
 
 Use filesystem navigation tools to explore the codebase structure as needed.
 
+## Use ZenML Docs via MCP
+Claude Code can query ZenML documentation via the built-in GitBook MCP server: https://docs.zenml.io/~gitbook/mcp. This enables real-time, source-of-truth lookups from the docs while you code, reducing hallucinations and speeding up feature discovery.
+
+Quick setup (CLI):
+```bash
+claude mcp add zenmldocs --transport http https://docs.zenml.io/~gitbook/mcp
+```
+
+Note: The MCP server indexes the latest released docs, not the develop branch. For full setup details and editor alternatives, see docs/book/reference/llms-txt.md.
+
 ## Code Style & Quality Standards
 
 ### Formatting and Linting
diff --git a/docs/book/reference/llms-txt.md b/docs/book/reference/llms-txt.md
@@ -1,6 +1,6 @@
 ---
 icon: robot
-description: The llms.txt file(s) for ZenML
+description: Access ZenML documentation via MCP server or llms.txt
 ---
 
 ## About llms.txt
@@ -28,6 +28,48 @@ When working with LLMs (like ChatGPT, Claude, or others), you can use this file
 - While prompting, instruct the LLM to only provide answers based on information contained in the file to avoid hallucinations
 - For best results, use models with sufficient context window to process the entire file
 
+## Use llms-full.txt for complete documentation context
+
+The llms-full.txt file contains the entire ZenML documentation in a single, concatenated markdown file optimized for LLMs. Use it when you want to load all docs as context at once (for example, a one-shot grounding pass) rather than querying individual pages. Access it here: https://docs.zenml.io/llms-full.txt. For interactive, selective queries from your IDE, the built-in MCP server is still the recommended option.
+
+## Use the built-in GitBook MCP server (recommended)
+
+ZenML docs are also exposed through a native GitBook MCP server that IDE agents can query in real time.
+
+- Endpoint: https://docs.zenml.io/~gitbook/mcp
+
+### Quick setup
+
+#### Claude Code (VS Code)
+Run the following command in your terminal to add the server:
+```bash
+claude mcp add zenmldocs --transport http https://docs.zenml.io/~gitbook/mcp
+```
+
+#### Cursor
+Add the server via Cursor's JSON settings (Settings → search "MCP" → Configure via JSON):
+```json
+{
+  "mcpServers": {
+    "zenmldocs": {
+      "transport": {
+        "type": "http",
+        "url": "https://docs.zenml.io/~gitbook/mcp"
+      }
+    }
+  }
+}
+```
+
+### Why use it
+- Live doc queries directly from your IDE agent
+- Syntax-aware, source-of-truth answers with fewer hallucinations
+- Faster feature discovery across guides, APIs, and examples
+
+The MCP server indexes the latest released documentation, not the develop branch.
+
+Prefer the native GitBook MCP server above for the best experience; if you prefer working directly with llms.txt or need alternative workflows, the following tools are helpful:
+
 To use the llms.txt file in partnership with an MCP client, you can use the
 following tools:
 
diff --git a/docs/book/toc.md b/docs/book/toc.md
@@ -63,7 +63,7 @@
 
 * [Community & content](reference/community-and-content.md)
 * [Environment Variables](reference/environment-variables.md)
-* [llms.txt](reference/llms-txt.md)
+* [MCP Docs & llms.txt](reference/llms-txt.md)
 * [FAQ](reference/faq.md)
 * [Global settings](reference/global-settings.md)
 * [Legacy docs](reference/legacy-docs.md)
diff --git a/docs/book/user-guide/best-practices/quick-wins.md b/docs/book/user-guide/best-practices/quick-wins.md
@@ -24,6 +24,7 @@ micro-setup (under 5 minutes) and any tips or gotchas to anticipate.
 | [HTML reports](#id-11-simple-html-reports) | Create rich visualizations effortlessly | Beautiful stakeholder-friendly outputs |
 | [Model Control Plane](#id-12-register-models-in-the-model-control-plane) | Track models and their lifecycle | Central hub for model lineage and governance |
 | [Parent Docker images](#id-13-create-a-parent-docker-image-for-faster-builds) | Pre-configure your dependencies in a base image | Faster builds and consistent environments |
+| [ZenML docs via MCP](#id-14-enable-ide-ai-zenml-docs-via-mcp-server) | Connect your IDE assistant to live ZenML docs | Faster, grounded answers and doc lookups while coding |
 
 
 ## 1 Log rich metadata on every run
@@ -804,3 +805,52 @@ settings:
 For projects with heavy dependencies like deep learning frameworks, this approach can cut build times by 80-90%, turning a 5-minute build into a 30-second one. This is especially valuable in cloud environments where you pay for build time.
 
 Learn more: [Containerization](https://docs.zenml.io/concepts/containerization)
+
+## 14 Enable IDE AI: ZenML docs via MCP server
+
+**Why** -- wire your IDE AI assistant into the live ZenML docs in under 5 minutes. Get grounded answers, code snippets, and API lookups without context switching or hallucinations—perfect if you already use Claude Code or Cursor.
+
+{% hint style="info" %}
+The MCP server works with any MCP-compatible client. Below we demonstrate popular examples using Claude Code (VS Code) and Cursor. The server indexes the latest released documentation, not the develop branch.
+{% endhint %}
+
+**Setup**
+
+### Claude Code (VS Code)
+```bash
+claude mcp add zenmldocs --transport http https://docs.zenml.io/~gitbook/mcp
+```
+
+### Cursor (JSON settings)
+```json
+{
+  "mcpServers": {
+    "zenmldocs": {
+      "transport": {
+        "type": "http",
+        "url": "https://docs.zenml.io/~gitbook/mcp"
+      }
+    }
+  }
+}
+```
+
+**Try it**
+```
+Using the zenmldocs MCP server, show me how to register an MLflow experiment tracker in ZenML and add it to my stack. Cite the source page.
+```
+
+**Key features**
+- **Live answers** from ZenML docs directly in your IDE assistant
+- **Fewer hallucinations** thanks to source-of-truth grounding and citations
+- **IDE-native experience** — no code changes required in your project
+- **Great for API lookups** and "how do I" questions while coding
+
+**Best practices**
+- Prefix prompts with: "Use the zenmldocs MCP server …" and ask for citations
+- Remember: it indexes the latest released docs, not develop; for full offline context use `llms-full.txt`, for selective interactive queries prefer MCP
+- Keep the server name consistent (e.g., `zenmldocs`) across machines/projects
+- If your IDE supports tool selection, explicitly enable/select the `zenmldocs` MCP tool
+- For bleeding-edge features on develop, consult the repo or develop docs directly
+
+Learn more: [Access ZenML documentation via llms.txt and MCP](https://docs.zenml.io/reference/llms-txt)
