GetNacosMcpServer - Microservices Engine - Alibaba Cloud Documentation Center

Retrieves the details of an MCP Server.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

mse:GetNacosMcpServer

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	mse_prepaid_public_cn-tl327w****
NamespaceId	string	No	The namespace ID.	5e3ee449-b5c0-4aee-b857-32c0acbebf26
McpServerId	string	No	The ID of the MCP Server.	5e3c5211-d365-4013-8540-c4106ec2a5dc
McpServerVersion	string	No	The version of the MCP Server.	1.0.0
AcceptLanguage	string	No	The language of the returned results. Valid values: zh (default): Chinese, en: English.	zh

Response elements

Element	Type	Description	Example
	object	RestResult
RequestId	string	The request ID.	72FC625E-9629-591B-9C01-3F0BFDAB****
Data	object	The returned data.
RemoteServerConfig	object	The remote server configuration.
ServiceRef	object
NamespaceId	string		public
GroupName	string		DEFAULT
ServiceName	string		mcp-service
ExportPath	string		/sse
LocalServerConfig	object	The configuration of the local MCP Server.
	any	The specific local server configuration.	{ "mcpServers": { "amap-mcp-server": { "description": "Amap map service", "command": "npx", "args": [ "-y", "@amap/amap-maps-mcp-server" ], "env": { "AMAP_MAPS_API_KEY": "" } } } }
BackendEndpoints	array<object>	The backend service endpoints.
	object
Address	string		127.0.0.1
Port	integer		80
Path	string		/sse
ToolSpec	object	The tool specification.
Tools	array<object>
	array<object>
Name	string		get_weather
Description	string		a weather query tool
InputSchema	object
	any		{"type":"object","properties":{"name":{"type":"string","description":"name"}}}
ToolsMeta	object
	object
Enabled	boolean		true
Templates	object
	any		{"requestTemplate":{"url":"https://api.example.com/endpoint/{{.args.NewArg1}}","method":"GET","headers":[{"key":"Authorization","value":"Bearer {{.security.token}}"}]},"responseTemplate":{"body":"{{.}}"},"argsPosition":{"NewArg1":"path"}}
SpecificationType	string
SecuritySchemes	any
ToolDecryptStatus	string
AllVersions	array<object>	All version information of the current MCP Server.
	object
Version	string		1.0.9
Release_date	string		2025-07-16
Is_latest	boolean		true
Enabled	boolean	Indicates whether the gateway is enabled. Valid values: true: Enabled. false: Disabled.	true
Id	string	ID。	5e3c5211-d365-4013-8540-c4106ec2a5dc
Name	string	The name.	mcp-demo
Description	string	The description.	Description.
Protocol	string	The protocol.	mcp-sse
FrontProtocol	string	The externally exposed protocol type.	mcp-sse
Capabilities	array	The capabilities of the current MCP Server.
	string	The capability description.	TOOL
VersionDetail	object	The version details.
Version	string		1.11.0
ReleaseDate	string		2025-07-16
IsLatest	boolean		true
YamlConfig	string	The YAML configuration of the AI gateway.	allowTools: - demo-tool securityScheme: {} server: name: mcp-demo tools: - args: - name: name description: name type: string description: a demo tool name: demo-tool

Examples

Success response

JSON format

{
  "RequestId": "72FC625E-9629-591B-9C01-3F0BFDAB****",
  "Data": {
    "RemoteServerConfig": {
      "ServiceRef": {
        "NamespaceId": "public",
        "GroupName": "DEFAULT",
        "ServiceName": "mcp-service"
      },
      "ExportPath": "/sse"
    },
    "LocalServerConfig": {
      "key": "{\n    \"mcpServers\":\n    {\n        \"amap-mcp-server\":\n        {\n            \"description\": \"高德地图服务\",\n            \"command\": \"npx\",\n            \"args\":\n            [\n                \"-y\",\n                \"@amap/amap-maps-mcp-server\"\n            ],\n            \"env\":\n            {\n                \"AMAP_MAPS_API_KEY\": \"\"\n            }\n        }\n    }\n}\n"
    },
    "BackendEndpoints": [
      {
        "Address": "127.0.0.1",
        "Port": 80,
        "Path": "/sse"
      }
    ],
    "ToolSpec": {
      "Tools": [
        {
          "Name": "get_weather",
          "Description": "a weather query tool",
          "InputSchema": {
            "key": "{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"name\"}}}"
          }
        }
      ],
      "ToolsMeta": {
        "key": {
          "Enabled": true,
          "Templates": {
            "key": "{\"requestTemplate\":{\"url\":\"https://api.example.com/endpoint/{{.args.NewArg1}}\",\"method\":\"GET\",\"headers\":[{\"key\":\"Authorization\",\"value\":\"Bearer {{.security.token}}\"}]},\"responseTemplate\":{\"body\":\"{{.}}\"},\"argsPosition\":{\"NewArg1\":\"path\"}}"
          }
        }
      },
      "SpecificationType": "",
      "SecuritySchemes": "",
      "ToolDecryptStatus": ""
    },
    "AllVersions": [
      {
        "Version": "1.0.9",
        "Release_date": "2025-07-16\n",
        "Is_latest": true
      }
    ],
    "Enabled": true,
    "Id": "5e3c5211-d365-4013-8540-c4106ec2a5dc",
    "Name": "mcp-demo",
    "Description": "描述",
    "Protocol": "mcp-sse",
    "FrontProtocol": "mcp-sse",
    "Capabilities": [
      "TOOL"
    ],
    "VersionDetail": {
      "Version": "1.11.0",
      "ReleaseDate": "2025-07-16",
      "IsLatest": true
    },
    "YamlConfig": "allowTools:\n- demo-tool\nsecurityScheme: {}\nserver:\n  name: mcp-demo\ntools:\n- args:\n  - name: name\n    description: name\n    type: string\n  description: a demo tool\n  name: demo-tool\n"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.