Search Canvas API

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, so the agent knows it's a safe read operation. The description adds the concrete return payload ('method, path, summary, and parameter names'), which provides useful behavioral context beyond the annotations.

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 long and front-loads the core function ('Search all Canvas API endpoints by keyword'). Every clause earns its place, including the usage rule and the return format, with no redundant filler.

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?

For a read-only search tool with a clear purpose, 3 well-documented parameters, and an output schema (as indicated by context signals), the description fully covers what an agent needs: what it does, when to use it, how to invoke it, and what to expect in return.

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 100% description coverage, with clear descriptions for query ('Keywords, e.g. 'group membership''), limit ('Maximum results to return'), and method ('Optional filter: GET, POST, PUT, PATCH, DELETE'). The description does not add parameter-level detail beyond what the schema already provides, which is acceptable given the high coverage.

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 verb 'Search' and the resource 'all Canvas API endpoints', making the tool's function unmistakable. It also distinguishes itself from sibling tools by specifying it covers 'anything the curated tools do not cover', which sets clear boundaries.

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 explicitly says 'Use this to find the right endpoint for anything the curated tools do not cover', providing a clear when-to-use instruction. It also links to the next step ('then execute it with canvas_request'), offering a concrete workflow.

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