Skip to main content
Glama
Leanware-io

ClickUp MCP Integration

by Leanware-io

clickup_search_docs

Search for documents within a specific ClickUp workspace, folder, list, or space using parent type and ID parameters.

Instructions

Search for docs in a specific parent

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
parent_typeYesType of parent (SPACE, FOLDER, LIST, EVERYTHING, WORKSPACE)
parent_idYesID of the parent

Implementation Reference

  • The handler function for the 'clickup_search_docs' tool. It constructs SearchDocsParams from input and delegates to docsService.searchDocs, returning the JSON-stringified response.
    handler: async (input) => {
      const params: SearchDocsParams = {
        parent_type: input.parent_type,
        parent_id: input.parent_id,
      };
      const response = await docsService.searchDocs(params);
      return {
        content: [{ type: "text", text: JSON.stringify(response) }],
      };
    },
  • The core helper method in DocsService that performs the HTTP GET request to the ClickUp API to search for docs in the specified parent.
    async searchDocs(params: SearchDocsParams): Promise<{ docs: ClickUpDoc[] }> {
      const { parent_type, parent_id } = params;
      return this.request<{ docs: ClickUpDoc[] }>(
        `/${this.workspaceId}/docs?parent_type=${parent_type}&parent_id=${parent_id}`
      );
    }
  • Zod input schema defining the parameters for the tool: parent_type and parent_id.
    inputSchema: {
      parent_type: z
        .string()
        .describe("Type of parent (SPACE, FOLDER, LIST, EVERYTHING, WORKSPACE)"),
      parent_id: z.string().describe("ID of the parent"),
    },
  • src/index.ts:89-91 (registration)
    Registration of all tools, including clickup_search_docs, to the MCP server by iterating over the tools array and calling server.tool.
    tools.forEach((tool) => {
      server.tool(tool.name, tool.description, tool.inputSchema, tool.handler);
    });
  • src/index.ts:55-56 (registration)
    Inclusion of the searchDocsTool in the central tools array used for MCP server registration.
    // Docs tools
    searchDocsTool,
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It mentions searching but doesn't describe return format, pagination, error handling, or authentication needs. For a search tool with zero annotation coverage, this is a significant gap in transparency.

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 a single, efficient sentence with zero wasted words. It's front-loaded with the core action and scope, making it easy to parse quickly.

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

Completeness2/5

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

Given no annotations, no output schema, and a search function that likely returns complex results, the description is incomplete. It doesn't cover what 'docs' includes, how results are structured, or any limitations, leaving the agent with insufficient context for effective use.

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 description coverage is 100%, so the schema already documents both parameters fully. The description adds no additional meaning beyond what's in the schema (e.g., it doesn't explain parent_type options or how parent_id is obtained). Baseline 3 is appropriate when schema does the heavy lifting.

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

Purpose4/5

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

The description clearly states the action ('Search for docs') and the scope ('in a specific parent'), which distinguishes it from creation/editing tools. However, it doesn't specify what 'docs' refers to (documents, pages, etc.) or how results are returned, making it slightly less specific than ideal.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives like 'clickup_get_doc_pages' or 'clickup_get_page', nor does it mention prerequisites or exclusions. It only states the basic function without context for selection.

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/Leanware-io/clickup-mcp-server'

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