Test an MCP server connection

curl --request POST \
  --url 'https://api.orq.ai/v2/mcp-servers:test' \
  --header 'Authorization: Bearer $ORQ_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "connection": {
      "type": "MCP_CONNECTION_TYPE_HTTP",
      "url": "https://api.githubcopilot.com/mcp/"
    },
    "auth": {
      "type": "MCP_AUTH_TYPE_STATIC_HEADERS",
      "static_headers": [
        { "key": "Authorization", "value": "Bearer ghp_example_token" }
      ]
    }
  }'

{
  "result": {
    "ok": true,
    "tools": [
      {
        "name": "<string>",
        "description": "<string>",
        "input_schema": {},
        "status": "<string>",
        "id": "<string>",
        "title": "<string>",
        "annotations": {
          "read_only": true,
          "destructive": true,
          "idempotent": true,
          "open_world": true
        }
      }
    ],
    "latency_ms": 123,
    "error_message": "<string>",
    "errors": [
      "<string>"
    ]
  }
}

POST

mcp-servers:test

curl --request POST \
  --url 'https://api.orq.ai/v2/mcp-servers:test' \
  --header 'Authorization: Bearer $ORQ_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "connection": {
      "type": "MCP_CONNECTION_TYPE_HTTP",
      "url": "https://api.githubcopilot.com/mcp/"
    },
    "auth": {
      "type": "MCP_AUTH_TYPE_STATIC_HEADERS",
      "static_headers": [
        { "key": "Authorization", "value": "Bearer ghp_example_token" }
      ]
    }
  }'

{
  "result": {
    "ok": true,
    "tools": [
      {
        "name": "<string>",
        "description": "<string>",
        "input_schema": {},
        "status": "<string>",
        "id": "<string>",
        "title": "<string>",
        "annotations": {
          "read_only": true,
          "destructive": true,
          "idempotent": true,
          "open_world": true
        }
      }
    ],
    "latency_ms": 123,
    "error_message": "<string>",
    "errors": [
      "<string>"
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

connection

object

Connection to probe. Omit when id is set.

Show child attributes

auth

object

Credentials to probe with. Omit when id is set.

Show child attributes

string

Probe a stored server instead of sending connection and auth.

discovery_variables

object

Values for the server's template_variables; treated as sensitive and not persisted.

Show child attributes

Response

200 - application/json

result

object

Show child attributes

⌘I

Orq SDK

Terminal & Agents

Terraform

Platform APIs

Management APIs

Authorizations

Body

Response