transkribus_upload_get_statusRetrieve the current status of an upload by its ID. Use this to monitor processing progress and determine when the upload is complete.
Get the status of an upload by ID.
| Name | Required | Description | Default |
|---|---|---|---|
| uploadId | 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, destructiveHint=false, and idempotentHint=true. The description adds no behavioral details beyond restating that it gets status; it does not disclose what status information is returned (e.g., progress, error messages) or any side effects.
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, efficient sentence with no extraneous words. It front-loads the purpose.
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 read tool with one parameter and no output schema, the description is adequate but could be more helpful by indicating typical status values or response structure. Given the annotations provide safety context, the description meets minimum viability.
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% with 'uploadId' described as 'Resource ID'. The description merely repeats 'by ID' without adding meaning or context about how to obtain or interpret the uploadId. With high schema coverage, baseline score is 3.
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 'Get the status of an upload by ID' uses a specific verb ('get') and resource ('status of an upload'), clearly distinguishing this tool from sibling tools like transkribus_upload_delete or transkribus_upload_create_s3.
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 provides no guidance on when to use this tool versus alternatives, such as when to poll status versus other upload operations. No explicit when/when-not context is given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.