Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Send requests
  • Apidog Learning Center
  • Getting Started
    • Introduction to Apidog
    • Basic Concepts in Apidog
    • Navigating Apidog
    • Quick Start
      • Overview
      • Creating an Endpoint
      • Making a Request
      • Adding an Assertion
      • Creating Test Scenarios
      • Sharing API Documentation
      • Explore More
    • Migration to Apidog
      • Overview
      • Manual Import
      • Scheduled Import (Bind Data Sources)
      • Import Options
      • Export Data
      • Import From
        • Import from Postman
        • Import OpenAPI Spec
        • Import cURL
        • Import Markdowns
        • Import from Insomnia
        • Import from apiDoc
        • Import .har File
        • Import WSDL
  • Design APIs
    • Overview
    • Create a New API Project
    • Endpoint Basics
    • APl Design Guidelines
    • Module
    • Configure Multiple Request Body Examples
    • Components
    • Common Fields
    • Global Parameters
    • Endpoint Change History
    • Comments
    • Batch Endpoint Management
    • Custom Protocol API
    • Schemas
      • Overview
      • Create a New Schema
      • Build a Schema
      • Generate Schemas from JSON Etc
      • oneOf, allOf, anyOf
      • Using Discriminator
    • Security Schemes
      • Overview
      • Create a Security Scheme
      • Use the Security Scheme
      • Security Scheme in Online Documentation
    • Advanced Features
      • Custom Endpoint Fields
      • Associated Test Scenarios
      • Endpoint Status
      • Appearance of Parameter Lists
      • Endpoint Unique Identification
  • Develop and Debug APIs
    • Overview
    • Generating Requests
    • Sending Requests
    • Debugging Cases
    • Test Cases
    • Dynamic Values
    • Validating Responses
    • Design-First vs Request-First
    • Generating Code
    • Environments & Variables
      • Overview
      • Environment Management
      • Using Variables
    • Vault Secrets
      • Overview
      • HashiCorp Vault
      • Azure Key Vault
      • AWS Secrets Manager
    • Pre and Post Processors
      • Assertion
      • Extract Variable
      • Wait
      • Overview
      • Using Scripts
        • Overview
        • Pre Processor Scripts
        • Post Processor Scripts
        • Public Scripts
        • Postman Scripts Reference
        • Calling Other Programming Languages
        • Using JS Libraries
        • Visualizing Responses
        • Script Examples
          • Assertion Scripts
          • Using Variables
          • Modifying Requests
          • Other Examples
      • Database Operations
        • Overview
        • MySQL
        • MongoDB
        • Redis
        • Oracle Client
    • Dynamic Values Modules
  • Mock API Data
    • Overview
    • Smart Mock
    • Custom Mock
    • Mock Priority Sequence
    • Mock Scripts
    • Cloud Mock
    • Self-Hosted Runner Mock
    • Mock Language (Locales)
  • API Testing
    • Overview
    • Test Scenarios
      • Create a Test Scenario
      • Pass Data Between Requests
      • Flow Control Conditions
      • Sync Data from Endpoints and Endpoint Cases
      • Import Endpoints and Endpoint Cases from Other Projects
      • Export Test Scenarios
    • Run Test Scenarios
      • Run a Test Scenario
      • Run Test Scenarios in Batch
      • Manage Runtime Environment of APIs from Other Projects
      • Data-Driven Testing
      • Scheduled Tasks
    • Test Suite
      • Overview
      • Create A Test Suite
      • Orchestrate Test Suite
      • Run Test Suites Locally
      • Run Test Suites Via CLI
      • Scheduled tasks
    • Test Reports
      • Test Reports
    • Test APIs
      • Integration Testing
      • Performance Testing
      • End-to-End Testing
      • Regression Testing
      • Contract Testing
    • Apidog CLI
      • Overview
      • Installing and Running Apidog CLI
      • Apidog CLI Options
    • CI CD
      • Overview
      • Integrate with Gitlab
      • Integrate with Jenkins
      • Trigger Test by Git Commit
      • Integrate with Github Actions
  • Publish API Docs
    • Overview
    • API Technologies Supported
    • Quick Share
    • Viewing API Documentation
    • Markdown Documentation
    • Publishing Documentation Sites
    • Custom Layouts
    • Custom CSS, JavaScript, HTML
    • Custom Domain
    • LLM-Friendly Features
    • SEO Settings
    • Advanced Settings
      • Documentation Search
      • CORS Proxy
      • Integrating Google Analytics with Doc Sites
      • Folder Tree Settings
      • Visibility Settings
      • Embedding Values in Document URLs
    • API Versions
      • Overview
      • Creating API Versions
      • Publishing API Versions
      • Sharing Endpoints with API Versions
  • Send requests
    • Overview
    • SSE debugging
    • MCP Client
    • Socket.IO
    • WebSocket
    • Webhook
    • SOAP or WebService
    • GraphQL
    • gRPC
    • Use request proxy agents for debugging
    • Create requests
      • Request History
      • Request basics
      • Parameters and body
      • Request headers
      • Request settings
      • Debug requests
      • Save the request as an endpoint
      • HTTP2
    • Response and cookies
      • Overview
      • API response in Apidog
      • Create and send cookies
    • Authentication and authorization
      • Overview
      • CA and client certificates
      • Authorization types supported by Apidog
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
  • Branches
    • Overview
    • Create a new sprint branch
    • Test APIs in a branch
    • Design API in a branch
    • Merge sprint branches
    • Manage sprint branches
  • AI Features
    • Overview
    • Enable AI features
    • Generate Test Cases
    • Modify schemas with AI
    • Endpoint compliance check
    • API documentation completeness check
    • AI naming
    • FAQs
  • Apidog MCP Server
    • Overview
    • Connect API Specification within Apidog Project to AI via Apidog MCP Server
    • Connect Online API Documentation Published by Apidog to AI via Apidog MCP Server
    • Connect OpenAPI Files to AI via Apidog MCP Server
  • Best Practices
    • How to handle API signatures
    • How to access OAuth 2.0 protected APIs
    • Apidog collaboration workflow
    • Managing authentication state in Apidog
  • Offline Space
    • Overview
  • Administration
    • Onboarding Checklist
      • Basic Concepts
      • Onboarding Guide
    • Managing teams
      • Managing Teams
      • Managing Team Members
      • Member Roles & Permission Settings
      • Team Activities
      • Team Resources
        • General Runner
        • Team Variables
        • Request Proxy Agent
      • Real-time Collaborations
        • Team Collaboration
    • Managing Projects
      • Managing Projects
      • Managing Project Members
      • Notification Settings
      • Project Resources
        • Database Connection
        • Git Connection
    • Managing Organization
      • Managing Organization
      • Single Sign-On (SSO)
        • SSO Overview
        • Configure Microsoft Entra ID
        • Configure Okta
        • Configure SSO for an Organization
        • Managing user accounts
        • Mapping Groups to Teams
      • SCIM Provisioning
        • Intro to SCIM Provisioning
        • Microsoft Entra ID
        • Okta
      • Organization Resources
        • Self-hosted Runner
      • Plans management
        • Billing managers in organization
  • Billing
    • Overview
    • Credits
    • Unable to use credit cards
    • Managing subscriptions
    • Upgrade plan
    • How to move a paid team to a organization
  • Data & Security
    • Apidog data storage location and security
    • User data privacy and storage location
    • Request routing and data security
  • Add-ons
    • API Hub
    • Apidog Intellij IDEA plugin
    • Browser Extension
      • Chrome
      • Microsoft Edge
    • Request Proxy
      • Request proxy in Apidog web
      • Request proxy in shared docs
      • Request proxy in Apidog client
  • Account & preferences
    • Account settings
    • Generate OpenAPI access token
    • Notification
    • Language settings
    • Hot keys
    • Network proxy configuration
    • Data backup
    • Updating Apidog
    • Deleting account
    • Experimental Features
  • References
    • API-Design First Approach
    • Apidog OpenAPI Specificaiton Extensions
    • JSONPath
    • XPath
    • Regular Expressions
    • JSON Schema
    • CSV File Format
    • Install Java Environment
    • Runner deployment environment
    • Apidog flavored Markdown
  • Apidog Europe
    • Apidog Europe
  • Support Center
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
HomeLearning Center
Support CenterAPI ReferencesDownloadChangelog
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Send requests

MCP Client

Overview#

MCP (Model Context Protocol) is an open protocol for establishing standardized communication between large language model (LLM) applications and external data sources and tools. Apidog has a built-in MCP Client that supports debugging and testing MCP Servers.
MCP Servers provide three main features, all of which are supported for debugging by the Apidog MCP Client:
Tools: Executable server-side functions
Prompts: Predefined prompt templates
Resources: Data resources provided by the server
Two transport methods are supported:
STDIO: Communication via standard input/output, suitable for local processes
HTTP: Communication via Streamable HTTP, suitable for remote servers

Create MCP Client#

Create a new endpoint in an HTTP project and select MCP.
Create MCP Client

Connect to MCP Server#

Enter Server Address#

Apidog supports multiple ways to input MCP Server connection information:
Direct Command or URL Input
When pasting a terminal command, the protocol automatically switches to STDIO:
When pasting a URL, the protocol automatically switches to HTTP:
https://learn.microsoft.com/api/mcp
Paste Configuration File
Apidog supports pasting MCP Server configuration files directly and will automatically parse and populate the relevant information.
MCP Servers File Example:
{
  "mcpServers": {
    "Everything Server": {
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-everything"],
      "env": {}
    }
  }
}
MCP Server Entry Example:
{
  "type": "streamable-http",
  "url": "https://learn.microsoft.com/api/mcp"
}
After pasting the configuration file, Apidog will automatically extract the server name, address, environment variables, and other information. If the configuration file contains multiple servers, the first one will be used.

Establish Connection#

Click the Connect button to initiate the connection.
STDIO Connection
Since local command execution is required, Apidog will display a security confirmation dialog. After confirmation, it will start the local process and establish the connection.
HTTP Connection
Send a connection request directly to the specified URL.
For MCP Servers with OAuth 2.0 authentication, Apidog will automatically retrieve authentication configuration and display the authentication window
Other authentication methods (API Key, Bearer Token, Basic Auth, etc.) can also be manually configured in the Auth tab
After a successful connection, the directory tree will display the list of Tools, Prompts, and Resources provided by the server.

Debugging Features#

Tools#

Tools are executable functions provided by the server. After selecting a Tool, you can configure parameters via form or JSON editor.
After configuring the parameters, click Run to execute. Results will be displayed in the response area.

Prompts#

Prompts are predefined prompt templates. After selecting a Prompt, configure parameters (if any) and click Run to get the generated prompt.

Resources#

Resources are data resources provided by the server. After selecting a Resource, click Run to retrieve the resource content.

Configuration Options#

Environment#

Available only for STDIO mode. Used to configure environment variables when starting the MCP Server process.
Example:
KeyValue
ACCESS_TOKENyour-token-here
NODE_ENVproduction

Auth#

Available only for HTTP mode. Supports multiple authentication methods:
API Key
Bearer Token
JWT Bearer
Basic Auth
Digest Auth
OAuth 2.0
For MCP Servers that support OAuth 2.0, Apidog can automatically retrieve and populate authentication configuration.

Headers#

Available only for HTTP mode. Used to configure custom HTTP request headers.

View Response#

The response area is divided into two tabs:
Response: Displays messages related to user operations (connect/disconnect events, requests/responses)
Notifications: Displays messages actively sent by the server (notifications, tool list updates, etc.)
Click on a message to view details including message type, content, timestamp, etc.
You can switch to "With Envelope" mode to view the complete JSON-RPC format (including envelope).

Variable Support#

Variables {{variable_name}} are supported in the following locations:
Server address or command
Environment variable values
Request headers
Authentication information
Parameter values

Save and Share#

Configured MCP clients can be saved to the project for subsequent use and team collaboration.
Note: The MCP directory tree (Tools, Prompts, Resources list) is stored locally only and refreshes automatically on each connection.

FAQ#

STDIO connection fails with "command not found" error#

Ensure the required runtime (such as Node.js) is installed and check that the command path is correct.

HTTP connection returns 401 error#

Apidog will automatically attempt to retrieve OAuth 2.0 configuration. If it fails, manually configure authentication information in the Auth tab.

Connection successful but directory tree is empty#

Check that the server configuration is correct and view the Notifications tab to confirm whether the server has returned the tool list.

Parameter type mismatch#

When using form mode, Apidog will automatically validate parameter types. In JSON editor mode, be careful not to add quotes around numbers and use true/false for boolean values.
Modified atΒ 2026-01-21 17:39:46
Previous
SSE debugging
Next
Socket.IO
Built with