generate_data_dictionary

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

No annotations exist to cover side effects or permissions. The description only says it generates a Markdown data dictionary with Mermaid ER diagram. It doesn't state whether it writes to a file, whether it overwrites output, whether it connects to a PBIP path, or any other behavioral details. The burden is on the description, and it only covers the high-level output.

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?

One concise sentence with a clear verb and object. No fluff. Loses a point because it omits any parameter or usage context that would help an agent.

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 description gives no guidance on when to use this tool versus alternatives, does not explain parameters or prerequisites, and does not specify side effects (e.g., file output location). Given no annotations and no output schema, this is too sparse for an agent to invoke with confidence.

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 0% (no parameter descriptions). The description mentions 'for a PBIP' which hints that pbip_path identifies the PBIP, but inspector and output_path are completely unexplained. No compensation for the schema gap, so below baseline.

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?

Description clearly states the action ('Generate') and the resource ('a Markdown data dictionary with Mermaid ER diagram for a PBIP'). It is distinct from sibling tools like deploy_to_workspace or audit_model_and_report, though it doesn't explicitly name an alternative or scope. The verb and resource are specific enough for basic identification.

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, what inputs are expected, prerequisites, or how it differs from alternatives. An agent gets no direction on choosing it over siblings.

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