Skip to main content
POST
/
workspaces
/
{workspace_id}
/
mcp-integrations
/
test
Error
A valid request URL is required to generate request examples
{
  "success": true,
  "message": "<string>",
  "mcp_integration_id": "<string>",
  "tools": [
    {
      "name": "<string>",
      "description": "<string>",
      "enabled": true,
      "requires_approval": false,
      "status": "available"
    }
  ],
  "error": "<string>"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

fastapiusersauth
string
cookie
required

Path Parameters

workspace_id
string<uuid>
required

Body

application/json

Request to test connectivity against an unsaved HTTP MCP configuration.

Carries the (possibly edited, not yet persisted) form values. When mcp_integration_id is set, stored secrets from that row are used as a fallback for fields the caller leaves blank (e.g. unchanged credentials).

server_uri
string
required
Required string length: 1 - 2048
mcp_integration_id
string<uuid4> | null
auth_type
enum<string>
default:NONE

Authentication type for MCP integrations.

Available options:
OAUTH2,
CUSTOM,
NONE
oauth_integration_id
string<uuid4> | null
custom_credentials
string<password> | null

JSON object of custom headers; falls back to stored headers when omitted

timeout
integer | null
Required range: 1 <= x <= 300

Response

Successful Response

Response for testing connectivity to an MCP server.

success
boolean
required
message
string
required
mcp_integration_id
string<uuid4> | null
tools
MCPToolSummary · object[] | null
error
string | null