Connect an MCP Client

The ReadyAPI MCP Server supports any MCP-compatible client that uses Streamable HTTP transport. This page provides configuration examples for the most typical clients, followed by steps to verify that the connection is working.

VS Code with GitHub Copilot

Add the following to your VS Code .vscode/mcp.json or user-level MCP settings:

{
  "servers": {
    "readyapi": {
      "type": "http",
      "url": "http://127.0.0.1:2015/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN_HERE"
      }
    }
  }
}

Cursor

Add the following entry to your Cursor MCP configuration file (~/.cursor/mcp.json):

{
  "mcpServers": {
    "readyapi": {
      "transport": "http",
      "url": "http://127.0.0.1:2015/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN_HERE"
      }
    }
  }
}

Claude Desktop

Add the ReadyAPI MCP server to your Claude Desktop configuration file (claude_desktop_config.json):

{
  "mcpServers": {
    "readyapi": {
      "transport": "http",
      "url": "http://127.0.0.1:2015/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_TOKEN_HERE"
      }
    }
  }
}

Alternatively, use the Claude CLI:

claude mcp add --transport http readyapi http://127.0.0.1:2015/mcp \
  --header "Authorization: Bearer YOUR_TOKEN_HERE"

Claude Code

From the terminal, register the server using the Claude Code CLI:

claude mcp add --transport http readyapi http://127.0.0.1:2015/mcp \
  --header "Authorization: Bearer YOUR_TOKEN_HERE"

Claude Code persists this configuration for all subsequent sessions.

Other MCP hosts

For any other MCP-compatible host, use the following settings to construct your configuration. Refer to your client's documentation for the exact format.

Table 89. Settings

Setting	Value
Transport type	Streamable HTTP
Server URL	`http://127.0.0.1:2015/mcp`
Authentication	Bearer token (From ReadyAPI Preferences > Integrations > ReadyAPI MCP)
Header name	`Authorization`
Header value format	`Bearer <your-token>`

Verify the connection

After configuring your MCP client, confirm the server is reachable before starting work.

Ensure ReadyAPI is running. The MCP Server only runs while ReadyAPI is open.
Open your AI client and start a new conversation.
Type /mcp to view available tools.
Prompt your AI assistant with: List my ReadyAPI projects.
If the server is connected, the AI returns a list of projects from your current ReadyAPI workspace. If you see an error, use the Table 90, “Common connection issues” below to diagnose it.

Common connection issues

Table 90. Common connection issues

Symptom	Resolution
No projects returned / connection refused	Check that ReadyAPI is running. The MCP Server only runs while ReadyAPI is open.
401 Unauthorized	The token may be incorrect or have trailing whitespace. Re-copy it from Preferences > Integrations > ReadyAPI MCP > Copy.
Port conflict on port `2015`	Another process may be using port `2015`. Change the port in Preferences > Integrations > ReadyAPI MCP > TCP PORT, and update your client configuration to match.
The connection works from one client but not another	Each client needs its own copy of the bearer token in its configuration file. Regenerating the token invalidates all existing clients - update each one.
Configuration file changes are not taking effect	Most MCP clients require a restart after editing their configuration file. Restart your client and try again.