> ## 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 server > Retrieves the details of an existing MCP server 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-servers/{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-servers/{id}: get: tags: - MCP Gateway summary: Retrieve an MCP server description: Retrieves the details of an existing MCP server by its unique ID. operationId: McpServerGet parameters: - name: id in: path description: Unique identifier of the MCP server. required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/GetMcpServerResponse' '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 server source: > curl --get 'https://router.toqan.ai/eu/v2/mcp-servers/01JQ0K5R8N2ZC7X4M9T3V6HWBD' \ --header "Authorization: Bearer $TOQAN_API_KEY" components: schemas: GetMcpServerResponse: type: object properties: mcp_server: $ref: '#/components/schemas/McpServer' 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 McpServer: type: object properties: id: type: string description: Unique identifier of the MCP server. key: type: string description: >- Lowercase slug of letters, digits, hyphens and underscores, max 64 characters, unique per workspace; prefixes this server's tool names in gateways. display_name: type: string description: Human readable name shown in the workspace. description: type: string description: Free-form note about what this server is for. connection: allOf: - $ref: '#/components/schemas/McpConnection' description: How the gateway dials the upstream server. auth: allOf: - $ref: '#/components/schemas/McpAuthConfig' description: >- Credentials the gateway sends upstream; send `type: NONE` explicitly for public servers. default_tool_exposure: allOf: - $ref: '#/components/schemas/McpToolExposure' description: >- Fallback exposure used by any gateway link that does not set its own. sync_state: allOf: - $ref: '#/components/schemas/McpSyncState' description: Result of the last `:sync`; a new server has no tools until synced. tools: type: array items: $ref: '#/components/schemas/McpTool' description: Tool catalog discovered by the last successful `:sync`. created: type: string description: ISO 8601 timestamp of when the server was created. updated: type: string description: ISO 8601 timestamp of the most recent change to the server. sharing: allOf: - $ref: '#/components/schemas/Sharing' description: Which projects in the workspace may use this server. template_variables: readOnly: true type: array items: type: string description: >- Names of `{{variable}}` placeholders found in the connection or auth config; supply values as `discovery_variables` on test, sync and tool calls. x-speakeasy-ignore: true created_by_id: readOnly: true type: string description: Account that created the server. skills: readOnly: true type: array items: $ref: '#/components/schemas/McpSkill' description: >- Skills the upstream publishes through the MCP Skills extension, discovered by the last successful `:sync`. openapi: allOf: - $ref: '#/components/schemas/McpOpenApiConfig' description: Source of the tools of an `MCP_CONNECTION_TYPE_OPENAPI` server. icons: readOnly: true type: array items: $ref: '#/components/schemas/McpIcon' description: Icons advertised by the upstream server during discovery. website_url: readOnly: true type: string description: Website advertised by the upstream server during discovery. capabilities: readOnly: true allOf: - $ref: '#/components/schemas/McpServerCapabilities' description: Capabilities from shared MCP discovery or the caller's current sync. resource_catalog: readOnly: true allOf: - $ref: '#/components/schemas/McpResourceCatalog' description: >- Get returns the shared catalog. Sync returns the caller's catalog for user-specific credentials or discovery variables. List omits this field. McpConnection: required: - type - url type: object properties: type: $ref: '#/components/schemas/McpConnectionType' description: Transport the gateway uses to dial the upstream server. example: MCP_CONNECTION_TYPE_HTTP url: type: string description: Upstream endpoint; must use the http or https scheme. example: https://api.githubcopilot.com/mcp/ McpAuthConfig: required: - type type: object properties: type: $ref: '#/components/schemas/McpAuthType' description: Credential scheme used to authenticate to this upstream server. example: MCP_AUTH_TYPE_STATIC_HEADERS 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: >- OAuth client for the upstream authorization server; set when type is OAUTH_CLIENT_CREDENTIALS, PER_USER_OAUTH or ENTERPRISE_MANAGED. enterprise: deprecated: true allOf: - $ref: '#/components/schemas/McpEnterpriseAuthConfig' description: >- Superseded by `oauth` for ENTERPRISE_MANAGED; accepted on write and mirrored on read. 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. McpSyncState: type: object properties: status: $ref: '#/components/schemas/SyncStatus' description: >- Outcome of the last sync; a sync that discovers zero tools still reports SYNCED. tools_total: type: integer description: Tools in the catalog after the last sync. format: int32 tools_added: type: integer description: Tools the last sync discovered for the first time. format: int32 tools_removed: type: integer description: Tools the last sync no longer found upstream and marked MISSING. format: int32 last_synced_at: type: string description: ISO 8601 timestamp of the last sync attempt. errors: type: array items: type: string description: Failures reported by the last sync. skills_total: type: integer description: Skills in the catalog after the last sync. format: int32 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. http_operation: readOnly: true allOf: - $ref: '#/components/schemas/McpHttpOperation' description: >- OpenAPI operation the tool calls, for `MCP_CONNECTION_TYPE_OPENAPI` servers. icons: type: array items: $ref: '#/components/schemas/McpIcon' description: Icons advertised by the upstream tool. output_schema: type: object description: >- JSON Schema for the tool's structured result, as advertised upstream; omitted when the upstream sent an invalid one. meta: type: object description: Tool `_meta` advertised upstream. 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. McpSkill: type: object properties: uri: type: string description: Resource URI of the skill's `SKILL.md` on the upstream server. name: type: string description: Skill name from the `SKILL.md` frontmatter. description: type: string description: Skill description from the `SKILL.md` frontmatter. frontmatter: type: object description: Full `SKILL.md` frontmatter as published upstream. files: type: array items: $ref: '#/components/schemas/McpSkillFile' description: Manifest of the skill's files; empty when the skill is dynamic. dynamic: type: boolean description: Upstream generates the skill's content and publishes no manifest. description: >- A skill an upstream server publishes through the MCP Skills extension (`io.modelcontextprotocol/skills`). McpOpenApiConfig: type: object properties: document: writeOnly: true type: string description: >- OpenAPI 3.x document as JSON or YAML; accepted on write and never stored or returned. document_url: type: string description: URL the document is fetched from; `:sync` fetches it again. operations: type: array items: type: string description: >- Tool names of the operations to expose; empty exposes every operation. title: readOnly: true type: string description: '`info.title` of the compiled document.' version: readOnly: true type: string description: '`info.version` of the compiled document.' 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. McpServerCapabilities: type: object properties: tools: type: boolean resources: type: boolean prompts: type: boolean completions: type: boolean description: >- Capability families advertised by the upstream MCP server during discovery. McpResourceCatalog: type: object properties: resources: type: array items: $ref: '#/components/schemas/McpResource' resource_templates: type: array items: $ref: '#/components/schemas/McpResourceTemplate' resources_status: $ref: '#/components/schemas/McpDiscoveryStatus' resource_templates_status: $ref: '#/components/schemas/McpDiscoveryStatus' McpConnectionType: type: string enum: - MCP_CONNECTION_TYPE_HTTP - MCP_CONNECTION_TYPE_SSE - MCP_CONNECTION_TYPE_STDIO - MCP_CONNECTION_TYPE_OPENAPI McpAuthType: type: string enum: - MCP_AUTH_TYPE_NONE - MCP_AUTH_TYPE_STATIC_HEADERS - MCP_AUTH_TYPE_OAUTH_CLIENT_CREDENTIALS - MCP_AUTH_TYPE_PER_USER_OAUTH - MCP_AUTH_TYPE_ENTERPRISE_MANAGED McpHeaderSecret: type: object properties: key: type: string description: Header name sent to the upstream server. example: Authorization value: writeOnly: true type: string description: Header value; accepted on write and never returned. example: ghp_xxxxxxxxxxxx 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 for OAUTH_CLIENT_CREDENTIALS; PER_USER_OAUTH and ENTERPRISE_MANAGED discover it from `resource`. 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. issuer: type: string description: >- Exact authorization-server issuer; pins discovery for PER_USER_OAUTH and ENTERPRISE_MANAGED. resource: type: string description: >- Protected resource identifier; defaults to the upstream connection URL. description: >- McpOAuthConfig is the OAuth client Toqan Router presents to the upstream authorization server for OAUTH_CLIENT_CREDENTIALS, PER_USER_OAUTH and ENTERPRISE_MANAGED. McpEnterpriseAuthConfig: deprecated: true type: object properties: resource: type: string description: >- RFC 9728 resource identifier the tokens are bound to; defaults to the connection URL. client_id: type: string description: >- OAuth client identifier registered at the upstream authorization server. client_secret: writeOnly: true type: string description: OAuth client secret; accepted on write and never returned. masked_value: type: string description: Redacted preview of `client_secret`, returned in its place. scopes: type: array items: type: string description: Scopes requested when redeeming the identity assertion grant. description: >- McpEnterpriseAuthConfig is superseded by McpOAuthConfig: ENTERPRISE_MANAGED servers read and write `oauth`. It is still accepted on write and mirrored on read. 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 SyncStatus: type: string enum: - SYNC_STATUS_SYNCED - SYNC_STATUS_FAILED - SYNC_STATUS_PENDING 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; unset when the upstream sent no hint, which MCP reads as true. 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; unset when the upstream sent no hint, which MCP reads as true. title: type: string description: Display name the upstream sent in its annotations. description: Hints claimed by the upstream server; the gateway does not enforce them. McpHttpOperation: type: object properties: method: type: string description: HTTP method, upper case. path: type: string description: Path template relative to the server base URL. 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. McpSkillFile: type: object properties: uri: type: string description: Resource URI of the file on the upstream server. digest: type: string description: SHA-256 digest of the file's raw bytes, formatted as `sha256:{hex}`. size: type: string description: Length in bytes of the file's raw content. description: A file of an upstream skill, as listed in the skill's manifest. McpResource: type: object properties: uri: type: string name: type: string title: type: string description: type: string mime_type: type: string size: type: string annotations: $ref: '#/components/schemas/McpResourceAnnotations' icons: type: array items: $ref: '#/components/schemas/McpIcon' meta: type: object description: Resource `_meta` advertised upstream. selection_id: readOnly: true type: string description: >- Opaque selection ID scoped to this saved server and its upstream origin. Omitted on connection probes. McpResourceTemplate: type: object properties: uri_template: type: string name: type: string title: type: string description: type: string mime_type: type: string annotations: $ref: '#/components/schemas/McpResourceAnnotations' icons: type: array items: $ref: '#/components/schemas/McpIcon' meta: type: object description: Resource template `_meta` advertised upstream. selection_id: readOnly: true type: string description: >- Opaque ID for strict selection on a saved server. Omitted on probes and when template variables cannot be matched unambiguously. McpDiscoveryStatus: type: string enum: - MCP_DISCOVERY_STATUS_SYNCED - MCP_DISCOVERY_STATUS_UNSUPPORTED - MCP_DISCOVERY_STATUS_FAILED McpResourceAnnotations: type: object properties: audience: type: array items: type: string last_modified: type: string priority: type: number format: double description: >- Upstream annotations shared by resource and resource template descriptors. securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.