miniapp_dependency_diagram

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

With no annotations, the description should cover behavioral traits. It does not mention if the tool is read-only, what output format is returned (e.g., raw Mermaid text or a file), or any side effects like modifying files. The phrase 'generate' implies creation but without safety context.

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 conveying the core purpose and entities involved. No redundancy; every word is necessary.

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 4 parameters and no output schema, the description should explain what the generated diagram looks like, how it's delivered, and error scenarios. It is too brief for a tool with multiple inputs and no explicit output details.

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 75%, so baseline is 3. The description adds the context of 'Mermaid' but does not elaborate on parameter specifics like how target or featureName are used (e.g., filtering, highlighting). The description adds minimal extra value beyond the schema.

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 generates a Mermaid dependency diagram for specific entities (pages, files, routes, cloud functions, controllers, collections), providing a specific verb and resource. It distinguishes from siblings like miniapp_project_map or miniapp_graph_stats by focusing on dependency relationships.

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 vs. alternatives like miniapp_understand_project_flow or miniapp_graph_stats. No context on prerequisites (e.g., project must exist) or 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.