superset_annotation_update

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

With no annotations, the description must carry the transparency burden. It reveals that the tool performs a partial update, but it does not disclose potential side effects, error conditions, or required permissions. The mutation nature is implied by 'update', but deeper behavioral context is missing.

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 with one opening sentence and a clean argument list. Every line is informative and there is no filler or redundancy.

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?

For an update tool with six parameters and an output schema, the description provides all necessary invocation details: which IDs are required, which fields can be changed, and datetime formats. It does not explain broader concepts like what an annotation is, but the Superset context and sibling tools make that unnecessary.

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 coverage is 0%, so the description must compensate. It lists all six parameters with brief explanations and adds ISO format details for start_dttm and end_dttm. However, short_descr and long_descr descriptions are largely tautological, and the distinction between them is not deeply elaborated.

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 states 'Update an annotation' with a specific verb and resource, clearly distinguishing it from sibling tools like annotation_create, annotation_get, and annotation_delete. The action is unambiguous.

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 phrase 'Pass only the fields to change' provides clear context for partial updates, which is essential for this tool. It does not explicitly mention alternatives or when not to use, but the update purpose is obvious from the name and description.

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