get_document_elements

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

With no annotations, the description must disclose behavior, but it omits key details like whether the tool is read-only, what it returns (e.g., list of element IDs or full objects), or any side effects. The read-only nature is implied but not stated.

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 redundancy, but it is slightly too brief for the tool's purpose, lacking critical details that could be added without sacrificing conciseness.

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 complexity of InDesign documents and the lack of output schema or annotations, the description is insufficient. The agent lacks information on return format, element representation, performance considerations, or error cases.

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 'elementType' has 100% schema coverage, and the description adds examples ('all', 'text', 'graphics', 'tables'), clarifying the format and options beyond the schema itself.

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 'Get all elements in the document' clearly states the action (get) and resource (elements), but 'elements' is vague and could be misinterpreted. It is distinct from siblings like 'get_page_item_info' which focuses on a specific item, but lacks precision about what constitutes an element.

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 on when to use this tool versus alternatives such as 'list_page_items' or 'get_document_stories'. No exclusions or context provided, leaving the agent to guess the appropriate scenario.

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