Using documentation effectively

This guide explains how anyone — developers, product, support, or integration — can use the API documentation, focusing on:

How to use the Test feature directly in the documentation

Integrating the documentation with AI-assisted IDEs via MCP Server (Model Context Protocol)

1. ✨ Using "Test" in the API Documentation

The documentation includes an interactive feature called "Test," which allows you to test the endpoints directly from the documentation without needing to open Postman, Insomnia, or a terminal.

1.1. How to Use

Open the page of an endpoint

Click the Test button

Fill in the fields as needed:

Query Params

Body

Headers

Auth

Click Send and see:

Request sent

Response body

Headers

Status code

1.2. Important Tips

Make sure to set up authentication first (Username: DNS, Password: Token).

Use valid values to avoid errors.

Great for validating the actual behavior of endpoints.

2. ⚙️ Integration with AI via MCP Server in the Documentation

Allow IDEs like Cursor to automatically access the API documentation.

The documentation offers an MCP (Model Context Protocol) server that allows tools like Cursor and VS Code + MCP extensions to directly access:

The API specification

The published documentation

Schemas

Endpoints

Components

Authentication

Examples

In other words: the AI within the IDE can read and use your entire API to automatically generate code.

2.1. What Does the MCP Server Allow You to Do?

With Apidog's MCP, you can:

Generate ready-to-use code based on any endpoint

Automatically update DTOs

Create services, controllers, routes, and API calls

Insert comments based on the documentation

Search for endpoints by description

Validate requests

Create tests based on the schema

And much more — all without manually copying and pasting documentation!

The AI now has local memory of your API.

2.2. How Does It Work?

The MCP Server:

Downloads and caches all the API documentation locally

The AI in your IDE accesses this data natively

You just ask:

"Generate the service for the endpoint /appointments/schedule/detail using the API schema."

And Cursor / VSCode generates EVERYTHING automatically.

2.3. One-Click Configuration

You can configure it with the JSON below.

This example uses site ID 759651:

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

📌 Requirements:

Node.js >= 18

IDE with MCP support:

Cursor

VS Code (via plugins like Cline or AI MCP)

2.4. Manual Configuration (if you want to customize)

You can adjust:

Ports

Cache

Access tokens (for private docs)

Data source (OpenAPI / Swagger / online .txt docs)

Example

Or, if it's an On-Premise environment:

2.5. What to Do After Pasting the JSON?

In Cursor or VSCode:

Open Settings → MCP Servers

Paste the JSON above

Restart the IDE

The AI will start responding based on the actual documentation:

Example of a useful prompt:

"Use the MCP to fetch the Sales schema and generate a TypeScript class with complete typing."

2.6. Official Documentation for MCP Server

Apidog, the provider of the EVO API documentation hosting, maintains complete documentation on:

How MCP works

How to connect projects

How to use published documentation as a source

How to connect Swagger / OpenAPI

Read full reference.

Using documentation effectively

1. ✨ Using "Test" in the API Documentation#

1.1. How to Use#

1.2. Important Tips#

2. ⚙️ Integration with AI via MCP Server in the Documentation#

2.1. What Does the MCP Server Allow You to Do?#

2.2. How Does It Work?#

2.3. One-Click Configuration#

📌 Requirements:#

2.4. Manual Configuration (if you want to customize)#

Example#

2.5. What to Do After Pasting the JSON?#

2.6. Official Documentation for MCP Server#