doc_flow

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

The description includes '[read-only]' which signals no side effects, and 'renders' implies a read operation. With no annotations provided, this is adequate but minimal. It does not disclose potential error handling, permissions, or rate limits.

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 that is front-loaded with the read-only hint and function signature. It contains no redundant information and is efficient for its length.

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?

Despite having an output schema, the description is too brief to provide sufficient context for an AI agent. It does not explain what a 'flowLink chain' is or how this tool fits among the many sibling tools like link, unlink, and doc_rollup.

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 0%. The description only implies the 'id' parameter via the function signature but does not explain the 'help' parameter or provide any additional meaning beyond the schema's bare names. This is insufficient for a tool with undocumented parameters.

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 verb 'renders' and the resource 'doc's flowLink chain', and specifies it's a journey view. However, it does not explicitly distinguish from sibling tools like doc_map or doc_rollup, which may have overlapping purposes.

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 is provided on when to use this tool versus alternatives. The phrase 'journey view' gives a vague hint, but there are no explicit when-to-use or when-not-to-use instructions, nor are alternatives mentioned.

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