All Products
Search
Document Center

API Gateway:SyncMCPServers

Last Updated:Dec 26, 2025

Synchronizes Nacos Model Context Protocol (MCP) server configurations to Cloud-native API Gateway.

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:SyncMCPServersnone
*All Resources
*
    none
none

Request syntax

POST /v1/mcp-servers/sync-mcp-server HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
bodyobjectNo

The request body.

gatewayIdstringNo

The ID of the gateway.

gw-cq7l5s5lhtg***
domainIdsarrayNo

The domain ID.

stringNo

The domain ID.

d-cr62ts5lhtglnu***
sourceIdstringNo

The source ID.

src-d40mff6m1hkpt84vep60
namespacestringNo

The Nacos namespace.

default
nacosMcpServersarray<object>No

The synchronized Nacos MCP server list. If the synchronized MCP server is included, add the mcpServerId parameter.

objectNo
instanceIdstringNo

The Nacos instance ID.

mse-24afmoioxxx
exposedUriPathstringNo

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
mcpServerNamestringNo

The name of the MCP server.

test
protocolsarrayNo

The protocol.

stringNo

The protocol.

Valid values:

  • SSE
  • HTTPS
  • StreamableHTTP
  • HTTP
SSE
mcpServerIdstringNo

The MCP server ID.

mcp-d3s8qo6m1hknegofa3bg

Response parameters

ParameterTypeDescriptionExample
object

The response schema.

requestIdstring

The request ID.

2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C
codestring

The status code.

Ok
messagestring

The response message.

success
dataobject

The response data.

succeedMcpServersarray<object>

The list of MCP servers successfully synchronized.

succeedMcpServersobject
mcpServerNamestring

The name of the MCP server.

mcp-success
protocolsarray

The protocol.

protocolsstring

The protocol.

SSE
failedMcpServersarray<object>

The list of MCP servers that failed to synchronize.

failedMcpServersobject
mcpServerNamestring

The name of the MCP server.

mcp-fail
protocolsarray

The protocol.

protocolsstring

The protocol.

SSE

Examples

Sample success responses

JSONformat

{
  "requestId": "2F46B9E7-67EF-5C8A-BA52-D38D5B32AF2C",
  "code": "Ok",
  "message": "success",
  "data": {
    "succeedMcpServers": [
      {
        "mcpServerName": "mcp-success",
        "protocols": [
          "SSE"
        ]
      }
    ],
    "failedMcpServers": [
      {
        "mcpServerName": "mcp-fail",
        "protocols": [
          "SSE"
        ]
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2025-12-25Add OperationView Change Details