Skip to main content
Glama
Sign In

Candor UI docs

by com.themethodic
OverviewDiscussionsAdmin

Read a Candor UI docs page

get_component_docs
Read-onlyIdempotent

Read one item's docs as Markdown: what it is, its tier and install command, an example with the import paths an app uses, every prop, function, type, and the LocaleProvider string keys.

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": {
      "name": "<name>"
    },
    "name": "get_component_docs"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesThe registry name, e.g. "thread", "approval-request" or "cost-guard-claude".
versionNoA 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.

  1. Changed1 schema field changed
    • 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"
+}
  2. First observed

TDQS

A3.5/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false and openWorldHint=false, so the safety profile is covered. The description adds real value by naming the return format (Markdown) and the content inventory. The version-fallback behavior (current page plus a note when a release's docs were not kept) is valuable but lives in the schema for `version`, not the description itself.

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 front-loaded sentence with no filler, beginning with the verb and output format. The long enumeration of page contents is dense but each element tells the agent what it will get, so it earns its length.

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?

With no output schema, the description carries the burden of describing returns and does so by listing the page's sections and Markdown format. For a read-only, two-parameter tool with fully documented schema and annotations, little is missing.

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 coverage is 100% and the `version` parameter is documented in unusual depth, including defaults and fallback. The description adds nothing about parameters beyond the implicit "one item" mapping to `name`, so the baseline 3 applies.

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 one item's docs as Markdown") and enumerates what the page contains: tier, install command, example with import paths, props, functions, types and LocaleProvider keys. That precision separates it from list_components and search_docs, but it never explicitly contrasts with nearby doc readers such as get_brief or get_design, so sibling differentiation is inferred rather than stated.

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: fetch the full docs for a single known item name. There is no explicit when-to-use, when-not-to-use, or pointer to an alternative for lookup-by-keyword (search_docs) or enumeration (list_components). An agent can work it out from the phrasing, but nothing routes it deliberately.

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 toolsInspect
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.

Resources