Skip to main content
Glama
aliyun
by aliyun

UpdateTableBusinessMetadata

Update business metadata for data tables in DataWorks, including usage instructions and descriptions, to maintain accurate data documentation.

Instructions

更新数据地图数据表的业务元数据

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
IdYes数据表ID,可参考[元数据实体相关概念说明](~~2880092~~)。格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录名称}:${数据库名称}:${模式名称}:${数据表名称}`,对于不存在的层级置空>对于MaxCompute和DLF类型,此处的实例ID即为主账号ID。>对于MaxCompute类型,此处的数据库名称即为MaxCompute项目名称
ReadmeNo使用说明,支持富文本格式
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 of behavioral disclosure. It states the tool updates metadata, implying a mutation operation, but fails to describe permissions required, whether changes are reversible, rate limits, or error handling. This is a significant gap for a mutation tool with zero annotation coverage.

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

Conciseness4/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 function without unnecessary words. It's front-loaded with the core action, making it easy to parse, though it could benefit from slightly more detail given the lack of annotations.

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 of updating metadata (a mutation operation), no annotations, and no output schema, the description is incomplete. It lacks details on behavioral traits, error conditions, and what the update entails, making it inadequate for safe and effective tool invocation by an AI agent.

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%, with detailed descriptions for both parameters (Id and Readme) in the input schema. The description adds no additional meaning beyond the schema, such as examples or context for the parameters. Baseline score of 3 is appropriate since the schema does the heavy lifting.

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

Purpose3/5

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

The description states the action ('更新' meaning update) and target ('数据地图数据表的业务元数据' meaning data map table business metadata), which clarifies the tool's purpose. However, it's vague about what '业务元数据' specifically entails and doesn't differentiate from sibling tools like UpdateColumnBusinessMetadata or other metadata update tools, leaving ambiguity about scope.

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?

No explicit guidance on when to use this tool versus alternatives is provided. The description implies it's for updating business metadata of tables, but it doesn't specify prerequisites, constraints, or compare it to similar tools like UpdateColumnBusinessMetadata or UpdateDataQualityRule, leaving the agent to infer usage context.

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