ddflow_help

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

Even though no annotations are provided, the description discloses that the tool is 'Read-only' and warns that returned pages may be project-specific overrides rather than defaults. This is useful behavioral context that prevents the caller from assuming the output is always the canonical template.

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 front-loaded with its purpose, then moves clearly through when to call it, what each argument form returns, and the read-only project-override caveat. Every sentence earns its place; the contrast with sibling descriptions is relevant, not padding.

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 help/metadata tool with one optional parameter and no output schema, the description provides everything needed to invoke it correctly: purpose, first-use trigger, argument behavior, allowed topics, side-effect safety, and variability of the response. There are no major gaps.

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 already documents the optional topic parameter and its allowed values, and the description repeats that list without adding deeper per-topic semantics. Schema description coverage is 100%, so the description contributes little beyond what the schema already provides.

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 that ddflow_help is the overview tool: 'What ddflow IS, what it can do, and what the workflow is.' It also distinguishes itself from the one-tool-at-a-time sibling descriptions by explicitly saying those assume you already know which tool to pick. The intended role, scope, and argument modes are all immediately clear.

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 gives an explicit trigger: 'Call this first if you have not used it before.' It also explains why the sibling descriptions are not substitutes and tells the caller exactly when to omit the topic versus provide one. This is strong when-to-use guidance.

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