clickup_doc_get

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

With no annotations, the description carries full burden. It clearly states the tool returns only metadata and not page bodies, and says it returns the doc object. It could mention more about response shape, but for a simple fetch, this is adequate. No contradictions.

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 sentences conveying essential information with no redundancy. The first sentence states purpose, the second clarifies limitation and alternatives. Perfectly concise.

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?

The description covers purpose, limitations, and alternatives. It lists returned fields and mentions the doc object. Without an output schema, it provides enough context for a simple metadata fetch, though a few more details on response structure would improve completeness.

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 coverage is 100%, and the description adds value by indicating that doc_id should be obtained from clickup_doc_list and that team_id can be omitted for the default workspace. This aids correct usage beyond the schema.

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 it fetches metadata for a single ClickUp doc, listing specific fields (name, parent, dates, type). It explicitly distinguishes from sibling tools that return page bodies, making the purpose unambiguous.

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?

The description explicitly states what the tool does NOT do (not return page bodies) and provides two alternative tools (clickup_doc_pages, clickup_doc_get_page) for that purpose. This gives clear guidance on when to use this tool vs. siblings.

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