Get Syllabus

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

Annotations already declare readOnlyHint and openWorldHint, so the description does not contradict them. It adds the detail that it returns the HTML body, which is useful, but it does not mention behaviors like missing syllabus handling or authentication requirements. The bar is low due to annotations, and the description provides marginal additional context.

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, entirely to the point, with no extraneous words or redundancy. It efficiently conveys the purpose without bulk.

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?

The tool is simple (one parameter, no output schema), and the description conveys the core functionality. However, it does not explain what the HTML body includes, when it might be empty, or why the user should choose this over overlapping tools. Given the low complexity, it is just adequate but could be more explanatory.

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, course_id, is fully documented in the schema ('The Canvas course ID'). Schema description coverage is 100%, so the description does not need to add more. It adds no extra meaning beyond what the schema already 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 clearly states that the tool retrieves the syllabus HTML body for a course, specifying the resource (syllabus) and output format (HTML body). This distinguishes it from sibling tools like 'get_course' or 'list_courses' which serve different purposes.

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 provides no explicit guidance on when to use this tool instead of alternatives like 'get_course' or 'list_pages'. It only states what it does, leaving the agent to infer usage from the tool name, but without exclusions or alternative tool mentions.

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