describe_family

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

No annotations exist. Description mentions what is returned and what is not (repairs), but lacks information on side effects, permissions, or whether it is a read-only operation. Basic disclosure but not comprehensive.

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, efficient and front-loaded with purpose. No redundant words, but a structured list of what is included might improve clarity without expanding length significantly.

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?

Describes output content (invariants, designs) but not structure or format. No output schema. Lacks guidance on the parameter value. Adequate for narrow use but insufficient for full autonomy.

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% for the only parameter 'family'. Description does not explain what the parameter value should be (e.g., family ID or name) or provide format examples. Fails to add meaning beyond the schema's type and required status.

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 tool provides detailed information for one failure family, including invariants and unrepaired designs, and explicitly excludes repairs. This distinguishes it from sibling tool list_failure_families, which likely lists all families.

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?

Implies use when details on a specific family are needed, but does not explicitly state when to use versus siblings like list_failure_families or other tools. No alternatives or exclusions provided.

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