Update Model

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

Annotations already provide safety profile (idempotent, non-destructive). Description adds only the method 'posting updated model data' without clarifying permissions, side effects, or what fields are updatable.

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 minimal, lacking key details like the input body structure or expected response.

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 a mutation tool with a nested object parameter and no output schema, the description is too sparse; it does not explain what constitutes valid model data or what the update returns.

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 100% with description for 'body'. The tool description does not add extra meaning beyond the schema's 'Model data to update'.

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 the verb 'update' and resource 'model', which is clear but does not specify which model or how to identify it among siblings like transkribus_model_update_by_type.

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 transkribus_model_delete, transkribus_model_get, or transkribus_model_update_by_type.

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