GetApiMcpServer-OpenAPI Explorer(OpenAPI)-阿里云帮助中心

Queries the details of an API MCP service.

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

openapiexplorer:GetApiMcpServer

get

*ApiMcpServer

acs:openapiexplorer::{#accountId}:apimcpserver/{#id}

None

Request syntax

GET /apimcpserver HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
id	string	Yes	The API MCP service ID.	v6ZZ7ftCzEILW***

Response elements

Element	Type	Description	Example
	object	The request result.
requestId	string	The request ID.	9BFC4AC1-6BE4-5405-BDEC-CA288D404812
id	string	The API MCP service ID.	v6ZZ7ftCzEILW***
description	string	The description of the API MCP server.	This is an API MCP server.
apis	array<object>	The list of API information.
	object	The API information.
product	string	The product code.	Ecs
apiVersion	string	The POP version to which the API exposed to the MCP SERVER belongs.	2014-05-26
selectors	array	The list of API name matching rules.
	string	The API name matching rule.	*Bucket
additionalApiDescriptions	array<object>	The list of supplementary API descriptions.
	array<object>	The supplementary API description.
apiVersion	string	The POP version to which the API exposed to the MCP SERVER belongs.	2014-05-26
product	string	The product code.	Ecs
apiName	string	The API name.	DescribeRegions
apiOverrideJson	string	The API metadata in JSON format. For the reference format, see https://api.aliyun.com/meta/v1/products/Ecs/versions/2014-05-26/apis/DescribeInstances/api.json. You can override the summary and parameters fields.	{
executeCliCommand	boolean	Specifies whether to return the CLI execute command. In this mode, the API call is not actually executed. Instead, the corresponding CLI command is returned. This is suitable for long-running tasks that require Alibaba Cloud CLI to execute.	true
enableOutputSchema	boolean	Specifies whether to return the output parameter schema. Returning the output parameter schema increases the overall size of the API MCP SERVER. The default value is null, which indicates that the output parameter schema is not returned.	true
toolAlias	string	The tool alias. You can set a custom name, such as list_ecs_regions. The alias can contain letters, digits, hyphens (-), and underscores (_). Duplicate aliases are not allowed.	list_ecs_regions
constParameters	array<object>	The list of constant parameters. These parameters are not included in the output during API parameter parsing.
	object	The constant parameter.
key	string	The parameter name. Only top-level parameter names are supported. For ROA-style APIs, you can set the parameter to body.xx. Values beyond top-level parameters are not allowed.	InstanceId
value	any	The value of the parameter.	1234
createTime	string	The time when the API MCP server was created. The time is in the ISO 8601 standard in UTC. Format: YYYY-MM-DDTHH:mm:ssZ.	2025-02-07T02:17:46Z
updateTime	string	The time when the API MCP server was last updated. The time is in the ISO 8601 standard in UTC. Format: YYYY-MM-DDTHH:mm:ssZ.	2025-02-05T02:26:04Z
prompts	array<object>	The list of prompt configurations.
	array<object>	The prompt configuration.
name	string	The prompt name.	test
description	string	The description.	prompt description
content	string	The content of the prompt. Variables are specified in the {{xxx}} format. xxx is a variable that must be defined in the arguments parameter.	Prompt body, {{name}}
arguments	array<object>	The list of parameters supported by the prompt.
	object	The parameter supported by the prompt.
name	string	The parameter name.	test
description	string	The description of the parameter.	argument description
required	boolean	Indicates whether the parameter is required.
language	string	The documentation language of the API MCP service. Chinese or English API documentation can be selected. Different languages may produce varying results in AI responses. Valid values: EN_US : EN_US ZH_CN : ZH_CN	ZH_CN
urls	object	The MCP SERVER connection information.
sse	string	The SSE protocol connection information.	https://openapi-mcp.cn-hangzhou.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/sse
vpcSse	string	The SSE protocol endpoint within a VPC.	https://openapi-mcp-cn.vpc-proxy.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/sse
mcp	string	The streamable HTTP protocol connection information. This is the recommended option.	https://openapi-mcp.cn-hangzhou.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/mcp
vpcMcp	string	The streamable HTTP protocol endpoint within a VPC.	https://openapi-mcp-cn.vpc-proxy.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/mcp
systemTools	array	The list of system tools.
	string	The system tool name.	FetchRamActionDetails
name	string	The MCP SERVER name. The name consists of lowercase letters (a-z) and digits (0-9), is 3 to 64 characters in length, does not start with a digit, and must be unique within the same Alibaba Cloud account.	mcp-demo
requiredRAMPolicy	string	The RAM access policy required by the API MCP service.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "ecs:Describe", "vpc:Describe", "vpc:List" ], "Resource": "" } ] }
apiInfos	array<object>	The list of API information for the API MCP service.
	object	The API information for the API MCP service.
product	string	The product code.	Ecs
apiVersion	string	The POP version to which the API exposed to the MCP SERVER belongs.	2014-05-26
apiName	string	The API name.	DescribeRegions
sourceType	string	The API MCP service type.	system
systemMcpServerInfo	object	The system MCP service information.
product	string	The product code.	Ecs
name	string	The system MCP service name.	mcp-system
oauthClientId	string	The custom OAuth Client ID used when a custom OAuth configuration is selected.	403*************370
terraformTools	array<object>	The list of Terraform tools.
	object	Terraform Tool。
code	string	The Terraform tool code. HCL language overview	variable "name" { default = "terraform-example" } provider "alicloud" { region = "cn-beijing" } resource "alicloud_vpc" "default" { ipv6_isp = "BGP" description = "test" cidr_block = "10.0.0.0/8" vpc_name = var.name enable_ipv6 = true }
name	string	The Terraform tool name.	test
description	string	The Terraform tool description.	Terraform Tool description
async	boolean	Specifies whether the execution is asynchronous. When enabled, the system proceeds to the next task immediately after initiating a task, without waiting for each resource operation to complete.	true
destroyPolicy	string	The deletion policy. After a task is completed, the system applies the following cleanup policies to temporary resources based on the task execution status. Valid values: ON_FAILURE : ON_FAILURE NEVER : NEVER ALWAYS : ALWAYS	ON_FAILURE
instructions	string	The MCP instructions that guide the large language model on how to use this MCP. The client must support the Instructions field in the MCP standard protocol.	test
enableAssumeRole	boolean	Specifies whether multi-account access is enabled.	true
assumeRoleName	string	The name of the RAM role to be assumed in the target account when multi-account access is enabled for cross-account operations.	test
assumeRoleExtraPolicy	string	The additional policy for role assumption when multi-account access is enabled. When this policy is specified, the permissions for role assumption are based on this value, overriding the permissions defined in the role itself.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "ecs:Describe", "vpc:Describe", "vpc:List" ], "Resource": "" } ] }
publicAccess	string	Specifies whether public network access is enabled. Valid values: follow : follows the account-level public network access configuration. off : disables public network access. on : enables public network access.	on
enableCustomVpcWhitelist	boolean	Specifies whether to enable the custom VPC whitelist. If not enabled, the account-level configuration is used.	true
vpcWhitelists	array	The VPC whitelist that restricts the source after public network access is disabled. If not set or empty, no source restriction is applied.
	string	The VPC whitelist entry. The value is the source VPC ID.	vpc-j6cgd2if5lg**0xs6m5se

Examples

Success response

JSON format

{
  "requestId": "\t\n9BFC4AC1-6BE4-5405-BDEC-CA288D404812\n",
  "id": "v6ZZ7ftCzEILW***",
  "description": "这是一个API MCP 服务器",
  "apis": [
    {
      "product": "Ecs",
      "apiVersion": "2014-05-26",
      "selectors": [
        "*Bucket"
      ]
    }
  ],
  "additionalApiDescriptions": [
    {
      "apiVersion": "2014-05-26",
      "product": "Ecs",
      "apiName": "DescribeRegions",
      "apiOverrideJson": "{\n  \"summary\": \"本接口支持根据不同请求条件查询实例列表，并关联查询实例的详细信息。\"\n}",
      "executeCliCommand": true,
      "enableOutputSchema": true,
      "toolAlias": "list_ecs_regions",
      "constParameters": [
        {
          "key": "InstanceId",
          "value": "1234"
        }
      ]
    }
  ],
  "createTime": "2025-02-07T02:17:46Z",
  "updateTime": "2025-02-05T02:26:04Z",
  "prompts": [
    {
      "name": "test",
      "description": "prompt description",
      "content": "prompt正文，{{name}}",
      "arguments": [
        {
          "name": "test",
          "description": "argument description",
          "required": false
        }
      ]
    }
  ],
  "language": "ZH_CN",
  "urls": {
    "sse": "https://openapi-mcp.cn-hangzhou.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/sse",
    "vpcSse": "https://openapi-mcp-cn.vpc-proxy.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/sse",
    "mcp": "https://openapi-mcp.cn-hangzhou.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/mcp",
    "vpcMcp": "https://openapi-mcp-cn.vpc-proxy.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/mcp"
  },
  "systemTools": [
    "FetchRamActionDetails"
  ],
  "name": "mcp-demo",
  "requiredRAMPolicy": "{\n  \"Version\": \"1\",\n  \"Statement\": [\n    {\n      \"Effect\": \"Allow\",\n      \"Action\": [\n        \"ecs:Describe*\",\n        \"vpc:Describe*\",\n        \"vpc:List*\"\n      ],\n      \"Resource\": \"*\"\n    }\n  ]\n}",
  "apiInfos": [
    {
      "product": "Ecs",
      "apiVersion": "2014-05-26",
      "apiName": "DescribeRegions"
    }
  ],
  "sourceType": "system",
  "systemMcpServerInfo": {
    "product": "Ecs",
    "name": "mcp-system"
  },
  "oauthClientId": "403*************370",
  "terraformTools": [
    {
      "code": "variable \"name\" {\n  default = \"terraform-example\"\n}\n\nprovider \"alicloud\" {\n  region = \"cn-beijing\"\n}\n\nresource \"alicloud_vpc\" \"default\" {\n  ipv6_isp    = \"BGP\"\n  description = \"test\"\n  cidr_block  = \"10.0.0.0/8\"\n  vpc_name    = var.name\n  enable_ipv6 = true\n}",
      "name": "test",
      "description": "Terraform Tool description",
      "async": true,
      "destroyPolicy": "ON_FAILURE"
    }
  ],
  "instructions": "test",
  "enableAssumeRole": true,
  "assumeRoleName": "test",
  "assumeRoleExtraPolicy": "{\n  \"Version\": \"1\",\n  \"Statement\": [\n    {\n      \"Effect\": \"Allow\",\n      \"Action\": [\n        \"ecs:Describe*\",\n        \"vpc:Describe*\",\n        \"vpc:List*\"\n      ],\n      \"Resource\": \"*\"\n    }\n  ]\n}",
  "publicAccess": "on",
  "enableCustomVpcWhitelist": true,
  "vpcWhitelists": [
    "vpc-j6cgd2if5lg**0xs6m5se"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Missing.Id	Id is mandatory for this action.
500	InternalServerError	The request has failed due to a temporary failure of the server.
404	NotFound.ApiMcpServer	Specified MCP server not found.	The MCP service with the specified ID does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.