UpdateMcpServer-DataWorks(DataWorks)-阿里云帮助中心

Updates an MCP Server.

Operation description

This API operation allows you to update the configuration of a specified MCP Server, including the service URL, transport protocol, custom request headers, and visibility settings. Fields that are not provided retain their existing values.

Note: When you modify the Visibility parameter, selectively provide ProjectIds or UserIds in VisibilityScope based on the visibility setting to ensure that the correct access control scope is applied.

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

dataworks:UpdateMcpServer

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	Yes	The name of the MCP Server to update.	my-mcp-server
Url	string	No	The new service URL. The URL must start with `https://`.	https://example.com/mcp/sse
Transport	string	No	The new transport protocol.	SSE
CustomHeaders	object	No	The new custom request headers (key-value pairs).	{}
Visibility	string	No	The new visibility level.	TENANT
VisibilityScope	object	No	The new visibility scope. Provide the corresponding field based on the Visibility setting.
ProjectIds	array	No	The list of visible project IDs. This parameter takes effect only when Visibility is set to `PROJECT`.
	string	No	The list of workspace IDs.	[3162, 45766, 61258, 68916, 73279]
UserIds	array	No	The list of visible user IDs. This parameter takes effect only when Visibility is set to `USER`.
	string	No	The visible user ID.	[123]

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	824F80BA-1778-5D8A-BAFF-668A4D9C4CC7
McpServer	object	The MCP Server details.
Name	string	The MCP Server name.	my-mcp-server
GmtCreateTime	string	The creation time. The value is a 13-digit number, for example, `1780555634000`.	1780555634000
GmtModifiedTime	string	The last modification time, in millisecond-level timestamp.	1780555634000

Examples

Success response

JSON format

{
  "RequestId": "824F80BA-1778-5D8A-BAFF-668A4D9C4CC7",
  "McpServer": {
    "Name": "my-mcp-server",
    "GmtCreateTime": "1780555634000",
    "GmtModifiedTime": "1780555634000"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.