ListMcpServers - 查询MCP Server列表

接口说明

接口支持创建多个服务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
apig:ListMcpServersnone
*全部资源
*

请求语法

GET /v1/mcp-servers HTTP/1.1

请求参数

名称类型必填描述示例值
gatewayIdstring

网关 ID。

gw-co370icmjeu****
nameLikestring

按接口名称模糊搜索 MCP Server。

test
typestring

MCP Server 类型

RealMCP
pageNumberinteger

分页页码,从 1 开始,不填默认 1。

1
pageSizeinteger

每页大小,默认 10

10
createFromTypesstring

创建来源类型

ApiGatewayHttpToMCP
deployStatusesstring

MCP Server 的部署状态。

Deployed

返回参数

名称类型描述示例值
object

Schema of Response

requestIdstring

Id of the request

585657D2-1C20-5B8A-AF17-D727C6490BE4
codestring

响应状态码。

Ok
messagestring

响应消息。

success
dataobject

响应数据。

pageNumberinteger

分页页码。

1
pageSizeinteger

分页大小。

10
totalSizeinteger

总数量。

25
itemsarray<object>

MCP Server 列表信息。

itemsobject

服务信息。

mcpServerPathstring

网关提供的 MCP Server 访问路径

/mcp-servers/test-mcp
mcpServerConfigstring

HTTP 转 MCP Config

HTTPMCP Config base64
matchHttpRouteMatch

路由 Match 规则。

descriptionstring

描述。

这是xxxxx项目测试环境
typestring

MCP Server 类型

可选值:RealMCP、AssemblyMCP
createFromTypestring

创建来源类型

ApiGatewayHttpToMCP 网关托管 HTTP 转 MCP ApiGatewayMcpHosting 网关托管 MCP 直接代理 ApiGatewayAssembly 网关 MCP 组装 NacosHttpToMCP 网关托管 NACOS 同步 HTTP 转 MCP NacosMcpHosting 网关托管 NACOS 同步 MCP 直接代理

ApiGatewayHttpToMCP
domainIdsarray

域名 ID 列表。

domainIdsstring

域名 ID 列表。

d-faefqfargz
protocolstring

服务协议

HTTP
environmentIdstring

环境 id。

env-cq7l5s5lhtgi6qasrdc0
routeIdstring

MCP Server 关联路由 ID

hr-d11cj86m1hkvop6mp42g
mcpStatisticsEnableboolean

是否启用 MCP 可观测,默认 false

false
namestring

MCP Server 名称

itemcenter-dev-cluster
exposedUriPathstring

暴露的 URI 路径,当 protocol 为 SSE 或 StreamableHTTP 且 type 为 RealMCP 时必填

/sse
assembledSourcesarray<object>

组装源列表,当 type 为 AssemblyMCP 时必填

assembledSourcesobject

组装源列表,当 type 为 AssemblyMCP 时必填

mcpServerNamestring

MCP Server 名称

test-mcp
mcpServerIdstring

MCP Server ID

mcp-adfef2334fa
toolsarray

MCP 工具列表

toolsstring

MCP 工具列表

tool-1
backendBackend

路由的后端服务。

mcpServerIdstring

MCP Server ID

mcp-feaff34va
nacosMcpSyncInfoobject

Nacos 同步托管 MCP 信息

importMcpServerIdstring

同步的 MCP Server ID

同步的MCP Server ID
importNamespacestring

Nacos 命名空间

test-ns
importInstanceIdstring

Nacos 实例

mse-faefrefxz
gatewayIdstring

网关实例 ID

gw-cpv54p5***
domainInfosarray

域名信息列表

domainInfosHttpApiDomainInfo

域名信息列表

deployStatusstring

API 在当前环境的发布状态

Deployed

示例

正常返回示例

JSON格式

{
  "requestId": "585657D2-1C20-5B8A-AF17-D727C6490BE4",
  "code": "Ok",
  "message": "success",
  "data": {
    "pageNumber": 1,
    "pageSize": 10,
    "totalSize": 25,
    "items": [
      {
        "mcpServerPath": "/mcp-servers/test-mcp",
        "mcpServerConfig": "HTTPMCP Config base64值",
        "match": {
          "ignoreUriCase": true,
          "path": {
            "type": "Prefix",
            "value": "/user"
          },
          "headers": [
            {
              "type": "Exact",
              "name": "dev",
              "value": true
            }
          ],
          "methods": [
            "GET"
          ],
          "queryParams": [
            {
              "type": "Exact",
              "name": "age",
              "value": 17
            }
          ]
        },
        "description": "这是xxxxx项目测试环境",
        "type": "可选值:RealMCP、AssemblyMCP",
        "createFromType": "ApiGatewayHttpToMCP",
        "domainIds": [
          "d-faefqfargz"
        ],
        "protocol": "HTTP",
        "environmentId": "env-cq7l5s5lhtgi6qasrdc0",
        "routeId": "hr-d11cj86m1hkvop6mp42g",
        "mcpStatisticsEnable": false,
        "name": "itemcenter-dev-cluster",
        "exposedUriPath": "/sse",
        "assembledSources": [
          {
            "mcpServerName": "test-mcp",
            "mcpServerId": "mcp-adfef2334fa",
            "tools": [
              "tool-1"
            ]
          }
        ],
        "backend": {
          "scene": "Single",
          "services": [
            {
              "serviceId": "service-cq2bmmdlhtgj***",
              "name": "item-service",
              "protocol": "HTTP",
              "port": 0,
              "weight": 49,
              "version": "v1"
            }
          ]
        },
        "mcpServerId": "mcp-feaff34va",
        "nacosMcpSyncInfo": {
          "importMcpServerId": "同步的MCP Server ID\n\n",
          "importNamespace": "test-ns",
          "importInstanceId": "mse-faefrefxz"
        },
        "gatewayId": "gw-cpv54p5***",
        "domainInfos": [
          {
            "domainId": "d-xxx",
            "name": "www.example.com",
            "protocol": "HTTP"
          }
        ],
        "deployStatus": "Deployed",
        "apiId": ""
      }
    ]
  }
}

错误码

访问错误中心查看更多错误码。