> ## 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. # Retrieve an MCP gateway > Retrieves the details of an existing MCP gateway by its unique ID. ## OpenAPI ````yaml get /v2/mcp-gateways/{id} 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-gateways/{id}: get: tags: - MCP Gateway summary: Retrieve an MCP gateway description: Retrieves the details of an existing MCP gateway by its unique ID. operationId: McpGatewayGet parameters: - name: id in: path description: Unique identifier of the MCP gateway. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetMcpGatewayResponse' x-code-samples: - lang: curl label: Core - Retrieve an MCP gateway source: > curl --get 'https://api.orq.ai/v2/mcp-gateways/01JQ0M8W4T5YB2Q7N1F6K3PZRC' \ --header 'Authorization: Bearer $ORQ_API_KEY' - lang: python label: Python - Retrieve an MCP gateway source: > import os from orq_ai_sdk import Orq client = Orq(api_key=os.environ["ORQ_API_KEY"]) result = client.mcp_gateways.retrieve(id="01JQ0M8W4T5YB2Q7N1F6K3PZRC") # public_url is the endpoint MCP clients connect to. print(result.mcp_gateway.public_url, result.mcp_gateway.status) - lang: typescript label: Node.js - Retrieve an MCP gateway source: | import { Orq } from '@orq-ai/node'; const client = new Orq({ apiKey: process.env.ORQ_API_KEY, }); const result = await client.mcpGateways.retrieve({ id: '01JQ0M8W4T5YB2Q7N1F6K3PZRC', }); // publicUrl is the endpoint MCP clients connect to. console.log(result.mcpGateway.publicUrl, result.mcpGateway.status); components: schemas: GetMcpGatewayResponse: type: object properties: mcp_gateway: $ref: '#/components/schemas/McpGateway' McpGateway: type: object properties: id: type: string description: Unique identifier of the MCP gateway. key: type: string description: >- Lowercase slug of letters, digits, hyphens and underscores, max 64 characters, unique per workspace; backs the gateway's public MCP URL. display_name: type: string description: Human readable name shown in the workspace. description: type: string description: Free-form note about what this gateway is for. server_links: type: array items: $ref: '#/components/schemas/McpGatewayServerLink' description: Upstream servers this gateway aggregates. tool_naming: $ref: '#/components/schemas/McpToolNaming' description: How upstream tool names are namespaced before they are exposed. status: $ref: '#/components/schemas/McpGatewayStatus' description: >- ACTIVE serves MCP traffic; DISABLED rejects it while keeping the configuration. public_url: type: string description: >- Endpoint MCP clients connect to; relative when the deployment has no public base URL configured. created: type: string description: ISO 8601 timestamp of when the gateway was created. updated: type: string description: ISO 8601 timestamp of the most recent change to the gateway. exposed_tools_count: type: integer description: Number of tools currently exposed across all enabled links. format: int32 mode: $ref: '#/components/schemas/McpGatewayMode' description: 'Shape of the tool surface presented to MCP clients: CODE or DIRECT.' sharing: allOf: - $ref: '#/components/schemas/Sharing' description: Which projects in the workspace may use this gateway. McpGatewayServerLink: required: - mcp_server_id - alias - tool_exposure type: object properties: mcp_server_id: type: string description: Upstream MCP server this gateway aggregates. alias: type: string description: >- Prefix used instead of the server key when namespacing this server's tool names. Must be unique within the gateway. enabled: type: boolean description: Whether this link contributes tools to the gateway. tool_exposure: allOf: - $ref: '#/components/schemas/McpToolExposure' description: Narrows which of the server's tools this gateway exposes. McpToolNaming: type: string enum: - MCP_TOOL_NAMING_UNSPECIFIED - MCP_TOOL_NAMING_PREFIX_WITH_SERVER_KEY - MCP_TOOL_NAMING_PREFIX_ON_COLLISION McpGatewayStatus: type: string enum: - MCP_GATEWAY_STATUS_UNSPECIFIED - MCP_GATEWAY_STATUS_ACTIVE - MCP_GATEWAY_STATUS_DISABLED McpGatewayMode: type: string enum: - MCP_GATEWAY_MODE_UNSPECIFIED - MCP_GATEWAY_MODE_CODE - MCP_GATEWAY_MODE_DIRECT Sharing: type: object properties: all_projects: allOf: - $ref: '#/components/schemas/SharingAllProjects' description: Visible to every project in the workspace. selected: allOf: - $ref: '#/components/schemas/SharingSelectedProjects' description: Visible to the listed projects only. allow_version_pin: type: boolean description: |- Consuming projects may pin a specific version instead of tracking latest. Enforcement lives with the consuming reference. allow_fork: type: boolean description: |- Projects may duplicate this entity into a detached project-owned copy. auto_grant_new_projects: type: boolean description: |- New projects created after this sharing config is applied should receive access automatically. Enforcement lives with project creation and entity-specific adoption code. description: |- Sharing controls which projects in the workspace may use this entity and what they may do with it. McpToolExposure: required: - mode type: object properties: mode: $ref: '#/components/schemas/McpToolExposureMode' description: 'Selection strategy: ALL, SELECTED or NONE.' read_only: type: boolean description: Keeps only the tools the upstream annotates as read-only. tool_ids: type: array items: type: string description: >- `McpTool.id` values to expose when mode is SELECTED; a tool renamed upstream gets a new id on the next sync. SharingAllProjects: type: object properties: {} SharingSelectedProjects: type: object properties: project_ids: type: array items: type: string description: >- Projects allowed to use the entity. An empty list shares it with no project. McpToolExposureMode: type: string enum: - MCP_TOOL_EXPOSURE_MODE_UNSPECIFIED - MCP_TOOL_EXPOSURE_MODE_ALL - MCP_TOOL_EXPOSURE_MODE_SELECTED - MCP_TOOL_EXPOSURE_MODE_NONE securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ````