Upload Document

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

Annotations indicate a write operation (readOnlyHint=false) that is not destructive (destructiveHint=false) and not idempotent. The description adds no behavioral details beyond what annotations convey, such as whether the upload appends or replaces, file format expectations, or permission requirements.

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 concise, but the brevity sacrifices necessary context. Front-loading is fine, but the content is minimal.

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?

Given four parameters, no output schema, and numerous sibling tools, the description is incomplete. It fails to explain what 'upload' entails (e.g., file handling, document type), whether documents can be updated or only created, and how this differs from 'add' or 'create' tools.

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?

All parameters have schema descriptions (100% coverage), but the tool description does not add any additional meaning beyond those. For example, it does not explain how 'title', 'author', and 'description' are used in the upload context.

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 ('Upload a document') and the target resource ('to a collection'). However, it does not differentiate from siblings like 'transkribus_coll_add_doc', 'transkribus_coll_add_docs', or 'transkribus_coll_upload_doc_multipart', which have similar purposes.

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 alternatives. There are many sibling tools for adding or uploading documents (e.g., transkribus_coll_add_doc, transkribus_coll_upload_doc_multipart). The description offers no context for selection.

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