zadig_workflow_diff

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

There are no annotations, so the description shoulders the full burden of behavioral disclosure. The word 'Diff' suggests a read-only comparison, but the description never explicitly states that no changes are made, what side effects occur, or what the returned diff looks like. This is minimal disclosure for an unannotated tool.

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 one tight, front-loaded sentence with no filler. It efficiently communicates the core action and resources involved, and every word contributes meaning.

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?

The tool has three parameters, one nested object, no annotations, and no parameter descriptions. Given this complexity, the description omits usage context, preconditions such as whether project_key is needed, and how the diff result relates to apply/update workflows. The output schema may document the return structure, but the surrounding operation is still under-explained.

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 input schema provides only parameter names and types, with 0% description coverage. The description fails to explain what 'workflow_name' refers to, what shape the 'workflow' object must take, or how 'project_key' affects the diff. The phrase 'desired workflow payload' loosely hints at the 'workflow' parameter but does not compensate for the undocumented parameters.

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 ('Diff') and identifies both the source ('current Zadig workflow detail') and target ('desired workflow payload'), making the tool's purpose immediately clear. It also distinguishes itself from sibling tools like zadig_workflow_get or zadig_workflow_update by indicating a comparison operation rather than retrieval or mutation.

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 gives no explicit guidance on when to use this tool versus alternatives such as zadig_workflow_apply or zadig_workflow_update. It is implied that this is a preview-before-apply tool, but that is not stated, and there is no mention of when not to use it.

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