disclosure-compiler__get_framework

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

The description explains what the tool returns (datapoints, mappings, sources, lineage) but does not disclose whether it has side effects, permissions required, or that it is read-only. Since no annotations are provided, the description bears the full burden, and it partially fulfill it.

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, front-loaded with a bracketed context qualifier. It is concise but the bracketed text could be considered extraneous.

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 the tool has one parameter and no output schema, the description provides the minimum necessary to understand its purpose but lacks details on output format, prerequisites, or how the framework parameter is used. It is adequate but not complete.

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 parameter 'framework' has no schema description (0% coverage), and the tool description does not clarify what valid values are or how to specify the framework. It adds minimal 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 action 'Return one bundled framework's required datapoints, mappings, sources, and framework-pack lineage' and distinguishes it from sibling tools like list_frameworks by specifying it returns details for a single framework. The domain qualifier adds context.

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?

The description implies the tool should be used when you need details for a specific framework, as it says 'Return one bundled framework'. However, it does not explicitly contrast with alternatives like list_frameworks or compile_disclosure, nor does it state 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.