Setup guide · Zed Industries

Set up CleenUI in Zed AI.

Zed calls them context_servers — add cleenui to ~/.config/zed/settings.json under that key.

AI toolZed AI

Zed supports MCP-style servers but uses its own naming: the top-level key is context_servers (not mcpServers). The Agent Panel in Zed surfaces tools from registered context_servers in every Assistant conversation. The shape of each entry is otherwise the standard MCP command/args/env.

Step by step

5 steps. About 5 minutes.

  1. 1

    Open Zed's settings

    Hit ⌘+, (Cmd+comma) to open settings.json. The file lives at ~/.config/zed/settings.json on macOS/Linux.

  2. 2

    Add cleenui under context_servers

    Note the key name — it's context_servers, not mcpServers. Zed uses its own naming convention but the entry shape is otherwise the standard MCP command/args/env.

  3. 3

    (Alternative) Use Zed's Add Custom Server modal

    Prefer a UI? Open the Agent Panel → Settings → 'Add Custom Server'. Zed walks you through the same fields and writes settings.json for you.

  4. 4

    Verify in the Agent Panel

    Open the Agent Panel — Zed shows a status dot next to each registered server. Green means connected. Hover for the list of available tools.

  5. 5

    Run setup from Zed's Assistant

    ⌘+? opens the Assistant panel. Tools from registered context_servers are part of the model's available actions — just ask.

Verify

Status dot

A green status dot next to cleenui in the Agent Panel means it's connected. Other colors indicate configuration issues — click for the error message.

Key name reminder
If you copy a config from Claude Code or Cursor, you'll need to rename the top-level key from mcpServers to context_servers. Zed is the only major editor that uses the context_servers naming.
Troubleshooting

If something doesn't work.

Settings JSON has syntax errors

Zed validates JSON live — look for the red squiggle indicator and fix the offending block.

Server doesn't connect

Click the failed entry in the Agent Panel — Zed surfaces the underlying error. Most often a Node version mismatch with what npx expects.

Get started

Get started with CleenUI.

Two paths to your first component. Pick the one that fits how your team builds.

Path A · Recommended

With AI agent skills

One prompt to your AI tool. The Setup skill handles dependencies, design tokens, build config, and component registration — all without leaving your editor.

Path B · Manual

With npm

The classic flow. Install the package, import the styles, drop in your first component. No agents required — same end result.