LLM-Friendly Features

Make your API documentation AI-ready with LLM-friendly features that enable seamless integration with AI assistants and development tools. These features help developers leverage AI tools like Cursor, Cline, and other LLM-powered IDEs to accelerate API integration and code generation.

Version Requirement

Apidog version must be ≥ 2.7.2 to access these features.

To enable these features: Navigate to Publish Docs → Publish Docs Sites → LLM-friendly Features.

Enable MCP (Model Context Protocol)

When enabled, an "MCP" button appears in your documentation, guiding users on how to connect your API documentation to MCP-enabled IDEs such as Cursor and Cline. This allows Agentic AI to assist with code generation directly from your API documentation.

Learn More

For detailed setup instructions, read: Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server.

Enable Copy Page

When enabled, a "Copy page" button appears in your documentation, allowing users to copy the current page as Markdown format—perfect for pasting into LLM conversations.

Enable llms.txt

When enabled, a llms.txt Markdown file is automatically generated in the root directory of your documentation site. This file contains links to every Markdown page with concise descriptions, making it easy for AI assistants to discover and navigate your documentation.

Example:

How AI Assistants Use llms.txt

There are two common methods for using llms.txt and 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.apidog.io/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".

Prompt Format

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 documentation. If access control (password, IP allowlist, email allowlist, etc.) is configured, users must still pass authentication to access llms.txt and 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 (Model Context Protocol)#

Enable Copy Page#

Enable llms.txt#

How AI Assistants Use llms.txt#

FAQs#

Enable MCP (Model Context Protocol)

Enable Copy Page

Enable llms.txt

How AI Assistants Use llms.txt

FAQs