diff --git a/src/_help/documentation-experience/ask-ai-markdown-rendering.md b/src/_help/documentation-experience/ask-ai-markdown-rendering.md index bc51feb8..e6ab5977 100644 --- a/src/_help/documentation-experience/ask-ai-markdown-rendering.md +++ b/src/_help/documentation-experience/ask-ai-markdown-rendering.md @@ -5,14 +5,68 @@ title: Ask AI & Markdown rendering - TOC {:toc} -Markdown version of your API docs and hubs, optimized for AI tools, are offered next to your standard docs. These Markdown versions, by providing narrowed-down contexts, reduce token cost and hallucinations, therefore returning more relevant results. +Enable LLMs and AI agents to access your doc portal using Bump.sh [AI features](/help/documentation-experience/ask-ai-markdown-rendering/). When enabled, your documentation are made accessible through an MCP server and offered as Markdown pages, so AI assistants and agents can search, navigate, and read your doc portal. -## Ask AI -Many API consumers now rely on AI tools to help them quickly discover API capabilities. The `Ask AI` dropdown menu offers documentation users easy access to ChatGPT and Claude, alongside a one-click Markdown access. +## Enable Ask AI + +Ask AI can be enabled or disabled from your documentation or hub settings, under the "Ask AI" section. + +![Ask AI settings, a toggle to make a doc portal available to AI tools](/docs/images/help/ask-ai-settings.png) + +Enabling these capabilities: +- Exposes an MCP server for the API doc/hub, available by adding `/mcp` at the end of the URL. +- Makes every page available as Markdown (by appending `.md` to any URL). +- Generates a **[llms.txt](/help/publish-documentation/seo-geo/#llmstxt-for-llm-crawlers)** file at the root of your documentation. + +## Ask AI dropdown + +Many API consumers now rely on AI tools to help them quickly discover API capabilities. The Ask AI dropdown menu offers documentation users a way to either add the doc MCP server, open the current page in Claude/ChatGPT, or access the Markdown version. ![ask-ai-dropdown.png](/docs/images/help/ask-ai-dropdown.png) +Available options: + +| Option | Description | +|---|---| +| **Add to Cursor** | Adds the doc/hub MCP server to Cursor in one click. | +| **Add to VS Code** | Adds the doc/hub MCP server to VS Code in one click. | +| **Add to other AI tools (MCP)** | Shows the MCP server URL and a ready-to-use `mcp.json` snippet. | +| **Open in ChatGPT** | Opens the current page in ChatGPT with the right Markdown page pre-linked. | +| **Open in Claude** | Opens the current page in ChatGPT with the right Markdown page pre-linked. | +| **View as Markdown** | Opens the Markdown version of the current page. | +| **Copy as Markdown** | Copies the Markdown content of the current page to the clipboard. | + +## MCP server + +When Ask AI is enabled, Bump.sh exposes an MCP server for your doc/hub. AI agents can use it to search, navigate, and read your API documentation programmatically, without having to scrape HTML pages or parse raw OpenAPI files. As search results are computed on our side, based on your documentation, it reduces the risk of AI hallucinations: the AI should just output information provided by the MCP server. + +The MCP server URL is shown in your doc/hub settings and accessible from the Ask AI dropdown. + +> Docs MCP servers are currently only available for public API docs/hubs. Support for private doc portals coming soon. +{: .info} + +### Add the MCP server to your AI tool + +The "Ask AI" dropdown in your API docs/hubs provides a one-click setup for Cursor and VS Code. The MCP server URL is available by clicking the "Add to other AI tools (MCP)" section. + +If it's your first time adding an MCP server in your AI tool, check our [tutorial covering major AI tools](/help/mcp-servers/use-mcp-server). + +### Available tools + +The MCP server exposes three tools: + +| Tool | Description | +|---|---| +| **search** | Searches across all documentation pages by keyword. Supports filtering by type (operation, schema, topic, authentication, webhook, etc.). Returns up to 20 matching results with their URL, title, type, and a text excerpt. | +| **get_pages** | Retrieves the full content of one or more pages by their URLs. Accepts up to 10 URLs per request. Use this when you already know which pages you need, for example from `search` or `list_pages` results. | +| **list_pages** | Lists all child pages under a given URL in the documentation hierarchy. Returns each page's URL, title, type, and description. Useful as a starting point to explore what documentation is available before fetching specific pages. | + +A typical request from an API user to the LLM, like "How do I do that using this API" will trigger the **search** tool to get the right API/operation, and then a **get_pages** to get the actual content. + ## Markdown rendering + +Every page of your documentation is available as Markdown by appending `.md` to its URL. Markdown versions strip the surrounding UI, providing leaner context for AI tools and reducing token costs. + To access the Markdown version of a documentation, add `.md` at the end of the URL (or `/source.md` if you have a custom domain, when the URL is the root of your documentation). [On a documentation root](https://developers.bump.sh/source.md) *(example truncated for visibility purposes).* diff --git a/src/_help/documentation-experience/index.md b/src/_help/documentation-experience/index.md index 7eadae10..1f01a804 100644 --- a/src/_help/documentation-experience/index.md +++ b/src/_help/documentation-experience/index.md @@ -11,4 +11,6 @@ The [API Explorer](/help/documentation-experience/api-explorer/) allows you to t To help you enrich your API documentation, Bump.sh supports [Markdown](/help/documentation-experience/markdown-support/), offering better formatting and the ability to add your own images. -We also offer [topics](/help/documentation-experience/topics/): an exclusive custom property that allows you to add extra information to your documentation. \ No newline at end of file +We also offer [topics](/help/documentation-experience/topics/): an exclusive custom property that allows you to add extra information to your documentation. + +Enable LLMs and AI agents to access your doc portal using Bump.sh [AI features](/help/documentation-experience/ask-ai-markdown-rendering/). When enabled, your documentation are made accessible through an MCP server and offered as Markdown pages, so AI assistants and agents can search, navigate, and read your doc portal. \ No newline at end of file diff --git a/src/docs/images/help/ask-ai-dropdown.png b/src/docs/images/help/ask-ai-dropdown.png index da6db311..4bb8cb6b 100644 Binary files a/src/docs/images/help/ask-ai-dropdown.png and b/src/docs/images/help/ask-ai-dropdown.png differ diff --git a/src/docs/images/help/ask-ai-settings.png b/src/docs/images/help/ask-ai-settings.png new file mode 100644 index 00000000..e04283b3 Binary files /dev/null and b/src/docs/images/help/ask-ai-settings.png differ