get_tweak

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

The description adds context about returning the current or historical version, but given the annotation 'readOnlyHint: true' already indicates a safe read operation, the description offers minimal additional behavioral transparency. No mention of error handling or permissions.

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?

Two sentences convey the purpose and key behavior with no redundancy or extraneous information. Front-loaded with the core action.

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 simple read-only retrieval tool with an output schema present, the description covers the essential behavior (current vs. historical version). It is sufficiently complete, though it lacks mention of possible error conditions or prerequisites.

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 schema already has 100% description coverage, including 'Omit to get the latest' for the 'sequence' parameter. The description repeats this information without adding new semantic details beyond what the schema 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 explicitly states 'Get a single FPE tweak by name,' providing a specific verb and resource. It distinguishes from siblings like 'list_tweaks' by focusing on a single tweak, and mentions returning current or historical versions.

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 clearly explains when to use the optional 'sequence' parameter to retrieve historical versions versus omitting it for the latest. However, it does not provide explicit when-not-to-use guidance or contrast with direct alternatives like 'list_tweaks'.

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