GetApiMcpServer-阿里云帮助中心

Retrieves 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	API MCP service ID.	v6ZZ7ftCzEILW***

Response elements

Element	Type	Description	Example
	object	Response result.
requestId	string	Request ID.	9BFC4AC1-6BE4-5405-BDEC-CA288D404812
id	string	API MCP service ID.	v6ZZ7ftCzEILW***
description	string	Description of the API MCP server.	这是一个API MCP 服务器
apis	array<object>	List of API information.
	object	API information.
product	string	Product code. Call the GetRequestLog operation and obtain the product code from the response. Find the product code from the OpenAPI portal URL. For example, the OpenAPI portal URL for Short Message Service is https://api.aliyun.com/product/Dysmsapi. The product code for Short Message Service is Dysmsapi.	Ecs
apiVersion	string	The POP version to which the API exposed to the MCP server belongs.	2014-05-26
selectors	array	List of API name matching rules.
	string	API name matching rule.	*Bucket
additionalApiDescriptions	array<object>	List of additional API description information.
	array<object>	Additional API description information.
apiVersion	string	The POP version to which the API exposed to the MCP server belongs.	2014-05-26
product	string	Product code. Call the GetRequestLog operation and obtain the product code from the response. Find the product code from the OpenAPI portal URL. For example, the OpenAPI portal URL for Short Message Service is https://api.aliyun.com/product/Dysmsapi. The product code for Short Message Service is Dysmsapi.	Ecs
apiName	string	API name.	DescribeRegions
apiOverrideJson	string	API metadata in JSON format. See the format at https://api.aliyun.com/meta/v1/products/Ecs/versions/2014-05-26/apis/DescribeInstances/api.json. You can override the summary and parameters fields.	{ "summary": "本接口支持根据不同请求条件查询实例列表，并关联查询实例的详细信息。" }
executeCliCommand	boolean	Indicates whether to return the CLI execution 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 and must be used with Alibaba Cloud CLI.	true
enableOutputSchema	boolean	Indicates whether to return the output parameter schema. Returning the output schema increases the overall size of the API MCP server. The default value is null, which means the output schema is not returned.	true
toolAlias	string	Tool alias. You can customize the name, such as list_ecs_regions. The alias can contain letters, digits, hyphens (-), and underscores (_). Aliases must be unique.	list_ecs_regions
constParameters	array<object>	List of constant input parameters. These parameters are excluded during API parameter parsing.
	object	Constant input parameter.
key	string	Parameter name. Only top-level parameter names are supported. For ROA-style APIs, you can specify body.xx. Values beyond top-level parameters are not allowed.	InstanceId
value	any	Parameter value.	1234
createTime	string	Creation time of the API MCP server.	2025-02-07T02:17:46Z
updateTime	string	Modification time of the API MCP server.	2025-02-05T02:26:04Z
prompts	array<object>	List of prompt configurations.
	array<object>	Prompt configuration.
name	string	Prompt name.	test
description	string	Description.	prompt description
content	string	Prompt content. Variables are specified in the {{xxx}} format, where xxx is a variable that must be defined in the arguments parameter.	prompt正文，{{name}}
arguments	array<object>	List of supported prompt parameters.
	object	Supported prompt parameter.
name	string	Parameter name.	test
description	string	Parameter description.	argument description
required	boolean	Indicates whether the parameter is required.
language	string	Documentation language for the API MCP service. You can choose between Chinese or English API documentation. Different languages may affect how the AI responds to prompts. Valid values: EN_US : EN_US ZH_CN : ZH_CN	ZH_CN
urls	object	MCP server connection information.
sse	string	SSE protocol connection information.	https://openapi-mcp.cn-hangzhou.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/sse
vpcSse	string	SSE protocol endpoint within a VPC.	https://openapi-mcp-cn.vpc-proxy.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/sse
mcp	string	Streamable HTTP protocol connection information. We recommend using this option.	https://openapi-mcp.cn-hangzhou.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/mcp
vpcMcp	string	Streamable HTTP protocol endpoint within a VPC.	https://openapi-mcp-cn.vpc-proxy.aliyuncs.com/accounts/xxxx/custom/xxx/id/xxxx/mcp
systemTools	array	List of system tools.
	string	System tool name.	FetchRamActionDetails
name	string	MCP server name. The name must be 3 to 64 characters long, consist of lowercase letters and digits, and cannot start with a digit. The name must be unique within the same Alibaba Cloud account.	mcp-demo
requiredRAMPolicy	string	RAM access policy required for this API MCP service.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "ecs:Describe", "vpc:Describe", "vpc:List" ], "Resource": "" } ] }
apiInfos	array<object>	List of API information for the API MCP service.
	object	API information for the API MCP service.
product	string	Product code. Call the GetRequestLog operation and obtain the product code from the response. Find the product code from the OpenAPI portal URL. For example, the OpenAPI portal URL for Short Message Service is https://api.aliyun.com/product/Dysmsapi. The product code for Short Message Service is Dysmsapi.	Ecs
apiVersion	string	The POP version to which the API exposed to the MCP server belongs.	2014-05-26
apiName	string	API name.	DescribeRegions
sourceType	string	Type of API MCP service. custom: Custom service system: System service	system
systemMcpServerInfo	object	List of system MCP services.
product	string	Product code. Call the GetRequestLog operation and obtain the product code from the response. Find the product code from the OpenAPI portal URL. For example, the OpenAPI portal URL for Short Message Service is https://api.aliyun.com/product/Dysmsapi. The product code for Short Message Service is Dysmsapi.	Ecs
name	string	System MCP service name.	mcp-system
oauthClientId	string	Custom OAuth client ID when using custom OAuth configuration. `Applies only to web/native applications, and the OAuth scope must include /acs/mcp-server.`	403*************370
terraformTools	array<object>	List of Terraform tools.
	object	Terraform tool.
code	string	Terraform tool code. Overview of HCL language	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	Terraform tool name.	test
description	string	Terraform tool description.	Terraform Tool description
async	boolean	Indicates whether execution is asynchronous. If enabled, the system immediately processes the next task without waiting for each resource operation to complete.	true
destroyPolicy	string	Cleanup policy for temporary resources after task execution. The system applies one of the following policies based on the task execution status: NEVER: Do not delete resources, regardless of whether the task succeeds or fails. ALWAYS: Always delete all related resources immediately after task completion, regardless of success or failure. ON_FAILURE: Delete resources only if the task fails. Keep resources if the task succeeds. Valid values: ON_FAILURE : ON_FAILURE NEVER : NEVER ALWAYS : ALWAYS	ON_FAILURE
instructions	string	MCP instructions that guide the large language model on how to use this MCP. Clients must support the Instructions field in the standard MCP protocol.	test
enableAssumeRole	boolean	Indicates whether multi-account access is enabled.	true
assumeRoleName	string	Name of the RAM role in the destination account to assume when performing cross-account operations with multi-account access enabled.	test
assumeRoleExtraPolicy	string	Additional policy for role assumption when multi-account access is enabled. If specified, this policy overrides the permissions defined in the role itself.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "ecs:Describe", "vpc:Describe", "vpc:List" ], "Resource": "" } ] }
publicAccess	string	Indicates whether public network access is enabled.	on
enableCustomVpcWhitelist	boolean	Indicates whether a custom VPC whitelist is enabled. If disabled, the account-level configuration applies.	true
vpcWhitelists	array	VPC whitelist that restricts traffic sources when public network access is disabled. If not set or empty, no source restrictions apply.
	string	Each entry in the VPC whitelist specifies a 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.