Skip to main content

Test a custom MCP server connection

POST 

/api/v1/mcp-servers/test-connection

Reads a stored configuration snapshot, performs the MCP handshake/tool listing and returns the observed count and latency. A concurrent update can change the record after that read. This operation reads the stored definition directly, making it useful after a configuration change.

Check success is true; a connection failure can return HTTP 200 with success false or omitted and an error. Inspect the error and repair the endpoint, authentication or network access before retrying. Authentication, validation, rate limiting and infrastructure failures can also return non-success HTTP responses.

Tests are limited to 10 per minute per project; destination restrictions apply when connecting. Rate limiting does not replace network isolation or authorization. A successful test is a point-in-time connection check, not a guarantee that every advertised tool is safe or available.

Request​

Responses​

The test ran; read success for the outcome

Document ID: DOC-IN-tools-connections-servers-api-testCustomMcpServerConnection. Section identities and revisions.

SectionStable reference
OverviewDOC-IN-tools-connections-servers-api-testCustomMcpServerConnection#overview
RequestDOC-IN-tools-connections-servers-api-testCustomMcpServerConnection#request
ResponsesDOC-IN-tools-connections-servers-api-testCustomMcpServerConnection#responses