LLM-friendly Features

Apidog Version Should Be 2.7.2 or Later.

Navigate to: Share Docs -> Publish Docs Sites -> LLM-friendly Features to enable the following options.

Enable "MCP"

If enabled, a "MCP" button will be displayed in the documentation, guiding end users how to use the current API documentation in MCP-enabled IDEs, such as Cursor, Cline, etc., to assist the Agentic AI in writing code. For more details, please read: Conntect Online API Documentation Published by Apidog to AI via Apidog MCP Server.

Enable "Copy Page"

If enabled, a "Copy page" button will be displayed in the documentation. Users can copy web page as Markdown for LLMs.

Enable LLMs.txt

If enabled, a llms.txt Markdown file will be generated in the root directory of your documentation site. This file contains links to every Markdown page on your site, along with concise descriptions. For example:

How can AI assistants use LLMs.txt?

There are two common methods for using LLMs.txt and the related Markdown files:

1. Share Markdown links with AI assistants that can access URLs

Each online documentation page published via Apidog has a Markdown version. You can:

Add ".md" to any doc URL (e.g., https://example.apifox.cn/page.md)

Or click "View as Markdown" in the online documentation

AI assistants with Web Browsing capabilities can use these ".md" URLs to retrieve concise documentation.

For example, in Cursor, you can ask "Understand this info: @https://zojphlasi1.apidog.io/find-pet-by-id-12888653e0.md and help me generate a TypeScript client".

The prompt format must follow the specific rules of the AI tool being used. For instance, in Cursor, URLs must begin with @ to be recognized as context.

2. Copy Markdown content for AI assistants that can't access URLs

If the AI assistant cannot access content via URL, you need to copy and paste the Markdown content manually.

Click the "Copy Page" button in the online documentation to get the current page content in Markdown format, then paste it into your conversation with the AI assistant.

Example prompt:
"Based on this endpoint definition, please generate a TypeScript client: (paste the copied content here)."

FAQs

Does enabling LLMs.txt affect documentation security?

No. LLMs.txt only includes content that has already been publicly published. It simply converts HTML to Markdown and does not expose private or unpublished documentations. If access control (password, IP allowlist, email allowlist, etc.) is set up, users must still pass authentication to access LLMs.txt and the Markdown files.

Can I use LLMs.txt if my docs are protected by password, IP, or email allowlist?？

Why don't I see the button `Copy Page` in Apidog App?

I’ve enabled 'Web Search' feature for my AI assistant. Why can’t it read the web page content via URL?

What should I do if the AI assistant fails to access the Markdown file via URL?

Do I need to do anything else after enabling LLMs.txt?

How can I verify that LLMs.txt is working properly?

LLM-friendly Features

Enable "MCP"#

Enable "Copy Page"#

Enable LLMs.txt#

How can AI assistants use LLMs.txt?#

FAQs#

Enable "MCP"

Enable "Copy Page"

Enable LLMs.txt

How can AI assistants use LLMs.txt?

FAQs