Skip to main content
Glama
asaphe
by asaphe

get_doc_pages

Read-only

Fetch every page of a ClickUp Doc, including content, as a flat list. Read entire multi-page docs in one call without missing sub-pages.

Instructions

Get every page of a Doc, content included, as a flat list.

Use this to read a whole multi-page Doc in one call. Sub-pages (nested under a parent page in the ClickUp v3 response) are flattened into the same list alongside their parent, not dropped. For a single known page, get_doc_page avoids fetching pages you don't need.

Args: doc_id: The Doc's ID, as returned by create_doc. content_format: "text/md" (default) or "text/plain". max_page_depth: How many levels of nested sub-pages to include. -1 (default) returns every page.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
doc_idYes
content_formatNotext/md
max_page_depthNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Annotations declare readOnlyHint=true, already signaling a safe read. The description adds valuable behavioral context: sub-pages are flattened into the same list, content is included, and max_page_depth controls nesting levels. These traits go beyond what annotations provide, enriching the agent's understanding.

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?

The description is efficiently structured: a clear purpose statement, a usage sentence, a distinction from the singular tool, and a concise Args list. Every sentence adds value without redundancy or excessive length.

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 the tool's complexity (multi-page flattening, depth control) and an output schema present, the description covers all essential behavioral aspects: flat list, content inclusion, sub-page handling, and depth default. It is complete for an agent to select and invoke the tool correctly.

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

Parameters5/5

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

Schema description coverage is 0%, but the description fully compensates by explaining each parameter: doc_id (source of ID), content_format (allowed values and default), and max_page_depth (semantic meaning, default -1). This adds significant meaning beyond the bare schema.

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 begins with a specific verb+resource: 'Get every page of a Doc, content included, as a flat list.' It clearly distinguishes from the sibling tool get_doc_page by explicitly noting 'For a single known page, get_doc_page avoids fetching pages you don't need.' This makes the tool's purpose unambiguous.

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

Usage Guidelines5/5

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

Provides explicit guidance: 'Use this to read a whole multi-page Doc in one call.' and contrasts with get_doc_page for single-page scenarios. Also explains the flattening behavior for sub-pages, giving clear when-to-use context relative to alternatives.

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/asaphe/clickup-mcp'

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