get_course

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

No annotations are provided, so the description carries the full transparency burden. It adds a valuable behavioral guarantee that it never returns a secret, clarifying that `canvas_token_env` is a variable name, not the token. However, it does not explicitly confirm the operation is read-only or mention other behavioral traits.

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 two sentences, immediately stating the tool's purpose followed by an important safety note. Every word earns its place; there is no redundancy or irrelevant content.

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 has no annotations and no output schema, so the description must explain both return values and input. It adequately explains the output fields and a security caveat, but fails to clarify the required 'course' parameter, making the description incomplete for reliable invocation.

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 input schema has one required string parameter 'course' with no description, and the tool description provides no information about the parameter's format, acceptable values, or how it identifies the course. With 0% schema coverage, the description fails to compensate, leaving the parameter undefined.

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 course's coordinates (Canvas id, base url, school, GitHub org, output paths), specifying the exact resource and attributes. It distinguishes from siblings like list_courses (which lists courses) and get_doc/get_page by focusing on course-level metadata.

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 usage when a course's identifying information is needed, but does not explicitly state when to use it versus alternatives like list_courses or provide any exclusions or prerequisites. The safety warning about secrets adds context but not usage direction.

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