OBS Graduation Remaining

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

No annotations are provided, so the description must carry the full burden. It only says 'Read', implying a safe operation, but does not disclose any potential side effects, authentication requirements, rate limits, or return characteristics. For a read tool, this minimal transparency is insufficient.

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 with no wasted words, but it is under-specified. A concise description should still convey essential details; here, it achieves conciseness at the expense of completeness.

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 tool's description fails to cover parameter semantics and usage context. It does not state what the output contains or how to interpret results. The tool is complex (multiple outputs: graduation remaining, status, debts) but the description provides minimal guidance.

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 only parameter, program_id, has 0% schema description coverage. The description does not explain what a program_id is, how to obtain it, or its relationship to the output. The agent is left to guess its meaning beyond the schema's type and default null.

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 'Read' and the resources: graduation remaining, academic status, and debts. It specifies the scope 'for a program', which differentiates it from other OBS tools that read different aspects (e.g., advisor, attendance). The title and name align well.

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 on when to use this tool versus alternative OBS tools. Given the large number of sibling tools with similar prefixes, the agent needs explicit context on when to select this over obs_get_advisor, obs_get_registration_status, etc. The description provides no such guidance.

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