> ## Documentation Index > Fetch the complete documentation index at: https://docs.orq.ai/llms.txt > Use this file to discover all available pages before exploring further. # Test an MCP server connection > Probes an upstream MCP server connection without persisting it. Returns discovered tools and connectivity status. ## OpenAPI ````yaml post /v2/mcp-servers:test openapi: 3.1.0 info: title: orq.ai API version: '2.0' description: orq.ai API documentation servers: - url: https://api.orq.ai security: - ApiKey: [] tags: - name: Chunking description: Split text into smaller chunks for retrieval and generation workflows. - name: Knowledge Bases description: Create and manage knowledge bases used by agents and retrieval workflows. - name: Memory Stores description: Create and manage memory stores, memories, and memory documents. - name: Evals description: Run an evaluator against a conversation and its result - description: List models available through the AI Router. name: Models - name: Policies - name: Alerts description: >- Alerts evaluate a Reporting API metric on a fixed interval and fire notifications through notifiers when the value breaches a threshold. Each breach opens a trigger that tracks the incident until the value recovers. - name: API keys description: >- API keys authenticate programmatic access to the workspace. The unified key model exposes opaque tokens, per-domain access grants, and budget / rate-limit constraints (see ADR 0001 and ADR 0002). - name: Budgets description: >- Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, api-key, provider, and model. A budget is hierarchical and defense-in-depth — every applicable budget is a hard gate, and the most restrictive one wins per dimension (see ADR 0007). - name: Documentation description: >- Search the orq.ai documentation. Proxies the workspace's query to the hosted docs search index. - name: Files description: File upload and retrieval operations. - name: Finder description: >- Finder entities back the studio navigation tree, project switcher, and cross-project resource references. - name: Guardrail Rules description: >- Guardrail Rules conditionally enforce evaluators and plugins for AI Gateway traffic. Rules may be scoped to a project or the whole workspace. - name: Identities description: >- Identities represent end users from your system for usage and engagement tracking. - name: Management keys description: >- Management keys are workspace-scoped credentials that authenticate programmatic access to workspace administration surfaces (API keys, budgets). Unlike project-scoped API keys, a management key always operates at the workspace level. - name: MCP Gateway description: >- Register upstream MCP servers, discover and sync their tools, and assemble gateways that expose a curated tool surface to MCP clients. - name: Model Catalog description: >- Browse the orq.ai model catalog: every model orq offers, across every provider, with pricing, capabilities and benchmark data. List endpoints only return models that are not deprecated. This API is public, requires no authentication, and is rate limited to 120 requests per minute per IP. Responses carry a 5-minute cache-control max-age. - name: Model Sharing description: >- Model sharing controls which projects a workspace model is available to. Workspace admins configure a model's Sharing (all projects / selected projects); the config ships inline on the models list response, so there is no separate read endpoint. - name: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - name: Projects description: Projects organize resources within a workspace - name: Routing Rules description: >- Routing Rules conditionally select models and enforce request plugins for AI Gateway traffic. Rules are evaluated by ascending priority and may be scoped to a project or the whole workspace. - name: Skills description: >- Skills are modular instructions you can use to codify processes and conventions - name: Smart Routers description: >- Create and manage workspace Smart Routers. A Smart Router selects a model from an eligible pool for each request according to a quality, balanced, or cost profile. - name: Webhooks description: >- Create and manage webhooks that deliver workspace events to external HTTPS endpoints. - name: Workspace Security description: >- Workspace-level domain verification and IP allowlist controls. These operations are restricted to workspace administrators. - name: Workspace Settings description: >- Workspace-level settings managed with a workspace credential. A workspace is the tenant, so these settings are a singleton — there is nothing to create or delete, only read and update. - name: Responses - description: Run agents on a cron cadence. Minimum firing interval is 1 hour. name: Agent Schedules - name: Embeddings - name: Logs description: >- OpenTelemetry log query API. Search, filter, aggregate, and facet log records ingested via OTLP. - name: Reporting description: >- GenAI reporting API over canonical analytics rollups. Accepts a metric name, time range, grain, group-by, and filters; returns a typed time series and optional totals. - name: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. externalDocs: url: https://docs.orq.ai description: orq.ai Documentation paths: /v2/mcp-servers:test: post: tags: - MCP Gateway summary: Test an MCP server connection description: >- Probes an upstream MCP server connection without persisting it. Returns discovered tools and connectivity status. operationId: McpServerTest requestBody: content: application/json: schema: $ref: '#/components/schemas/TestMcpServerRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/TestMcpServerResponse' x-code-samples: - lang: curl label: Core - Test a connection before saving it source: | 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" } ] } }' - lang: curl label: Core - Re-test a saved server source: | curl --request POST \ --url 'https://api.orq.ai/v2/mcp-servers:test' \ --header 'Authorization: Bearer $ORQ_API_KEY' \ --header 'Content-Type: application/json' \ --data '{ "id": "01JQ0K5R8N2ZC7X4M9T3V6HWBD" }' - lang: python label: Python - Test a connection before saving it source: | import os from orq_ai_sdk import Orq client = Orq(api_key=os.environ["ORQ_API_KEY"]) # Nothing is persisted. Failures come back as ok=False on a 200. result = client.mcp_servers.test( 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"}, ], }, ) if result.result.ok: print(f"{len(result.result.tools)} tools reachable") else: print(result.result.error_message) - lang: typescript label: Node.js - Test a connection before saving it source: | import { Orq } from '@orq-ai/node'; const client = new Orq({ apiKey: process.env.ORQ_API_KEY, }); // Nothing is persisted. Failures come back as ok=false on a 200. const { result } = await client.mcpServers.test({ connection: { type: 'MCP_CONNECTION_TYPE_HTTP', url: 'https://api.githubcopilot.com/mcp/', }, auth: { type: 'MCP_AUTH_TYPE_STATIC_HEADERS', staticHeaders: [ { key: 'Authorization', value: 'Bearer ghp_example_token' }, ], }, }); if (result.ok) { console.log(`${result.tools.length} tools reachable`); } else { console.log(result.errorMessage); } components: schemas: TestMcpServerRequest: type: object properties: connection: allOf: - $ref: '#/components/schemas/McpConnection' description: Connection to probe. Omit when `id` is set. auth: allOf: - $ref: '#/components/schemas/McpAuthConfig' description: Credentials to probe with. Omit when `id` is set. id: type: string description: Probe a stored server instead of sending `connection` and `auth`. discovery_variables: type: object additionalProperties: type: string description: >- Values for the server's `template_variables`; treated as sensitive and not persisted. TestMcpServerResponse: type: object properties: result: $ref: '#/components/schemas/McpTestResult' McpConnection: required: - type - url type: object properties: type: $ref: '#/components/schemas/McpConnectionType' description: Transport the gateway uses to dial the upstream server. url: type: string description: Upstream endpoint; must use the http or https scheme. McpAuthConfig: required: - type type: object properties: type: $ref: '#/components/schemas/McpAuthType' description: >- Credential scheme; only NONE and STATIC_HEADERS are accepted by create, update and test. static_headers: type: array items: $ref: '#/components/schemas/McpHeaderSecret' description: >- Headers sent upstream on every request; at least one entry when type is STATIC_HEADERS. oauth: allOf: - $ref: '#/components/schemas/McpOAuthConfig' description: Not settable through these endpoints. McpTestResult: type: object properties: ok: type: boolean description: Whether the probe connected and listed tools successfully. tools: type: array items: $ref: '#/components/schemas/McpTool' description: Tools discovered during the probe; not persisted. latency_ms: type: integer description: Round trip time of the probe in milliseconds. format: int32 error_message: type: string description: Human-readable reason the probe failed. errors: type: array items: type: string description: Additional failure details collected during the probe. McpConnectionType: type: string enum: - MCP_CONNECTION_TYPE_UNSPECIFIED - MCP_CONNECTION_TYPE_HTTP - MCP_CONNECTION_TYPE_SSE - MCP_CONNECTION_TYPE_STDIO McpAuthType: type: string enum: - MCP_AUTH_TYPE_UNSPECIFIED - MCP_AUTH_TYPE_NONE - MCP_AUTH_TYPE_STATIC_HEADERS - MCP_AUTH_TYPE_OAUTH_CLIENT_CREDENTIALS - MCP_AUTH_TYPE_PER_USER_OAUTH McpHeaderSecret: type: object properties: key: type: string description: Header name sent to the upstream server. value: writeOnly: true type: string description: Header value; accepted on write and never returned. masked_value: type: string description: Redacted preview of `value`, returned in its place. McpOAuthConfig: type: object properties: client_id: type: string description: >- OAuth client identifier presented to the upstream authorization server. client_secret: writeOnly: true type: string description: OAuth client secret; accepted on write and never returned. token_url: type: string description: Token endpoint the gateway calls to mint upstream access tokens. scopes: type: array items: type: string description: Scopes requested when minting upstream access tokens. masked_value: type: string description: Redacted preview of `client_secret`, returned in its place. McpTool: type: object properties: name: type: string description: Bare tool name as advertised by the upstream server. description: type: string description: Tool description advertised upstream, passed through to MCP clients. input_schema: type: object description: JSON Schema for the tool arguments, as advertised upstream. status: type: string description: >- `ACTIVE`, or `MISSING` when the last sync no longer found the tool upstream. id: readOnly: true type: string description: Assigned once on first discovery and preserved across sync. title: type: string description: Human-readable label advertised upstream, when the server sends one. annotations: allOf: - $ref: '#/components/schemas/McpToolAnnotations' description: Behaviour hints claimed by the upstream server. McpToolAnnotations: type: object properties: read_only: type: boolean description: Upstream claims the tool does not modify state. destructive: type: boolean description: Upstream claims the tool can perform destructive updates. idempotent: type: boolean description: >- Upstream claims repeated calls with the same arguments have no extra effect. open_world: type: boolean description: Upstream claims the tool reaches systems outside its own domain. description: Hints claimed by the upstream server; the gateway does not enforce them. securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ````