Skip to main content
POST
Test an MCP server configuration

Authorizations

X-Session-API-Key
string
header
required

Body

application/json

Body for POST /api/mcp/test.

server
_StdioMCPServerSpec · object
required

Legacy stdio MCP server spec accepted by the public REST API.

name
string
default:test-server

Name to use for the server inside the temporary MCP server map. Only affects error messages -- does not need to match any persisted setting.

Required string length: 1 - 128
timeout
number
default:15

Seconds to wait for connection + tools/list to complete.

Required range: x <= 120
tool_call
MCPToolCallSpec · object | null

Optional read-only tool to invoke after listing succeeds, so callers can verify credentials the server only exercises on tool invocation. Its outcome is reported verbatim in tool_result without affecting ok.

Response

Successful Response

Response when the candidate server connects and lists its tools.

oauth_state
MCPOAuthStateResponse · object | null

Serialized OAuth state acquired or refreshed by the probe. Clients should persist this under the tested server's auth.state.

ok
boolean
default:true
resolved_mcp_servers
Resolved Mcp Servers · object[] | null
deprecated

Deprecated compatibility field for older clients that expected resolved MCP server metadata in test responses.

tool_result
MCPToolCallResult · object | null

Outcome of the requested tool_call, when one was supplied.

tools
string[]

Names of tools advertised by the MCP server.