ORorq-ai
MCP Gateway

Create an MCP gateway

Changed on

Creates a client-facing MCP gateway that links one or more synced upstream servers and exposes a unified MCP endpoint.

post/v2/mcp-gateways

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/mcp-gateways
  • Auth
    HTTP bearer

Request body

keystring required

Lowercase slug of letters, digits, hyphens and underscores, max 64 characters, unique per workspace; backs the gateway's public MCP URL.

display_namestring required

Human readable name shown in the workspace.

descriptionstring

Free-form note about what this gateway is for.

tool_naming'MCP_TOOL_NAMING_PREFIX_WITH_SERVER_KEY' | 'MCP_TOOL_NAMING_PREFIX_ON_COLLISION'
mode'MCP_GATEWAY_MODE_CODE' | 'MCP_GATEWAY_MODE_DIRECT'
skill_idsstring[]

Workspace skills this gateway serves to MCP clients through the MCP Skills extension.

website_urlstring

Website advertised to MCP clients; defaults to ORQ documentation when empty.

Example request

{
  "display_name": "Production Gateway",
  "server_links": [
    {
      "tool_exposure": {
        "mode": "MCP_TOOL_EXPOSURE_MODE_ALL"
      },
      "skill_exposure": {
        "mode": "MCP_TOOL_EXPOSURE_MODE_ALL"
      }
    }
  ]
}

Response

OK

Example response

{
  "mcp_gateway": {
    "display_name": "Production Gateway",
    "server_links": [
      {
        "tool_exposure": {
          "mode": "MCP_TOOL_EXPOSURE_MODE_ALL"
        },
        "skill_exposure": {
          "mode": "MCP_TOOL_EXPOSURE_MODE_ALL"
        }
      }
    ]
  }
}

Changes

  • 928a71e92252Revision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 33d63277cd4eRevision changes
    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status