Skip to main content
Glama
trustxai

amazing-clickup-mcp

by trustxai

clickup_get_doc

Read-onlyIdempotent

Retrieve metadata for a specific ClickUp Doc including its name, parent location, and creation/update timestamps by providing the Doc ID.

Instructions

Fetch a single Doc's metadata (name, parent, timestamps).

When to Use:

  • To confirm a Doc's parent location or creation details by id.

When NOT to Use:

  • To read the Doc's text — use clickup_get_doc_pages.

  • To list its page tree — use clickup_get_doc_page_listing.

Returns: The Doc's name, id, parent, workspace, creator, and created/updated times.

Examples:

  • params = {"doc_id": "8cbq..."}

Error Handling: 404 → Doc not found. Errors return an Error ... string.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

Annotations already declare read-only, idempotent, non-destructive. Description adds return fields and error handling format, but does not disclose additional behavioral traits like authentication or rate limits. No contradiction.

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?

Well-structured with clear sections, front-loaded main purpose, no redundant sentences. Efficient and easy to parse.

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?

Covers all essential aspects: purpose, usage constraints, return value description, error handling, and example. Given annotations and schema, the description is complete for this tool.

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?

Schema already provides descriptions for all parameters. Description only adds an example for doc_id but does not elaborate on workspace_id or response_format. No added value beyond 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?

Clearly states it fetches Doc metadata only, distinguishing from sibling tools that read text or list pages. Verb 'Fetch' with specific resource and scope.

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?

Explicitly lists when to use (confirm parent location/creation details) and when not to use (with alternative tool names given). Also provides error handling guidance.

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