API ReferenceAgents
MCP Server — test connection
Tests MCP server connectivity and returns success, message, and tools_count.
Authorization
ApiKeyAuth AuthorizationBearer <token>
Team API key (prefix sk_). You may also send the key via X-Api-Key header.
In: header
Path Parameters
agentId*string
integrationId*string
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/console/agents/string/integrations/mcp_server/string/test"{ "message": "Success", "data": { "success": true, "message": "string", "error": "string", "tools_count": 0 }}Empty
{ "message": "Connection failed", "error": "Bad Request", "code": "integration_connection_failed", "statusCode": 400, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}{ "message": "Invalid API key.", "error": "Unauthorized", "code": "api_key_invalid", "statusCode": 401, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}{ "message": "This API key is missing the required scope: conversations:read.", "error": "Forbidden", "code": "insufficient_scope", "statusCode": 403, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}{ "message": "Integration not found", "error": "Not Found", "code": "not_found", "statusCode": 404, "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}