EAD Metadata Import

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

Annotations indicate a write operation that is not read-only, not idempotent, and not flagged as destructive. The description only repeats the import concept and adds no behavioral context about side effects, such as whether existing metadata is overwritten, whether documents are created, or whether the operation can be safely repeated. With annotations covering only basic hints, the description fails to disclose meaningful behavioral traits.

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 with no filler or repetition. It front-loads the action and target, making it easy to scan. Nothing in the description is wasted, though it is quite terse.

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 mutation-like import operation with no output schema, the description is too sparse. It does not explain what happens after import, whether fileName refers to a local or server-side file, whether the operation affects existing metadata, or what results the agent should expect. These gaps matter because the required parameter is only collId, leaving fileName's role ambiguous.

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 description coverage is 100%: collId is documented as 'Collection ID' and fileName as 'EAD file name'. The description adds no additional semantic nuance, such as the required format of fileName or why fileName might be optional while collId is required. This meets the baseline for a tool whose schema already documents its parameters.

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 uses a specific verb ('Import') and names the resource ('EAD metadata') along with the destination ('a collection'). It also denotes the importer's general scope, making it reasonably distinguishable from many other collection-related tools, though it doesn't explicitly differentiate it from sibling tools that handle metadata updates or bulk uploads.

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 offers no explicit guidance on when to use this tool versus alternatives such as transkribus_coll_update_metadata, transkribus_upload_bulk_update_isad_metadata, or document creation tools. It implies the use case of importing EAD metadata, but it does not state prerequisites, exclusions, or when another tool would be preferable.

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