VTable 列头清单

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

Describes the content of the returned list (columns with specific attributes), adding context beyond the readOnlyHint annotation, but doesn't mention error behavior or side effects (though it's read-only, so that's implied).

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

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

Two concise sentences, no redundant information, clearly structured.

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

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

The purpose and output content are covered, and output schema exists, but the parameters are left unexplained, leaving the agent to guess their meaning in the VTable context.

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

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

The description does not explain the parameters tab_id and table_index at all; schema lacks descriptions, so the agent has no guidance on what these mean.

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

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

States clearly it lists all columns of a VTable and specifies the fields returned (col index, field, title, cell type) and the typical use case (mapping business column names to col index).

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

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

Provides a specific use case ('用于把业务列名映射为 col 序号') but does not explicitly contrast with sibling tools or give when-not-to-use guidance.

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