Skip to main content
Glama
rafadepaula

@rafadepaula/clickup-mcp

by rafadepaula

clickup_get_schema

Retrieve the entity-relationship schema, including a Mermaid ER diagram, for enabled Unified API operators before executing an operator, with optional filters.

Instructions

Returns the entity-relationship schema (Markdown with a Mermaid ER diagram) for the models behind the enabled Unified API operators. Optional background before a clickup_execute_operator call; not needed for the dedicated clickup_* tools.

Input Schema

NameRequiredDescriptionDefault
tierNoMinimum importance tier to include: `primary` (overview), `secondary`, or `attribute` (everything, the default).
namesNoRestrict the output to these entity names (lowercase). Only enabled models are returned.
detailedNoInclude the long-form description of each entity and relationship instead of the one-line summary.
workspace_idNoWorkspace ID (digits only). Only needed when you have multiple workspaces.
entities_onlyNoReturn only the entity list — no relationships, no diagram.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4/5.0
Behavior3/5

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

With no annotations provided, the description carries the full burden. It discloses the return format (Markdown with a Mermaid ER diagram) and that the call is purely informational background, but it does not say whether output can be large, whether it is scoped/safe to call repeatedly, or what happens when no models are enabled.

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?

Two tight clauses: what it returns, then when to use it versus alternatives. No restatement of the name or filler, and the usage constraint is front-loaded enough to guide a decision.

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

Completeness4/5

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

For a zero-required-parameter read tool with a fully documented schema, the description covers purpose, output shape, and usage routing. The only real gap is that it does not indicate the diagram's scope/volume so an agent can judge whether to set tier or entities_only.

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 defines tier, names, detailed, workspace_id, and entities_only with meaning. The description adds no parameter guidance — notably it does not mention that tier/names narrow the diagram or that entities_only strips relationships, so it neither compensates nor detracts.

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?

States a specific verb and resource: returns the entity-relationship schema for the models behind the enabled Unified API operators, including the output format (Markdown + Mermaid ER diagram). It distinguishes itself from the dedicated clickup_* tools, though "Unified API operators" is internal jargon an agent may only recognize after calling clickup_get_operators.

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 frames the tool as optional background before a clickup_execute_operator call and explicitly says it is not needed for the dedicated clickup_* tools. Both the when-to-use and the when-not-to-use are named, along with the alternative path.

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

Deploy Server

Other Tools