get_document_summary

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

No annotations are present, so the description must communicate behavioral traits. It fails to state that the operation is read-only, what happens on missing documents, or any potential side effects. Only the basic purpose is conveyed.

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 sentence with no extraneous words, but it could be more informative without sacrificing conciseness. Still, it earns a high score for brevity.

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 lack of an output schema and the likely complex return value (a summary of workspaces and elements), the description is too sparse. It does not clarify what the summary contains, which limits its usefulness.

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 single parameter 'documentId' is fully described in the schema, and the description adds no additional meaning. With 100% schema coverage, the baseline is 3; no extra value is provided.

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 returns a comprehensive summary of a document including workspaces and elements. However, 'comprehensive summary' is vague and does not specify what exactly is included, which leaves some ambiguity.

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 siblings like 'get_document' or 'get_elements'. There is no mention of prerequisites or context for optimal use.

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