transkribus_kws_get_result_dataRetrieve result data for a keyword spotting query by its resource ID. Get matched keywords and metadata from the Transkribus server.
Get result data for a keyword spotting query.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Resource ID |
Changes observed during successful MCP inspections.
v2.1.1Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and idempotentHint=true, so the description adds no new behavioral information. It does not contradict annotations, but adds minimal value beyond them.
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 sentence, very concise and front-loaded. However, it is somewhat vague and could benefit from additional context without becoming verbose.
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?
The description is incomplete for a tool with no output schema. It does not describe what the result data contains, nor does it mention any relationship to other KWS tools (e.g., requiring a prior query).
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 only parameter 'id' has a schema description 'Resource ID', and the tool description does not add any additional context about what this ID represents. Schema coverage is 100%, so baseline score 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 clearly states the verb 'Get', the resource 'result data', and the context 'keyword spotting query'. It distinguishes from sibling tools like transkribus_kws_get_hits and transkribus_kws_get_keywords by focusing on 'result data', but lacks explicit differentiation.
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 usage guidelines are provided. The description does not specify when to use this tool vs. other KWS tools, nor does it mention prerequisites such as needing a query to exist.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.