getPlanById

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

With no annotations provided, the description carries the full burden. It identifies the tool as a read operation returning a full plan export, but does not disclose behavioral details such as rate limits, authentication requirements, or the specific scope of 'all related entities'. The description is straightforward and non-contradictory, but lacks depth.

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 consists of two short sentences with no unnecessary words. The first sentence front-loads the core purpose, and the second adds crucial context ('full export'). Every word earns its place.

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's complexity (single resource retrieval), the description provides enough context for basic usage. However, without an output schema, more detail about the return structure would be helpful, but the phrase 'full plan export' implies completeness. Sibling tools are numerous, but the description does not need to cover all scenarios.

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 100%, so the input schema already documents both parameters thoroughly. The description adds no additional meaning beyond the schema, which is acceptable but does not enhance parameter understanding.

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 tool returns a single plan with all related entities, effectively a full export. It uses a specific verb ('returns') and resource ('single plan'), and the phrase 'full plan export' distinguishes it from sibling tools like 'getPlans' which likely return multiple plans.

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 does not explicitly state when to use this tool versus alternatives like 'getPlans' or 'getPlanMonth'. While the name and 'full plan export' hint at its specific use case, there is no guidance on when not to use it or what prerequisites might be required.

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