List Content Migrations

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

Annotations already declare readOnlyHint and openWorldHint, so the safety profile is covered. The description adds the sorting behavior ('most recent first') and the 'all' scoping, but it does not mention pagination or return format. With annotations present, this level of additional context is adequate but not extensive.

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, front-loaded sentence that provides all necessary information without redundancy. Every word contributes value, making it highly efficient.

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?

This is a simple list tool with one well-documented parameter and annotations for safety and scope. The description, combined with the schema and annotations, gives the agent sufficient context to select and invoke the tool correctly. No output schema is present, but the purpose and behavior are fully clear.

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 fully describes the only parameter (course_id) with 'The Canvas course ID'. The description's phrase 'for a course' aligns with the schema but adds no new semantic meaning. With 100% schema coverage, the baseline of 3 is appropriate.

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 uses a specific verb 'List' with a clear resource ('content migrations') and scope ('for a course'), plus ordering ('most recent first'). It distinguishes itself from the singular sibling get_content_migration by explicitly covering all migrations for a course.

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 clearly implies the tool is for retrieving all content migrations for a specific course, but it provides no explicit guidance on when to choose this over alternatives such as get_content_migration for a single migration or list_content_exports for exports. The context is clear but no exclusions or alternatives are named.

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