Manage Credit History

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

The description claims 'Create or update', which is not idempotent, but annotations set idempotentHint=true. This is a direct contradiction. The openWorldHint=true suggests additional side effects, but the description fails to disclose any 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 concise (one sentence) but sacrifices accuracy. It front-loads incorrect information, failing to clearly convey the tool's function.

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 the 5 parameters and lack of output schema, the description is grossly incomplete. It does not explain the operation, expected inputs for create vs update, or return values.

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?

Although parameter descriptions are present, they describe pagination and filtering fields (index, nValues, sortColumn, sortDirection) which align with a list/query operation, not create/update. The description does not explain how these parameters relate to creating or updating credit history entries, causing misalignment.

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 states 'Create or update credit history entries' but the parameters (index, nValues, sortColumn, sortDirection) are typical for listing rather than creating/updating. Sibling tools transkribus_credit_create and transkribus_credit_update exist, making the purpose vague and potentially overlapping.

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 is provided on when to use this tool versus alternatives like transkribus_credit_create or transkribus_credit_update. No prerequisites or context are given.

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