All Products
Search
Document Center

API Gateway:GetMcpServer

Last Updated:Dec 17, 2025

Queries the detailed information of an MCP server.

Operation description

You can call this operation to create multiple services at a time.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
apig:GetMcpServernone
*All Resources
*
    none
none

Request syntax

GET /v1/mcp-servers/{mcpServerId} HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
mcpServerIdstringNo

The MCP server ID.

mcp-adfefz24afg

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

requestIdstring

The request ID.

2A6E90D5-A711-54F4-A489-E33C2021EDDF
codestring

The status code.

Ok
messagestring

The status message.

Success
dataobject

The response payload.

mcpServerIdstring

The ID of the MCP server.

mcp-adfefz24afg
namestring

The name of the MCP server.

test-mcp
typestring

The type of the MCP server.

RealMCP
descriptionstring

The description.

gatewayIdstring

The gateway instance ID.

gw-cq2vundlhtg***
environmentIdstring

The environment ID.

env-cq7l5s5lhtgi6qasrdc0
routeIdstring

The route ID.

hr-cr82undlhtgrlej***
createFromTypestring

Indicates the type of source for MCP server creation. Valid values:

ApiGatewayHttpToMCP ApiGatewayMcpHosting ApiGatewayAssembly NacosHttpToMCP NacosMcpHosting

ApiGatewayHttpToMCP
backendBackend

The backend service of the route.

matchHttpRouteMatch

The route match rule.

{\"product_code\":\"apigw\"}
domainIdsarray

The domain name IDs.

domainIdsstring

The domain name ID.

d-aafefqefz
domainInfosarray<object>

The list of domain information.

domainInfosobject
protocolstring

The protocol. Valid values: HTTP and HTTPS.

HTTP
namestring

The domain name.

verifyicket
domainIdstring

The domain name ID.

www.abc.com
protocolstring

The service protocol.

HTTP
mcpServerPathstring

The MCP server access path provided by the gateway.

/mcp-servers/test-mcp
exposedUriPathstring

The exposed URI path. This parameter is required when the protocol parameter is set to SSE or StreamableHTTP, and the type parameter is set to RealMCP.

/sse
nacosMcpSyncInfoobject

The MCP information managed and synchronized by Nacos.

importInstanceIdstring

The Nacos instance.

mse-xxxxx
importNamespacestring

The Nacos namespace.

test-ns
importMcpServerIdstring

The synchronized MCP server ID.

test-mcp
assembledSourcesarray<object>

The list of assembly sources. This parameter is required when the type parameter is set to AssemblyMCP.

assembledSourcesobject

The assembly source. This parameter is required when the type parameter is set to AssemblyMCP.

mcpServerNamestring

The name of the MCP server.

test-mcp
mcpServerIdstring

The ID of the MCP server.

mcp-xdafeafzz
toolsarray

The list of the MCP tools.

toolsstring

The MCP tool.

test-tool
mcpServerConfigstring

The HTTP-to-MCP configurations.

mcpServerConfigPluginAttachmentIdstring

The attachment ID for the MCP server plug-in configuration.

pa-adfaefwaef
deployStatusstring

The publishing status of the API in the current environment.

Deployed
mcpStatisticsEnableboolean

Indicates whether MCP observability is enabled. Default value: false.

false

Examples

Sample success responses

JSONformat

{
  "requestId": "2A6E90D5-A711-54F4-A489-E33C2021EDDF",
  "code": "Ok",
  "message": "Success",
  "data": {
    "mcpServerId": "mcp-adfefz24afg",
    "name": "test-mcp",
    "type": "RealMCP",
    "description": "",
    "gatewayId": "gw-cq2vundlhtg***",
    "environmentId": "env-cq7l5s5lhtgi6qasrdc0\n",
    "routeId": "hr-cr82undlhtgrlej***",
    "createFromType": "ApiGatewayHttpToMCP",
    "backend": {
      "scene": "Single",
      "services": [
        {
          "serviceId": "service-cq2bmmdlhtgj***",
          "name": "item-service",
          "protocol": "HTTP",
          "port": 0,
          "weight": 49,
          "version": "v1"
        }
      ]
    },
    "match": {
      "ignoreUriCase": true,
      "path": {
        "type": "Prefix",
        "value": "/user"
      },
      "headers": [
        {
          "type": "Exact",
          "name": "dev",
          "value": true
        }
      ],
      "methods": [
        "GET"
      ],
      "queryParams": [
        {
          "type": "Exact",
          "name": "age",
          "value": 17
        }
      ]
    },
    "domainIds": [
      "d-aafefqefz"
    ],
    "domainInfos": [
      {
        "protocol": "HTTP",
        "name": "verifyicket",
        "domainId": "www.abc.com"
      }
    ],
    "protocol": "HTTP",
    "mcpServerPath": "/mcp-servers/test-mcp",
    "exposedUriPath": "/sse",
    "nacosMcpSyncInfo": {
      "importInstanceId": "mse-xxxxx",
      "importNamespace": "test-ns",
      "importMcpServerId": "test-mcp"
    },
    "assembledSources": [
      {
        "mcpServerName": "test-mcp",
        "mcpServerId": "mcp-xdafeafzz",
        "tools": [
          "test-tool"
        ]
      }
    ],
    "mcpServerConfig": "",
    "mcpServerConfigPluginAttachmentId": "pa-adfaefwaef",
    "deployStatus": "Deployed",
    "mcpStatisticsEnable": false
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2025-12-05The response structure of the API has changedView Change Details