> ## Documentation Index > Fetch the complete documentation index at: /docs/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. > [!NOTE] > > **Guia relacionado**: guia de Gateways MCP. Consulte o guia de Gateways MCP para um passo a passo com exemplos. ## OpenAPI ````yaml get /v2/mcp-gateways/{id} openapi: 3.1.0 info: title: Toqan Router API version: '2.0' description: Toqan Router API documentation servers: - url: https://router.toqan.ai/eu description: Frankfurt (Europe) - url: https://router.toqan.ai/br description: São Paulo (Brazil) security: - ApiKey: [] tags: - description: >- API keys authenticate programmatic access to the workspace. They expose opaque tokens, per-domain access grants, and budget and rate-limit constraints. name: API keys - 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: Telemetry description: >- Unified query envelope for traces, metrics, and logs. One request shape, one filter dialect, and one response shape per source, validated by a per-source registry. - name: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. - name: Views description: Saved filters and columns for workspace observability pages. - description: List models available through the AI Router. name: Models - name: Alerts description: >- Alerts evaluate a telemetry 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: Annotation Queues description: Annotation queues collect spans for human review. - name: Budgets description: >- Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, API key, provider, and model. Every applicable budget is enforced, and the most restrictive limit applies per dimension. - name: Files description: File upload and retrieval operations. - 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 Toqan Router model catalog: every model Toqan Router 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: Monitors description: >- Monitors are custom observability dashboards for traces, runtime metrics, and logs. Each monitor holds widgets that chart one telemetry query. List the metrics, operations, and dimensions available to your workspace with `GET /v3/telemetry/capabilities`, or start from a preset with `GET /v2/monitors/presets`. - name: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - 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: Threads description: Threads group related trace invocations and their aggregate usage - 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: Responses - name: Embeddings - description: Beta. Run typed classification questions against a classify model. name: Classify - description: Beta. Run classification decisions with the classify contract. name: Decisions - description: >- Run large offline workloads as JSONL batches and download OpenAI-compatible result files. name: Batches 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' '401': description: >- Authentication required. See https://router.toqan.ai/docs/reference/errors for the error codes. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: >- The resource does not exist. See https://router.toqan.ai/docs/reference/errors for the error codes. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - ApiKey: [] x-code-samples: - lang: curl label: Core - Retrieve an MCP gateway source: > curl --get 'https://router.toqan.ai/eu/v2/mcp-gateways/01JQ0M8W4T5YB2Q7N1F6K3PZRC' \ --header "Authorization: Bearer $TOQAN_API_KEY" components: schemas: GetMcpGatewayResponse: type: object properties: mcp_gateway: $ref: '#/components/schemas/McpGateway' ErrorResponse: type: object properties: message: type: string description: Human-readable error message. code: type: integer description: Numeric error code, when one is available. details: type: array items: {} description: Additional error details, when the service reports any. required: - message 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. example: Production Gateway 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. 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. plugins: type: array items: $ref: '#/components/schemas/McpGatewayPlugin' description: Plugins run on every tool call this gateway serves. skill_ids: type: array items: type: string description: >- Workspace skills this gateway serves to MCP clients through the MCP Skills extension. icons: type: array items: $ref: '#/components/schemas/McpIcon' description: >- Icons advertised to MCP clients; defaults to Toqan Router branding when empty. website_url: type: string description: >- Website advertised to MCP clients; defaults to Toqan Router documentation when empty. guardrails: type: array items: $ref: '#/components/schemas/GuardrailRuleGuardrail' description: >- Guardrails run on the arguments and result of every tool call this gateway serves. created_by_id: readOnly: true type: string description: Account that created the 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. skill_exposure: allOf: - $ref: '#/components/schemas/McpSkillExposure' description: Which of the server's skills this gateway serves. Unset serves none. resource_exposure: allOf: - $ref: '#/components/schemas/McpResourceExposure' description: >- Which upstream resources and templates this gateway exposes. Omission preserves an existing link's selection and exposes none on a new link. McpToolNaming: type: string enum: - MCP_TOOL_NAMING_PREFIX_WITH_SERVER_KEY - MCP_TOOL_NAMING_PREFIX_ON_COLLISION McpGatewayMode: type: string enum: - 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 the latest version. 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. description: |- Sharing controls which projects in the workspace may use this entity and what they may do with it. McpGatewayPlugin: type: object properties: id: type: string description: Plugin discriminator. language: type: string entities: type: array items: type: string on_failure: type: string threshold: type: number format: double mask: type: array items: type: string regions: type: array items: type: string description: >- Regions of coverage by ISO 3166-1 alpha-2 code, or ["all"]. Combines with entities: the two selections are unioned. entity_thresholds: type: object additionalProperties: type: number format: double description: >- Per-entity-type confidence cutoff. Every key must also appear in entities. McpIcon: type: object properties: src: type: string description: Icon URI, including HTTPS URLs and base64 data URIs. mime_type: type: string description: Optional MIME type override. sizes: type: array items: type: string description: Supported sizes such as "48x48" or "any". theme: type: string description: Optional background theme this icon was designed for. GuardrailRuleGuardrail: required: - id - execute_on type: object properties: id: type: string execute_on: type: string sample_rate: type: number format: double is_guardrail: type: boolean options: type: object McpToolExposure: required: - mode type: object properties: mode: $ref: '#/components/schemas/McpToolExposureMode' description: 'Selection strategy: ALL, SELECTED or NONE.' example: MCP_TOOL_EXPOSURE_MODE_ALL 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. excluded_tool_ids: type: array items: type: string description: >- `McpTool.id` values deliberately left unexposed when mode is SELECTED; an active tool in neither list is new to this selection. McpSkillExposure: required: - mode type: object properties: mode: $ref: '#/components/schemas/McpToolExposureMode' description: >- Selection strategy: ALL, SELECTED or NONE. An unset exposure exposes no skills. skill_uris: type: array items: type: string description: '`McpSkill.uri` values to expose when mode is SELECTED.' McpResourceExposure: required: - mode type: object properties: mode: $ref: '#/components/schemas/McpToolExposureMode' description: >- ALL exposes all current and future resources and templates. SELECTED exposes only the listed IDs. NONE exposes neither. resource_ids: type: array items: type: string description: '`McpResource.selection_id` values to expose when mode is SELECTED.' resource_template_ids: type: array items: type: string description: >- `McpResourceTemplate.selection_id` values to expose when mode is SELECTED. 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_ALL - MCP_TOOL_EXPOSURE_MODE_SELECTED - MCP_TOOL_EXPOSURE_MODE_NONE example: MCP_TOOL_EXPOSURE_MODE_ALL securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.