Skip to main content
Glama
aliyun
by aliyun

UpdateDataServiceApi

Modify development-stage information for DataWorks data service APIs, including request methods, response types, timeouts, and protocol settings.

Instructions

更新数据服务API开发态的信息

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ProjectIdNo工作空间的ID
ApiIdNoAPI的ID
RequestMethodNoAPI的请求方式,可选枚举值包括0(GET)、1(POST)、2(PUT)和3(DELTE)。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE
ResponseContentTypeNoAPI的返回数据类型,可选枚举值包括0(JSON)和1(XML)。向导和脚本API支持JSON,注册API支持JSON和XML
TimeoutNo超时时间,单位为毫秒(ms),取值范围为(0,30000]
VisibleRangeNo可见范围,可选枚举值包括0(工作空间)和1(私有)
ProtocolsYesAPI协议,可选枚举值包括0(HTTP)和1(HTTPS)。支持多值,多个值之间使用英文逗号(,)分隔
ApiPathYesAPI的路径
ApiDescriptionYesAPI的描述信息
WizardDetailsNo向导API的详情,请参见[GetDataServiceApi](~~174013~~)接口wizardDetails字段的JSONString
ResourceGroupIdNo独享资源组ID
RegistrationDetailsNo注册API的详情,请参见[GetDataServiceApi](~~174013~~)接口registrationDetails字段的JSONString
TenantIdNo租户ID。您可登录[DataWorks控制台](https://workbench.data.aliyun.com/console),进入数据开发(DataStudio)页面,单击右上方当前登录用户名称,选择菜单>用户信息,获取租户ID
ScriptDetailsNo脚本API的详情,请参见[GetDataServiceApi](~~174013~~)接口scriptDetails字段的JSONString
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It states 'update' which implies mutation, but doesn't disclose behavioral traits like required permissions, whether changes are reversible, rate limits, or what happens to unspecified fields. For a mutation tool with 14 parameters and no annotation coverage, this is a significant gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence in Chinese that directly states the tool's purpose without unnecessary words. It's appropriately sized and front-loaded with the essential information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the complexity (14 parameters, mutation operation) and lack of annotations/output schema, the description is inadequate. It doesn't explain what 'development information' entails, the update scope, or behavioral context. For a tool with this many parameters and no structured safety hints, more descriptive context is needed.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all 14 parameters thoroughly with descriptions, enums, and constraints. The description adds no parameter-specific information beyond what's in the schema, meeting the baseline for high coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('更新' meaning 'update') and target ('数据服务API开发态的信息' meaning 'data service API development information'), providing a specific verb+resource combination. However, it doesn't differentiate from sibling tools like 'UpdateDataSource' or 'UpdateDataQualityRule', which follow similar naming patterns for different resources.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives. There's no mention of prerequisites (e.g., needing an existing API), exclusions (e.g., cannot update published APIs), or related tools like 'CreateDataServiceApi' or 'PublishDataServiceApi' from the sibling list.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/aliyun/alibabacloud-dataworks-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server