Connect Published Documentation to AI

Apidog MCP Server enables AI to connect and utilize online API documentation published by Apidog, allowing external developers and AI assistants to access public API documentation seamlessly.

This configuration method only supports publicly published online documentation. It does not support documentation with password or allowlist settings.

For non-public documentation, use the Apidog Project data source instead.

Enabling MCP for Online Documentation

Apidog version 2.7.2 or later is required.

Enable MCP Service

Navigate to your Apidog project

Go to Publish Docs → Publish Docs Sites → LLM-friendly Features

Enable the MCP service

Enabling MCP service for online documentation

Get Configuration File

After enabling MCP, the MCP button will appear when accessing your online documentation.

Click the button to display the configuration guide and MCP config file, which automatically includes your documentation's site-id. Copy this configuration for IDE integration.

Configuring MCP Client

Prerequisites

Before configuring the MCP client, ensure you have:

Node.js (version 18 or later, preferably the latest LTS version)

An MCP-compatible IDE:

Cursor

VS Code + Cline plugin

Other MCP-supported editors

Copied MCP JSON configuration from Apidog online documentation

Configuring MCP in Cursor

Open MCP Settings

Open Cursor editor

Click the settings icon (top-right)

Select MCP from the left menu

Click + Add new global MCP server

Add Configuration

Paste the MCP JSON configuration copied from online documentation into the opened mcp.json file:

macOS / Linux

Windows

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

Verify Configuration

Test the connection by asking the AI (in Agent mode):

Please fetch API documentation via MCP and tell me how many endpoints exist in the project.

If the AI returns correct API information, the connection is successful.

Important Notes

Working with Multiple Documentation Sites

To work with different API documentation sites, add multiple MCP Server configurations to the configuration file. Each documentation site should have its own unique <site-id>.

On-Premise Deployment

For on-premise deployments, include your server's API address in the IDE MCP configuration:

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "npx",
      "args": [
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456",
        "--apidog-api-base-url=<your-server-url>"
      ]
    }
  }
}

Replace <your-server-url> with your on-premise server's API address (starting with http:// or https://). Ensure network access to www.npmjs.com.

Other Data Sources

Connect API Specification within Apidog Project to AI

Connect OpenAPI Files to AI

FAQs

Windows Configuration Issues

If standard configuration fails on Windows, use this alternative:

{
  "mcpServers": {
    "apidog-site-123456": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=123456"
      ]
    }
  }
}

Node.js Version Problems

How to let AI read the latest data from updated API documentation?

Connect Published Documentation to AI

Enabling MCP for Online Documentation#

Configuring MCP Client#

Prerequisites#

Configuring MCP in Cursor#

Important Notes#

Working with Multiple Documentation Sites#

On-Premise Deployment#

Other Data Sources#

FAQs#

Enabling MCP for Online Documentation

Configuring MCP Client

Prerequisites

Configuring MCP in Cursor

Important Notes

Working with Multiple Documentation Sites

On-Premise Deployment

Other Data Sources

FAQs