get_active_document_info

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

No annotations provided. The description uses 'Return' implying a read operation, but does not explicitly state it is non-destructive or read-only. Lacks explicit behavioral disclosure beyond the return values.

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?

Single sentence, 12 words, front-loaded with verb and outcome. No unnecessary information. Highly efficient.

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 simple 0-parameter tool with an output schema, the description is largely complete. It specifies the three pieces of information returned. Minor gap: does not define 'active document' or prerequisites, but overall sufficient.

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?

No parameters exist (schema empty, 100% coverage). With zero parameters, baseline is 4 as per guidelines. The description does not need to add parameter semantics.

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 specific information (name, path, units) about the active Allplan document. The verb 'Return' and resource are precise, and it distinguishes from sibling tools which perform actions like create, delete, or modify.

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 explicit guidance on when to use this tool versus alternatives. The description only states what it does, leaving the agent to infer usage context. Implied usage for retrieving document info, but no exclusions or alternatives mentioned.

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