list_text_shortcuts

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

With no annotations, the description must disclose behavioral traits. It mentions the /v1 endpoint may require OAuth scope and can return 403, which is useful. However, it omits other behaviors like pagination defaults or sorting.

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?

Two efficient sentences: first sentence states the purpose, second adds a critical authorization note. No redundancy, but lacks structural elements like a clear 'When to use' section.

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?

Despite having an output schema (relieving return value explanation), the description fails to mention pagination behavior, sorting, or differentiation from the get_text_shortcut tool. This is insufficient for a list operation.

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 description coverage is 0% for the two parameters (page, page_size), and the description adds no meaning about their use, format, or effect.

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 starts with 'List text shortcuts/shorthands', a clear verb+resource combination. The tool name 'list_text_shortcuts' aligns well with sibling 'get_text_shortcut' and other list tools, distinguishing it as a collection listing operation.

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?

No explicit instructions on when to use this tool versus alternatives like 'get_text_shortcut' or other list tools. The only context is a caveat about potential 403 errors, which is more about authorization than usage guidance.

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