UpdateApiMcpServer-阿里云帮助中心

Modify an API 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

openapiexplorer:UpdateApiMcpServer

update

*ApiMcpServer

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

None

Request syntax

PATCH /apimcpserver HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
clientToken	string	No	Ensure request idempotence. Generate a unique value from your client for this parameter to guarantee uniqueness across different requests. ClientToken supports only ASCII characters, must not exceed 64 characters, and UUID is recommended. The time-to-live (TTL) is 3 days.	123e4567-e89b-12d3-a456-426655440000
id	string	Yes	The ID of the API MCP Server.	v6ZZ7ftCzEILW***
body	object	No	The request body.
description	string	No	The description of the API MCP Server.	这是一个API MCP服务器。
apis	array<object>	No	The list of APIs to modify.
	object	No	API information.
product	string	No	The product code. Call the GetRequestLog API 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	No	The POP version of the API exposed to the MCP Server.	2014-05-26
selectors	array	No	The list of API name matching rules.
	string	No	An API name matching rule.	*Bucket
additionalApiDescriptions	array<object>	No	The list of additional API description information.
	array<object>	No	Additional API description information.
product	string	No	The product code. Call the GetRequestLog API 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	No	The POP version of the API exposed to the MCP Server.	2014-05-26
apiName	string	No	The API name.	DescribeRegions
apiOverrideJson	string	No	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	No	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 requires using Alibaba Cloud CLI to execute the command.	true
enableOutputSchema	boolean	No	Indicates whether to return the response parameter schema. Returning the response schema increases the overall size of the API MCP Server. The default value is null, which means the response schema is not returned.	true
toolAlias	string	No	The tool alias. Change it to a custom name such as list_ecs_regions. It can contain only letters, digits, hyphens (-), and underscores (_). Duplicate aliases are not allowed.	list_ecs_regions
constParameters	array<object>	No	The list of constant request parameters. These parameters are excluded from output during API parameter parsing.
	object	No	A constant request parameter.
key	string	No	The parameter name. Only top-level parameter names are supported. For ROA-style APIs, you can set values like body.xx. Values beyond top-level parameters are not allowed.	InstanceId
value	any	No	The parameter value.	1234
prompts	array<object>	No	The list of prompt configurations.
	array<object>	No	A prompt configuration.
name	string	No	The prompt name.	test
description	string	No	The description.	prompt description
content	string	No	The prompt content. Variables are specified in the {{xxx}} format. xxx represents a variable that must be defined in the arguments parameter.	prompt正文，{{name}}
arguments	array<object>	No	The list of supported prompt parameters.
	object	No	A supported prompt parameter.
name	string	No	The parameter name.	test
description	string	No	The parameter description.	argument description
required	boolean	No	Indicates whether the parameter is required.	true
language	string	No	The documentation language of the API MCP Server. You can choose between Chinese or English API documentation. Different languages may affect the Large Language Model (LLM) response quality.	ZH_CN
systemTools	array	No	The list of system tools.
	string	No	The system tool name.	FetchRamActionDetails
oauthClientId	string	No	The custom OAuth Client ID when using a custom OAuth configuration. `Only Web/Native applications are supported, and the OAuth scope must include /acs/mcp-server`	403*************370
instructions	string	No	The MCP instruction used to guide the Large Language Model (LLM) on how to use this MCP. The client must support the Instructions field in the standard MCP protocol.	test
enableAssumeRole	boolean	No	Indicates whether to enable multi-account access.	true
assumeRoleName	string	No	The RAM role name of the destination account when enabling multi-account access for cross-account operations.	test
assumeRoleExtraPolicy	string	No	The additional policy for role assumption when enabling multi-account access. If this policy exists, the permissions for role assumption are determined by this policy, overriding the role's original permissions.	{ "Version": "1", "Statement": [ { "Effect": "Allow", "Action": [ "ecs:Describe", "vpc:Describe", "vpc:List" ], "Resource": "" } ] }
publicAccess	string	No	Indicates whether to enable public network access.	on
enableCustomVpcWhitelist	boolean	No	Indicates whether to enable a custom VPC whitelist. If disabled, the account-level configuration applies.	true
terraformTools	array<object>	No	The list of Terraform Tools.
	object	No	A Terraform Tool.
code	string	No	The 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	No	The Terraform Tool name.	test
description	string	No	The Terraform Tool description.	Terraform Tool description
async	boolean	No	Indicates whether to execute asynchronously. After initiating a task, the system immediately processes the next task without waiting for each resource operation to complete.	true
destroyPolicy	string	No	The deletion policy. After task execution, the system cleans up temporary resources based on the task status as follows: NEVER: Do not delete any created resources, regardless of task success or failure. ALWAYS: Immediately destroy all related resources after task completion, regardless of success or failure. ON_FAILURE: Delete related resources only if the task fails. Retain resources if the task succeeds.	ON_FAILURE
vpcWhitelists	array	No	The VPC whitelist that restricts source traffic after disabling public network access. If not set or empty, no source restrictions apply.
	string	No	Each restricted VPC whitelist entry. The value is the source VPC ID.	vpc-j6cgd2if5lg**0xs6m5se

Response elements

Element	Type	Description	Example
	object	The request result.
requestId	string	The request ID.	9BFC4AC1-6BE4-5405-BDEC-CA288D404812

Examples

Success response

JSON format

{
  "requestId": "\t\n9BFC4AC1-6BE4-5405-BDEC-CA288D404812\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Missing.Id	Id is mandatory for this action.
400	Missing.Apis.PopCode	Apis.PopCode is mandatory for this action.	The required parameter popCode is missing in the Apis parameter.
400	Missing.Apis.PopVersion	Apis.PopVersion is mandatory for this action.	Apis.PopVersion is mandatory for this action.
400	InvalidParam.Apis.PopVersion	Unsupported product version: %s of product code: %s.	Product% s does not support xxx version.
400	InvalidParam.Apis.PopCode	Unsupported product code: %s.	The specified product name does not exist
400	Missing.Apis.Selectors	Apis.Selectors is mandatory for this action.	Apis.Selectors is a required parameter
400	InvalidParam.Language	Unsupported language: %s.	Specify multilingual wu'xi
400	InvalidParam.AdditionalApiDescription.PopVersion	Unsupported product version: %s of product code: %s.	Product% s does not support version% s.
400	InvalidParam.AdditionalApiDescription.PopCode	Unsupported product code: %s.	The specified product does not exist
400	InvalidParam.SystemTools	System tool %s is not supported.
400	Missing.TerraformTools.Description	TerraformTools.Description is mandatory for this action.	Missing required parameter TerraformTools.Description
400	Missing.TerraformTools.Code	TerraformTools.Code is mandatory for this action.	The required parameter TerraformTools.Code is missing.
400	IdempotentParameterMismatch	The request uses the same client token as a previous request but with different parameters. Client tokens should not be reused across non-identical requests. Each unique request must have a distinct client token.	The request used the same client token as the previous request, but with different parameters. Do not reuse the same token in requests with different parameters. Each request must use a unique token.
400	InvalidParam.TerraformTools.Name	TerraformTools.Name: %s must be 3 to 64 characters long and can only contain lowercase letters, numbers, underscores, and hyphens.	The Terraform tool name must be 3 to 63 characters in length and can contain only lowercase letters, numbers, underscores, and hyphens.
400	Missing.TerraformTools.Name	TerraformTools.Name is mandatory for this action.
400	InvalidParam.TerraformTools.Code	The Terraform tool code is not valid: %s. Please check the syntax and try again.	The specified TerraformTools.Code parameter is invalid.
400	InvalidParam.ClientToken	The specified client token is not valid.	The idempotent parameter is incorrect, please check.
400	InvalidParam.AdditionalApiDescription.ToolAlias	ToolAlias '%s' is invalid. It must be 1-64 characters, start with a letter, and contain only letters, digits, underscores, and hyphens.
403	OperationNotAllowed.SystemServer	System type servers are not allowed to be updated or deleted.	System-level services do not allow update or delete operations.
404	NotFound.ApiMcpServer	Specified MCP server not found.	The MCP service with the specified ID does not exist.
409	Exists.TerraformTools.Name	The Terraform tool name already exists.	The specified Terraform tool name already exists.
409	Exists.ToolAlias	Duplicate tool alias '%s' found. Each tool alias must be unique within an MCP server.
409	Conflict.ToolAlias	Tool alias '%s' conflicts with an existing tool name in this MCP server.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.