Candor UI docs

com.themethodicPublished by themethodic.comOfficial publisherv1.9.0Updated Nov 8, 2026

Candor UI docs and component suggestions. Read-only, no key, never serves paid source.

VerifiedStreamable HTTPWeb executableKnowledge & MemoryDeveloper Tools

Overview

AI-generated overview

Read-only docs and component suggestions for Candor UI, a shadcn/ui registry of React components for AI agent interfaces.

What you can do
  • Search and list components, hooks, blocks and patterns by what they do, or by group
  • Read one item's docs: tier, install command, example, props, types and locale string keys
  • Suggest components for a screen you describe, and read patterns for common agent-UI problems
  • Get install and setup guidance for React or Next.js, plus a brief to hand to a coding agent
  • Read the design system (colour roles, type, radius, motion, themes) and a post-screen review checklist
When to use it
Use it when building an AI agent interface in React or Next.js with Candor UI and you want the assistant to pick fitting components, read their props and import paths, and follow the design and review rules without leaving the editor.
Requirements
A remote MCP endpoint; no key, account or environment variables are declared. The components themselves are installed separately with the Candor UI CLI into a shadcn project.
Before you install
Read-only and serves no paid source, but Pro and Premium items need the person's own licence key, which they add themselves; the server says never to ask for it. Installing components writes files into your project and may overwrite shadcn primitives such as the button.

Installation

In SourceWeft

  1. Open Candor UI docs in the dashboard and add it to a workspace.
  2. Enable the server for the chats that should use its tools.

Web executable via Streamable HTTP. Remote servers run from the web runtime once configured in a workspace.

Use with an agent

Paste this prompt into Claude Code, Codex, Cursor or another agent — or into SourceWeft chat. The agent reads this server's install guide, shows you its publisher, endpoint and sign-in, and adds it to your client once you agree. Keys never go into a command.

Read https://sourceweft.com/mcp/com.themethodic%2Fcandor/install.md and connect the MCP server it describes to my client. Before changing any config, show me its publisher, endpoint and sign-in method and wait for my OK. Never put an API key in a command or in a file I would commit; ask me where it should come from.

Read the install guide the agent follows

Other MCP clients

Add this to your client's mcpServers config.

{
  "mcpServers": {
    "candor-ui-docs": {
      "type": "http",
      "url": "https://candor.themethodic.com/mcp"
    }
  }
}

README

Candor UI: the free tier

Interface components for agent apps: a thread, messages, a composer, tool calls, reasoning and citations, the building blocks under them, a light, dark and high-contrast theme, and adapters for the Vercel AI SDK, the Claude Agent SDK and AG-UI. Built on shadcn, installed with its CLI, MIT licensed.

This repo is the source of Candor UI's 54 free items (version 1.9.0), the skill and plugins for coding agents and a starter app. Docs and live examples: https://candor.themethodic.com.

Install

bash
npx candor-ui initnpx candor-ui add thread message composer

candor-ui init adds the @candor registry to components.json and the theme to your CSS; in a project without shadcn yet it runs shadcn's setup first (--yes sets it up with Radix and shadcn's nova preset, no questions). Or add the registry by hand: "@candor": "https://candor.themethodic.com/r/{name}.json". If shadcn asks to overwrite a primitive such as ui/button.tsx, answer yes: Candor's button styles locked actions; without a terminal, pass --overwrite.

For coding agents

llms-install.md tells an agent how to set Candor up in a project by itself: the CLI, the docs MCP server, the skill and the honesty rules to keep. The skill alone:

bash
npx skills add MethodicDev/candor

installs two skills: skills/candor-ui (which component fits which job, the adapters, and the rules the components keep, with a design-system reference read from the shipped CSS) and skills/candor-agent-ui (design fundamentals for screens where an AI agent acts, with a review checklist to run after each screen; it works with or without Candor).

The plugins install the skill and the docs MCP server together. Claude Code: claude plugin marketplace add MethodicDev/candor, then claude plugin install candor-ui@candor (or, in a session, /plugin install candor-ui --marketplace MethodicDev/candor). GitHub Copilot CLI: copilot plugin marketplace add MethodicDev/candor, then copilot plugin install candor-ui@candor. VS Code installs candor-ui from this repo's URL; Cursor reads .cursor-plugin/marketplace.json; the Codex package is plugins/codex/candor-ui.

The MCP server at https://candor.themethodic.com/mcp serves docs and component suggestions only: read-only, no key, never paid source. .mcp/server.json describes it for the MCP registry. Agents can also read https://candor.themethodic.com/llms.txt.

Starter

starter/ is a Next.js app with a working agent chat built from these components:

bash
npx degit MethodicDev/candor/starter my-agent-app

What's here

  • theme: Candor's default theme: light, dark and high contrast, contrast-checked. Import styles/candor.css after Tailwind.
  • font-inter: Inter, Candor's default typeface, self-hosted (OFL-1.1). Optional: without it the theme uses the system font. Import styles/candor-font-inter.css next to candor.css.
  • ag-ui: Turns AG-UI events into Candor messages, waiting approvals and usage, with AG-UI 1.0's shared state and activities.
  • ai-sdk: Vercel AI SDK (v7) UI messages to Candor messages: text, reasoning, tool calls, sources and data cards.
  • claude-agent-sdk: Turns Claude Agent SDK events into Candor messages, waiting approvals (and the agent's questions), usage and sources, and a person's answer back into the SDK's result.
  • claude-agent-server: The server half of the Claude Agent SDK adapter: stream a run to useClaudeAgent, keep its permission requests in a store your own route can answer, and let a browser re-attach to a run after a reload.
  • use-ag-ui: Wires an AG-UI agent to Candor: messages for /, props for , and the interrupts waiting on a person.
  • use-candor-chat: Wires a useChat() result to Candor: messages for /, props for , and the tool calls waiting on a person.
  • use-claude-agent: Wires a Claude Agent SDK server route to Candor: messages for /, props for , and the tool calls waiting on a person, re-attaching to a run after a reload.
  • copy-field: A value a person copies somewhere else (a callback URL, a scope list).
  • degraded-panel: Something couldn't be done.
  • locale: The interface's words, language and direction.
  • locked: The honest-state rule: a control that cannot be used says why.
  • relative-time: A time as people say it ("5 minutes ago"), with the exact time on hover, safe to render on the server.
  • status-dot: How many times the status reached done or failed from an unfinished one while the dot was on screen; zero when it mounted finished, so nothing moves for a change the reader never saw.
  • step-list: How many times status has reached succeeded or failed from an unfinished status while this component was on screen.
  • streaming-text: Text that is still arriving.
  • surface: Candor's card: a plain, muted, bordered or floating surface, so no screen hand-rolls its own.
  • terms: The app's words for its own concepts, so components read like the product: one app says "org", another "project" or "workspace".
  • agent-avatar: An agent's glyph and hue by role, so people can tell agents apart at a glance.
  • ai-disclosure: A plain notice that the person is interacting with an AI system: a first line in the thread (variant="line") or a compact "AI" badge for a thread header (variant="badge") that opens to the app's own explanation.
  • attachment-preview: A file waiting to be sent, as a chip in the composer: its name, then upload progress, an error, or its size, and a remove button.
  • card-registry: A card an agent's reply can carry.
  • citation: An inline [n] that opens its source in a popover, so evidence is one step away without leaving the thread.
  • composer: Where a person writes to the agent: @ mentions attach things as references, / starts a known action, and the scope says where the ask runs.
  • context-meter: What fills the model's context budget, as a ring in the composer that opens to a breakdown: system, instructions, Know, the thread, tools, files.
  • entity-chip: A thing in the user's system (a table, a record, a flow) as a chip with its kind's icon, that can open it.
  • folded-turns: A run of turns folded into one line, for long agent work a reader doesn't need to see step by step: "Drafted three versions and compared them".
  • message-actions: Copy, retry and rate under an agent's reply.
  • message-content: A message's typed blocks (paragraphs, lists, code, tool calls, cards), rendered as text, never as markdown or HTML.
  • message: One message in a thread.
  • payload: A block of code or query text from the agent: a query it ran, code it wrote, a config file.
  • permission-prompt: A tool call waiting for a person's go-ahead: what it will do, why it reached them, and the permission mode the run is in.
  • prompt-suggestions: Prompts to start from.
  • reasoning: The agent's stated reasoning above its answer.
  • thread-divider: A rule across the thread with a label in the middle: a day ("Today", "Yesterday", "5 Nov 2026") or a chapter of the conversation ("Drafting", "Review").
  • thread-event: A quiet, centred line in a thread for something that happened rather than something said: "Sam joined", "Switched to the staging environment", "Run stopped by a guardrail".
  • thread: The scrolling message column.
  • tool-call: One tool call as a compact row: what it did in plain words, its status, and how long it took.
  • chat: The data a Candor thread renders.
  • highlight: A small syntax highlighter for code an agent shows: it splits text into typed tokens (keyword, string, comment…), and Payload renders each as a span.
  • know: The data behind the agents' knowledge base and agent settings.
  • mcp-input: MCP's "input required" results (spec 2026-07-28, multi round-trip requests) as Candor data: a server's form becomes questions for ClarifyingQuestions, a plain confirmation or a link to open becomes a two-answer Decision for ApprovalDecision, and the person's answers become the inputResponses the client sends when it retries the call.
  • render-prop: Lets Candor's Radix-based primitives also take Base UI's render prop.
  • safe-markdown: Reads model text as safe markdown: paragraphs, lists and fenced code.
  • status: The status vocabulary every Candor agent component shares.
  • use-copy: Copy text and report what actually happened.
  • use-shortcut: The keys of a combo as they should be printed: "mod+k" → ["⌘", "K"] on a Mac and ["Ctrl", "K"] elsewhere.
  • use-virtual-list: Render only the items of a long list that are in or near view, for Thread's and SessionList's virtualize.
  • button: shadcn's button in Candor's theme, with a locked state for (dimmed, and says why).
  • collapsible: shadcn's collapsible (Radix) in Candor's theme.
  • popover: shadcn's popover (Radix) in Candor's theme.
  • skeleton: A loading placeholder in the shape of what's coming.
  • tooltip: shadcn's tooltip (Radix) in Candor's theme.

Pro and Premium

Plans, approvals, diffs, runs, evals, the app shell, admin screens, full-stack blocks and templates are in the paid tiers: https://candor.themethodic.com/#pricing.

Contributing

This repo is generated from Candor UI's main repo on each release. Issues are welcome here; pull requests are read and applied upstream by hand, so they show up in the next release rather than being merged directly.

Licence

MIT, © Methodic LLC. See LICENSE. It covers this repository's free items; Candor UI's paid items are under the Candor UI Commercial Licence.

Source: README.md at commit 2b0a37d

Tools

9

search_docs

Search Candor UI docs

Search Candor UI's components, hooks, blocks and patterns by what they do ("approve a tool call", "cost estimate", "session list"). Returns names, tiers and one-line descriptions; read one with get_component_docs.

Parameterstierlimitqueryrequired

get_component_docs

Read a Candor UI docs page

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.

Parametersnamerequired

suggest_components

Suggest Candor UI components for a task

Describe the screen or feature you're building; get the Candor UI items that fit, why, the matching patterns, and one install command. Read each suggestion's docs before using it.

Parameterstaskrequiredtier

list_components

List Candor UI components

List every item by group (Chat, Agent work, App shell, …), or one group's items with descriptions.

Parameterstiergroup

get_pattern

Read a Candor UI pattern

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

Parametersslugrequired

get_started

How to set up Candor UI

How to install Candor UI in a React or Next.js app, render a chat, connect an agent SDK, add licensed items and keep them updated.

Takes no parameters.

get_brief

A brief for a coding agent

One item's brief to hand to the coding agent that builds the screen: the same Markdown the docs page's "Copy for a coding agent" button copies (what the item is, its tier and install command, an example with the import paths an app uses, every prop, the string keys, and the rules to keep).

Parametersnamerequired

get_design

Candor UI's design system

The design system as Markdown: every colour role and what it's for, the type scale, radius, shadows, motion, density and themes, read from the shipped CSS; how an app re-tokens for its brand; and how to build the screens around Candor components (surfaces, rhythm, writing, do and don't).

Takes no parameters.

get_review_checklist

Review checklist for agent UI screens

The checklist to run after each screen where an AI agent acts, before moving on: one line per check, each tied to a rule (model output is text, unknown stays unknown, a locked control says why, nothing pre-selected, approve the exact change, reasoning is believed, the app names the agent, say what can be undone, plus status, progress and accessibility). From the candor-agent-ui skill; works with or without Candor.

Takes no parameters.

Version history

1
  1. v1.9.0LatestNov 8, 2026

Score

100% of the applicable checks met

How complete this listing is, computed from the registry entry, the endpoint and public sources. Not a rating of the server and not a statement that it is safe or working today: reachability is a dated check, and no installs or reviews go into the score.

  • Reached in the last 30 daysRequired25 pts
  • Auth declaredRequired10 pts
  • Tools listedRequired15 pts
  • DescriptionRequired15 pts
  • Logo10 pts
  • Documentation15 pts
  • License10 pts