Guides

Connect your agent

Your coding agent can read your brand (colors, type, logo files, finished designs) straight from BrandPilot over MCP, the standard way AI apps add tools. You set it up once per computer with one API key.

Before you start

A BrandPilot account with at least one brand.
An API key from Settings, API keys. Workspace owners and admins can create keys; the key is shown once, so copy it before you close the dialog. See API keys.

Set up your app

Pick your app, follow the steps and replace YOUR_API_KEY with your key.

Add BrandPilot to Claude Code once; every project on this computer can use it.

Create an API key, then run this in your terminal with YOUR_API_KEY replaced by the key.
Start Claude Code and run /mcp to check that brandpilot shows as connected.

Run in your terminal

claude mcp add --transport http --scope user brandpilot https://brandpilot.dev/api/mcp --header "Authorization: Bearer YOUR_API_KEY"

Another app that only runs local servers? Use the brandpilot-mcp npm package with your API key in its environment. It connects to the same account and tools.

Local server config

{
  "mcpServers": {
    "brandpilot": {
      "command": "npx",
      "args": [
        "-y",
        "brandpilot-mcp"
      ],
      "env": {
        "BRANDPILOT_API_KEY": "YOUR_API_KEY"
      }
    }
  }
}

Test prompt

test prompt

Ask BrandPilot who I am and list my brands.

Check the connection

Send the test prompt above. Your agent calls whoami, which names your workspace and the key, then lists your brands. If that works, ask it to set up a design in your repo: it calls get_repo_rules_pack and writes the rules files your agent follows while it builds.

If it does not connect

What you see	What to check
brandpilot shows as failed or 401	The key was pasted with a space or a missing character, or it was revoked. Create a new key and paste it again.
A tool answers 403	The key lacks the permission that tool needs. The tool list names it per tool.
A design answers 404	The design belongs to another workspace. A key only reaches its own workspace.