Skip to main content
Glama

clickup_doc_list

List all ClickUp docs in a workspace, returning id, name, and dates for each doc. Uses cursor pagination.

Instructions

List all ClickUp docs in a workspace. Docs are long-form markdown documents separate from tasks and can contain nested pages. Returns a compact array of doc objects (id, name, date_created, date_updated). Use clickup_doc_get for a single doc or clickup_doc_pages to list a doc's pages. Uses v3 cursor pagination.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
team_idNoWorkspace (team) ID. Obtain from clickup_workspace_list (field: id). Omit to use the default workspace from config.
Behavior4/5

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

Describes return format (compact array of doc objects with specific fields) and pagination (v3 cursor pagination). No annotations provided, so description carries the burden; it adequately discloses read-only nature and pagination behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three concise sentences covering purpose, distinction from tasks, return format, alternatives, and pagination. Each sentence adds value, no fluff.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given no output schema, the description includes return fields. For a simple list tool, it covers all necessary aspects: purpose, parameters, pagination, and differentiation from siblings.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Only one optional parameter (team_id) with 100% schema description coverage. Description adds context: 'Omit to use the default workspace from config.' This goes beyond the schema's base description, adding practical guidance.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool lists all ClickUp docs in a workspace, distinguishes docs from tasks, and mentions nested pages. It also differentiates from sibling tools clickup_doc_get and clickup_doc_pages.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides clear usage context: lists docs in a workspace. Mentions alternatives for single doc (clickup_doc_get) and doc pages (clickup_doc_pages). Does not explicitly state when not to use, but covers main scenarios.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nicholasbester/clickup-cli'

If you have feedback or need assistance with the MCP directory API, please join our Discord server