Add Collection to Favorites

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

Annotations indicate it is not read-only, not destructive, not idempotent, and open-world, but the description adds no additional behavioral context such as authentication requirements, rate limits, or side effects like whether an existing favorite is overwritten. The description merely restates the action implied by the name.

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 extremely concise at 7 words, single sentence, front-loading the purpose. No unnecessary words or repetition.

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 simple tool with one parameter and no output schema, the description is adequate. It explains the core functionality, though it could benefit from clarification on what 'favorites' are or if any constraints apply. However, the presence of sibling tools like 'transkribus_coll_remove_favorite' provides contextual contrast.

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 for the single parameter 'collId' is 100% with a description 'Collection ID'. The tool description does not add any further parameter meaning, so it meets the baseline of 3 for 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 action: 'Add a collection to the user favorites.' It uses a specific verb ('Add') and resource ('collection'), and distinguishes from the sibling tool 'transkribus_coll_remove_favorite' by targeting the opposite 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 guidance is provided on when to use this tool or when to prefer alternatives. It does not mention prerequisites (e.g., the collection must exist) or when not to use it (e.g., if already a favorite). There is no comparison with similar tools like 'transkribus_coll_list' or 'transkribus_coll_remove_favorite'.

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