get_document_thumbnail

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

With no annotations, the description carries the burden, and it does disclose a genuinely useful behavioral trait: the call returns a paperless:// resource URI that must then be read to obtain image bytes. However, it omits other relevant behavior such as what happens when a document has no thumbnail, any permission requirements, or the image format/size.

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?

Two short sentences with zero filler; the purpose is front-loaded and the two-step retrieval behavior follows immediately. Every sentence earns its place.

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 one-parameter read tool with no output schema and no annotations, the description covers the essential contract including the non-obvious two-step resource-URI return. Only minor gaps remain, such as missing-thumbnail behavior and image characteristics.

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 0%, so the description must compensate, and 'by ID' at least establishes that the single integer parameter identifies the document. It adds no constraints, format, or example beyond that, so it is only partially compensating for the undocumented parameter.

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?

States a specific verb and resource ('Get a document thumbnail') and parenthetically disambiguates it as an image preview, which separates it from text-oriented siblings like get_document_content or get_document. It does not explicitly name any sibling, so it falls short of full differentiation.

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?

There is no when-to-use or when-not-to-use guidance, and no mention of the adjacent tools (get_document_content, get_document, download_document) an agent might confuse it with. The usage is only implied by the description of what is returned.

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