kupid_get_syllabus

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

With no annotations, description carries full burden. It mentions SSO login dependency but does not disclose other behaviors like idempotency, error responses, or rate limits. Adequate but not comprehensive.

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?

Very concise—single sentence for purpose followed by clear parameter list. No redundant information. Front-loaded with the key action and authentication requirement.

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?

Provides enough context for a simple fetch tool: input parameters explained, authentication noted, and output schema exists (handling return values). Could mention that course_code is required, but that's in schema. Overall sufficient.

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?

Input schema has 0% description coverage; the description manually defines each parameter with examples and values (e.g., semester options). This adds significant meaning beyond the raw schema, compensating for the lack of schema descriptions.

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?

Description clearly states the specific verb (retrieve) and resource (syllabus), and includes authentication requirement (SSO login). It effectively distinguishes this tool from siblings like kupid_lms_syllabus by implying it is a different system 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?

Mentions SSO login requirement, which hints at prerequisite, but does not explicitly state when to use this tool over alternatives (e.g., kupid_lms_syllabus) or provide scenarios. Usage context is implied but not fully clarified.

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