transkribus_kws_create_queryCreate a keyword spotting query in a Transkribus collection by providing collection ID and keyword string. Optionally specify a document ID to limit the search to one document.
Create a new keyword spotting query.
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Limit to a specific document ID | |
| query | Yes | Keyword query string | |
| collId | Yes | Collection ID |
Changes observed during successful MCP inspections.
v2.1.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations indicate it's a write operation (readOnlyHint=false) but non-destructive (destructiveHint=false). The description adds no behavioral context beyond 'create', such as whether the query is saved or immediately usable.
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, clear sentence. It is front-loaded and efficient, though it sacrifices some detail.
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?
No output schema and the description does not explain how this tool fits into the KWS workflow (e.g., relationship to searching or retrieving hits). Incomplete for a creation tool with related siblings.
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 100%, so descriptions already exist for all parameters. The description adds no extra meaning beyond what the schema provides.
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 ('create') and the resource ('keyword spotting query'). It distinguishes from sibling KWS tools like listing or getting hits.
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 on when to use this tool versus siblings (e.g., transkribus_kws_list_queries, transkribus_kws_get_hits). No prerequisites or context for using the query creation.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.