refresh_pivot_table

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

With no annotations provided, the description takes on the responsibility of disclosing side effects. It explicitly warns 'Mutates the workbook by overwriting the pivot output area,' which is crucial behavioral information. It also explains that it re-runs a stored definition, giving insight into the internal process. It does not mention error states or permission requirements, but the key mutation risk is covered.

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 compact and well-structured. It begins with a clear one-sentence summary, then breaks down args, returns, and notes in separate sections. Every line adds value, with no redundant or filler text. The mutation warning is placed appropriately in a Note, ensuring it is noticed without cluttering the main description.

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?

Given the tool mutates data and has no annotations or output schema, the description provides a solid foundation by covering the purpose, parameters, return type, and side effects. It does not describe what happens in error scenarios (e.g., if the pivot definition is missing) or how the return summary is structured, but for the average agent invocation this is sufficient. The presence of sibling tools like create_pivot_table provides additional context, though the description itself doesn't reference them.

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 schema has 0% description coverage, so the description must compensate. It does this well by listing each parameter in the Args section with a clear one-line explanation (e.g., 'file_path: Workbook path containing stored pivot definitions'). This adds meaning beyond the bare schema properties, though it does not go into exhaustive detail about default behaviors or edge cases.

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 uses a specific verb ('refresh') with a specific resource ('previously created pivot table'), clearly distinguishing it from creation tools like create_pivot_table. It also clarifies the action ('re-running its stored definition'), leaving no ambiguity about the tool's function.

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?

The description states the tool is for refreshing a previously created pivot table, implying it should not be used for creation. It also mentions optional source overrides, giving context for when those might be used. However, it does not explicitly name alternatives or state when not to use this tool, so it does not fully earn a 5.

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