get_document_info

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

With no annotations, the description carries the behavioral burden, but 'Get document metadata' clearly signals a read-only information retrieval operation with no apparent side effects. It does not address error cases, prerequisites such as an open document, or permission requirements, but for a simple getter the core behavior is reasonably transparent.

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 concise sentence that front-loads the verb and resource, then lists examples of the metadata returned. Every word earns its place and there is no padding.

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?

An output schema is present, so return-value documentation is handled externally. The description covers the basic purpose and sample metadata, but lacks guidance on when to choose this over similar sibling tools and does not mention behavioral constraints or prerequisites. For a simple getter this is adequate but not comprehensive.

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 schema provides only 'doc_id' with no description, and the tool description does not explain it beyond the context of fetching document metadata. However, the single parameter is self-explanatory in this context, and the description adds useful output-oriented context (page count, modification status, path, version).

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 ('Get') and names the resource ('document metadata') with concrete examples (page count, modification status, path, version). It is clearly a metadata retrieval tool, though it does not explicitly differentiate itself from similar getters like get_document_summary or get_file_info.

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 about when to use this tool instead of siblings such as get_document_summary, get_page_count, or get_file_info. The description implies a generic metadata lookup but does not state conditions, exclusions, or preferred scenarios.

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