get_docs

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

With no annotations, the description carries the full burden for behavioral disclosure. It says 'Get all' but does not explain default behavior regarding archived docs, pagination, or any rate limits. The optional 'limit' parameter is not referenced, which could mislead an agent into expecting unlimited results.

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, well-structured sentence that immediately conveys the tool's purpose. It is concise without being under-specified, making it easy for an agent to parse.

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 list-retrieval tool with three parameters and no output schema, the description provides a functional but minimal overview. It lacks details on return format, pagination behavior, or the interaction between 'all' and the 'limit' parameter. It also does not distinguish when to use this tool over 'get_doc_pages', though the purpose clarity partially covers that.

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 input schema provides descriptions for all three parameters (limit, team_id, archived) with 100% coverage. The description adds only the phrase 'team/workspace' to clarify team_id, which the schema already conveys ('team (workspace)'). Therefore, the description adds minimal value 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 the action ('Get all'), the resource ('ClickUp Docs'), and the scope ('in a team/workspace'). This distinguishes it from sibling tools like 'get_doc' (singular) and 'get_doc_pages' (pages within a doc).

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 alternatives. The description does not mention 'get_doc' for single-doc retrieval or 'get_doc_pages' for pages, leaving the agent without explicit use-case differentiation.

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