Get Or Create Document Info (V1.1)

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

Annotations already indicate non-read-only, non-destructive, non-idempotent. The description adds that it creates a new record and returns HTTP 201 on success, and that it doesn't fetch markups. It does not disclose side effects, authentication needs, or rate limits. The description adds some context beyond annotations but not significantly.

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 moderately concise but contains redundancy and a typo ('get or action'). It front-loads the purpose but could be tightened. Every sentence adds value, but some are repetitive or unclear.

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 no output schema, the description explains the purpose, required parameters, and basic behavior. It mentions the API category and endpoint. However, it does not describe what happens on a 'get' (if document exists), error cases, or idempotency. It is adequate but not fully complete.

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 input schema covers all 6 parameters with descriptions (100% coverage). The description only reiterates the required parameters without adding new meaning. Therefore, the description adds minimal value beyond the schema.

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 tool's purpose: get or create a document and return essential info for UI. It specifies it's lightweight and doesn't fetch markups. However, there is a minor typo ('get or action') and grammatical issues ('Creates a new Document Markup records'). It lacks explicit differentiation from sibling tools like 'create_a_new_markup' or 'show_or_create_document_markup_downloadable_pdf'.

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 some usage context: 'Use this to perform the get or action on Document Markup records' and mentions required parameters. It implies this is for lightweight retrieval without markups, but does not explicitly state when NOT to use it or suggest alternatives. No exclusions or comparisons to sibling tools.

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