canvas_api_get

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

With no annotations, the description carries the full burden, and it does well: it asserts 'read-only by construction — it cannot issue a write even if asked to' and explains that max_chars bounds the payload. It stops short of covering auth requirements, rate limits, or error/status behavior, so it isn't fully complete.

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?

Front-loaded with the key framing ('escape hatch') followed by clean per-argument docs. The rationale sentence about a thousand operations is slightly verbose but earns its place by justifying the tool's existence.

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?

An output schema exists so return values need no explanation, and the description covers scope, safety, and all three parameters with examples. Only error handling and auth expectations are unaddressed, which is a minor gap for a generic GET passthrough.

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?

Schema coverage is 0%, so the description must compensate and does: it explains the path format (under /api/v1, with a concrete example and full-URL fallback), params_json as a JSON object with a sample including per_page and include[] syntax, and max_chars with the 0=server-default convention.

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?

States a specific verb and resource ('GET any Canvas REST endpoint') and frames itself explicitly as an escape hatch for operations not covered by dedicated tools. An agent can immediately distinguish this from the many resource-specific siblings.

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?

Gives explicit when-to-use: the dedicated tools cover common teaching operations, 'use this for the rest.' The condition selecting this tool over its ~40 siblings is stated directly rather than left to inference.

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