Candor UI docs

Read a Candor UI pattern

get_pattern

Read-onlyIdempotent

Read a pattern as Markdown: a common problem in agent UIs (approvals, traces, cost guards, …) and the components that solve it.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "slug": "<slug>"
    },
    "name": "get_pattern"
  }
}

Input Schema

Name	Required	Description	Default
`slug`	Yes	The pattern's slug, as search_docs or suggest_components gives it.
`version`	No	A release, e.g. "2.6.2": the page as that release published it, for a project that has that version installed. Default: the version the server's URL passes (`?kit=`, which `npx candor-ui mcp` writes from candor-lock.json), else the current docs. When that release's docs weren't kept, or the page isn't in them, the answer is the current page with a note saying so.

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedNov 10, 2026

addedInput schema / properties / version

Added value: +{
+  "description": "A release, e.g. \"2.6.2\": the page as that release published it, for a project that has that version installed. Default: the version the server's URL passes (`?kit=`, which `npx candor-ui mcp` writes from candor-lock.json), else the current docs. When that release's docs weren't kept, or the page isn't in them, the answer is the current page with a note saying so.",
+  "maxLength": 32,
+  "type": "string"
+}

First observedNov 8, 2026

TDQS

A3.5/5.0

Behavior3/5

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

Annotations already declare readOnly, idempotent, non-destructive, and closed-world, so the safety profile is covered. The description adds the output medium (Markdown) and the shape of the content, but says nothing about what happens when a slug is unknown or how version fallback behaves — that context is carried entirely by the schema.

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?

A single sentence, front-loaded with the action and return format, with the parenthetical examples (approvals, traces, cost guards) earning their place by concretizing "pattern." Nothing is redundant, though the sentence is dense rather than structured.

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 simple read-only documentation fetch with a fully documented two-parameter schema and no output schema, the description covers what is returned and why it matters. The only real gap is failure behavior for an unknown slug, which is a minor omission at this complexity level.

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%, and the schema itself explains slug provenance and the version fallback chain in detail. The description adds no parameter meaning beyond that, which is the expected baseline when the schema does the work.

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 ("Read a pattern") and goes further by defining what a pattern is — a common problem in agent UIs plus the components that solve it — and the return format (Markdown). It is clearly distinct from get_component_docs in subject matter, though it never names a sibling to contrast with.

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

Usage Guidelines3/5

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

Usage is only implied: an agent infers it should call this when it needs a pattern. The workflow hint about where the slug comes from (search_docs, suggest_components) lives in the schema rather than the description, and there is no statement of when to prefer this over get_component_docs or get_brief.

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

All Candor UI docs tools Inspect

Try in Browser

Claude Code, inside the Godot 4 editorFlockbay puts an AI agent in the real Godot 4 editor: it writes GDScript, runs your game and fixes what breaks. Free, or bring your own Claude Code or Codex.flockbay.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.