Get OBS Profile

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states what data is returned but does not disclose whether this is a read-only operation, whether it requires an active session, whether it can fail (e.g., if not authenticated), or any side effects. For a tool that likely requires authentication, this is a notable gap.

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, focused sentence that front-loads the purpose and lists the key data fields. There is no wasted wording, and it is appropriately sized for a zero-parameter tool.

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 zero parameters and an output schema exists, the description is mostly complete for a simple profile fetch. However, it does not mention authentication requirements or session dependency, which is relevant given sibling tools like obs_auth_status and obs_refresh_session. The output schema likely covers return structure, so the main gap is behavioral context around session requirements.

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 tool has zero parameters, so the schema is trivially complete. The description adds value by enumerating the specific fields returned (student number, faculty, department, advisors, academic programs), which helps an agent understand what 'profile' means in this context. With no parameters, the baseline is 4, and the description meets it.

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 student's personal details, student number, faculty, department, advisors, and academic programs. It uses a specific verb ('Return') and resource ('student's personal details'), and the title 'Get OBS Profile' aligns. It is distinguishable from siblings like obs_get_grades or obs_get_transcript, though it doesn't explicitly name a sibling.

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 this is the tool to fetch a student's core profile information, but it does not explicitly state when to use it versus alternatives like obs_get_academic_standing or obs_get_registration_status. There is no mention of prerequisites (e.g., authentication) or exclusions. The context is clear enough for a basic profile lookup, but no explicit guidance is given.

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