update_report

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

Description only says 'update', implying mutation, but does not disclose important behaviors like partial vs full replacement, idempotency, required permissions, or other side effects. No annotations provided to help.

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?

Single sentence is concise, but overly brief for a tool with no schema descriptions and important parameters. Could be improved without adding significant length.

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 no output schema, no annotations, and insufficient parameter descriptions, the description is not complete enough for an AI agent to use the tool correctly. Minimal 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?

Schema description coverage is 0%, and description provides no additional meaning for 'report_id' (e.g., format, identifier type) or 'report_data' (e.g., required fields, structure). This fails to add value beyond the bare schema.

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?

Description clearly states verb 'Update', resource 'report', and context 'in OpenMetadata'. This distinguishes it from sibling tools like 'create_report' and 'delete_report'.

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 guidance on when to use this tool versus alternatives such as 'create_report' or 'delete_report'. No prerequisites or context about when updates are appropriate.

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