update_workflow

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

With no annotations, the description carries the full burden. It notes that the operation is a write and requires specific permissions, but does not disclose whether the replacement is full or partial, idempotency, error behavior, or destruction of missing fields.

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 a single sentence that packs essential information (action, resource, ID, prerequisites). It is concise but could benefit from a clearer structure or indication of replacement behavior.

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 complex nested workflow object and no output schema, the description lacks return value information and does not explain that the entire workflow is replaced, requiring all fields to be provided.

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 descriptions cover 100% of parameters, so the baseline is 3. The description adds minimal value beyond saying 'Update (replace)' and the schema's 'Full workflow definition to replace the existing one.'

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 ('Update (replace)'), identifies the resource ('Dynatrace Automation workflow'), and distinguishes from siblings like create_workflow and delete_workflow.

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 action (update by ID) and lists required prerequisites (environment variable and API scope). It does not explicitly exclude cases when to use alternative tools, but sibling names provide context.

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