Skip to main content
Glama
trustxai

amazing-clickup-mcp

by trustxai

clickup_search_docs

Read-onlyIdempotent

Search for Docs in a ClickUp workspace using filters like parent location, creator, or status. Returns doc names, IDs, and parent details with cursor-based pagination.

Instructions

Search the Docs in a Workspace, optionally filtered by parent location.

Lists Docs across the Workspace and can narrow by creator, parent container, or archived/deleted state. Results are cursor-paginated.

When to Use:

  • To find a Doc's id before reading (clickup_get_doc) or editing its pages.

  • To enumerate every Doc under a Space/Folder/List (set parent_id + parent_type).

When NOT to Use:

  • To read a specific Doc's content — use clickup_get_doc_pages instead.

  • To create a Doc — use clickup_create_doc.

Returns: A list of Docs (name, id, parent, created date). When more results exist the response includes a next_cursor; pass it back as cursor to page forward.

Pagination: Cursor-based. Loop: call once, read next_cursor from the output, then call again with cursor=<next_cursor> until it is empty.

Examples:

  • params = {"parent_id": "901300", "parent_type": "space"}

  • params = {"cursor": "eyJ...", "limit": 100}

Error Handling: 401 → bad token; 404 → unknown Workspace id. Errors return an Error ... string.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior5/5

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

Annotations already indicate read-only, idempotent, non-destructive behavior. The description goes further by detailing pagination (cursor-based), error handling (401, 404), output format, and the purpose of obtaining doc IDs for subsequent operations.

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

Conciseness4/5

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

The description is well-structured with clear sections and examples, but it is fairly verbose. Every section serves a purpose, but slightly more conciseness could be achieved without losing clarity.

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 (multiple filters, pagination, error handling), the description covers all essential aspects: purpose, usage, pagination mechanism, examples, and error scenarios. Output schema exists but the description still summarizes returns.

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

Parameters3/5

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

The schema provides detailed descriptions for all parameters, so the description adds little new parameter-level semantics. However, it gives high-level filtering concepts and pagination flow, which adds some context.

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 'Search the Docs in a Workspace' and explains filtering capabilities. It distinguishes itself from siblings like clickup_get_doc and clickup_create_doc by specifying when to use each.

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?

The description includes explicit 'When to Use' and 'When NOT to Use' sections, providing clear guidance on appropriate scenarios and directing to alternative tools (clickup_get_doc_pages, clickup_create_doc).

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

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