promote_headers

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

With no annotations provided, the description carries the full burden. It does disclose that Table.PromoteHeaders is appended to the table's M query, which is a useful behavioral detail. However, it does not mention whether the first row is removed, whether existing headers are replaced, or any side effects on the data or query, leaving significant ambiguity for an agent.

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?

The description is concise: two sentences that immediately state the purpose and the implementation detail. No filler or redundant phrasing.

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 tool is relatively simple, and the description covers the core transformation. However, without annotations or an output schema, additional context about return values, side effects, or prerequisites would be expected. The description is minimally adequate but leaves gaps.

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?

Schema description coverage is only 33% (only partitionName is described). The description does not explain the required parameters 'sessionId' or 'table' beyond the vague mention of 'the table's M query'. It fails to compensate for the low schema coverage.

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?

The description clearly states the action: promote the first data row to column names, and names the specific M function appended (Table.PromoteHeaders). This is a specific verb+resource combination that inherently differentiates from the sibling tool demote_headers.

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?

No explicit guidance on when to use this tool versus alternatives. The description implies its use for 'Use First Row as Headers' scenarios but does not mention exclusions, prerequisites, or compare to demote_headers or other transformation tools.

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