convert_diagrams_write

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

With no annotations, the description must disclose side effects itself. It does say the tool writes/updates .md files on disk and that it scans in batch, which are important behaviors. However, it doesn't say whether existing files are overwritten, where new files land, or whether the operation is idempotent.

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 with no filler. The key constraints—batch scanning, glob patterns, and disk output—are front-loaded and every word earns its place.

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 simple two-parameter tool, the description covers what is scanned and what is produced, but it leaves ambiguity about overwrite behavior and doesn't clarify side effects in detail. Since no annotations or output schema exist, this gap is more significant.

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%, so the baseline is 3. The description adds only 'workspace' and 'batch' context to the patterns parameter; the diagramType enum and default are already in the schema. No additional parameter meaning is needed.

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 opens with a concrete action ('Batch scan workspace diagrams matching glob patterns') and specifies the outcome ('convert them to updated .md files on disk'). This clearly names the resource and distinguishes it from the sibling tools by emphasizing disk writes.

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?

It doesn't explicitly state when to prefer this over convert_diagrams_read or list_diagrams. The 'Batch' and 'on disk' wording implies a write-oriented bulk use case, but there are no explicit alternatives or exclusion conditions.

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