flowzap_artifact_to_diagram

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. While it mentions parsing artifacts and converting them to diagrams, it lacks details on permissions, rate limits, error handling, or what the output looks like (e.g., diagram format, success/failure states). For a tool with no annotation coverage, this leaves significant gaps in understanding its behavior.

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 appropriately sized with two sentences that are front-loaded and efficient. The first sentence states the core purpose with specific examples, and the second explains the outcome without redundancy. Every sentence earns its place by adding value, making it concise and well-structured.

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 tool's complexity (parsing artifacts into diagrams), lack of annotations, and no output schema, the description is moderately complete. It covers the purpose and input types but misses behavioral details and output information. For a tool with 3 parameters and no structured safety or output guidance, it should do more to compensate, leaving room for improvement.

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 description coverage is 100%, so the schema already documents all parameters (artifactType, content, view) with descriptions and enums. The description adds minimal value by listing artifact types (matching the enum) and mentioning 'raw artifact content', but doesn't provide additional syntax, format details, or constraints beyond what the schema specifies. This meets the baseline for high schema coverage.

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 clearly states the tool's purpose: 'Parse real artifacts... into FlowZap Code diagrams' and 'convert raw technical data into visual workflows'. It specifies the verb (parse/convert) and resource (artifacts/technical data) with concrete examples (HTTP logs, OpenAPI specs, code snippets). However, it doesn't explicitly differentiate from sibling tools like flowzap_export_graph or flowzap_get_syntax, which might also handle diagrams or syntax.

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 implies usage context by listing specific artifact types (HTTP logs, OpenAPI specs, code snippets) and stating the outcome ('visual workflows that can be explained and refined'). However, it doesn't provide explicit guidance on when to use this tool versus alternatives like flowzap_apply_change or flowzap_validate, nor does it mention any exclusions or prerequisites for usage.

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