dev.brandpilot/brandpilot-mcp
BrandPilot brands and design systems for coding agents: tokens, design context, repo rules.
التثبيت
أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: .cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).
claude mcp add --transport http brandpilot-mcp 'https://brandpilot.dev/api/mcp' --header 'Authorization: <Bearer followed by a workspace API key from BrandPilot (Settings, API keys), e.g. "Bearer bp_live_...">'
{
"mcpServers": {
"brandpilot-mcp": {
"type": "http",
"url": "https://brandpilot.dev/api/mcp",
"headers": {
"Authorization": "<Bearer followed by a workspace API key from BrandPilot (Settings, API keys), e.g. \"Bearer bp_live_...\">"
}
}
}
}
brandpilot-mcpclaude mcp add brandpilot-mcp -e 'BRANDPILOT_API_KEY=<your brandpilot_api_key>' -e 'BRANDPILOT_MCP_URL=https://brandpilot.dev/api/mcp' -e 'BRANDPILOT_ORIGIN=https://brandpilot.dev' -- npx -y brandpilot-mcp@1.0.0
{
"mcpServers": {
"brandpilot-mcp": {
"command": "npx",
"args": [
"-y",
"brandpilot-mcp@1.0.0"
],
"env": {
"BRANDPILOT_API_KEY": "<your brandpilot_api_key>",
"BRANDPILOT_MCP_URL": "https://brandpilot.dev/api/mcp",
"BRANDPILOT_ORIGIN": "https://brandpilot.dev"
}
}
}
}
متغيرات البيئة
BRANDPILOT_API_KEYسري Workspace API key (bp_live_...) from BrandPilot. When set, the server proxies to the hosted BrandPilot MCP and serves its full tool list.BRANDPILOT_MCP_URLHosted MCP endpoint used with BRANDPILOT_API_KEY. Defaults to https://brandpilot.dev/api/mcp.BRANDPILOT_ORIGINBrandPilot origin for the public tools (API v2) and the base of the default BRANDPILOT_MCP_URL. Defaults to https://brandpilot.dev.
التوثيق
مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.
المحتويات
brandpilot-mcp
MCP server for BrandPilot: bring a brand into your coding agent - list your brands, read a design's context and continuation contract, install its repo rules pack and tokens, and fetch its design system kit - natively from Claude Code, Codex, Cursor, Claude Desktop or any other MCP client.
The package runs in one of two modes:
- With a workspace API key (
BRANDPILOT_API_KEY): a thin stdio proxy onto the hosted BrandPilot MCP athttps://brandpilot.dev/api/mcp. Everytools/list,tools/call,prompts/listandprompts/getis forwarded and the answer relayed, so the tool list is always the one BrandPilot serves today - new tools arrive without a package update. - Without one: the public design-system tools, served over the BrandPilot REST API v2 with no account and no key.
It never touches a database; any machine with network access to brandpilot.dev can run it. Requires Node.js 20 or newer.
Connect with an API key
Create a workspace API key in BrandPilot under Settings, API keys. It starts with bp_live_. Replace bp_live_your_key_here below with it, and keep it out of committed files.
Claude Code
claude mcp add brandpilot --scope user -e BRANDPILOT_API_KEY=bp_live_your_key_here -- npx -y brandpilot-mcp
Then run /mcp in Claude Code to confirm brandpilot is connected, and ask "Ask BrandPilot who I am and list my brands".
Codex
codex mcp add brandpilot --env BRANDPILOT_API_KEY=bp_live_your_key_here -- npx -y brandpilot-mcp
or in ~/.codex/config.toml:
[mcp_servers.brandpilot]
command = "npx"
args = ["-y", "brandpilot-mcp"]
[mcp_servers.brandpilot.env]
BRANDPILOT_API_KEY = "bp_live_your_key_here"
To keep the key out of the file, export BRANDPILOT_API_KEY in your shell and use env_vars = ["BRANDPILOT_API_KEY"] in place of the env table.
Cursor
Add to ~/.cursor/mcp.json (all projects) or .cursor/mcp.json (one project):
{
"mcpServers": {
"brandpilot": {
"command": "npx",
"args": ["-y", "brandpilot-mcp"],
"env": {
"BRANDPILOT_API_KEY": "bp_live_your_key_here"
}
}
}
}
Any other MCP client
Run npx -y brandpilot-mcp as a stdio server with BRANDPILOT_API_KEY in its environment. The same shape works in Claude Desktop's claude_desktop_config.json.
What the errors mean
| Message | Cause | Fix |
|---|---|---|
| BrandPilot rejected the API key (HTTP 401) | The key is mistyped, expired or revoked | Create a new key and restart the server |
| The API key does not have the permission this call needs (HTTP 403) | The key lacks a scope (for example a read-only key calling finish_external_design) | Use a key with that scope |
| The hosted BrandPilot MCP is not enabled (HTTP 404) | The hosted MCP is not switched on for that BrandPilot instance yet | Unset BRANDPILOT_API_KEY to use the public tools meanwhile, or check BRANDPILOT_MCP_URL |
| did not answer within N s | The hosted call took longer than BRANDPILOT_TIMEOUT_MS | Retry; raise the timeout for slow calls |
The key is sent only in the Authorization header and is never printed, including in error messages and on stderr.
Tools
In API-key mode the tools and prompts come from the hosted server (brands, design context, repo rules pack, design system kit, importing finished work back for review, and more); the current list is at https://brandpilot.dev/api/v2/mcp/tools and on brandpilot.dev/docs. A good first call is whoami.
Without a key the server serves these public tools, all over the BrandPilot REST API v2:
| Tool | Auth | What it does |
|---|---|---|
list_public_systems | none | List public design systems (name, display name, brand color, status, version, v2 endpoints) |
get_system_manifest | none | Full adoption manifest for a public system: tokens, components, pages, brand assets, direction |
export_system_tokens | none | Export a system's tokens (globals-css, colors-ts, spacing-ts, typography-ts, tailwind-theme, tailwind-v4, brand-manifest, dtcg) |
get_adoption_brief | none | Markdown onboarding doc: bootstrap a design package and run a design round (a Design canvas for Claude Code, local HTML drafts for other agents) |
Upgrading from 0.x
1.0.0 is a major release because tools and a variable were removed. BrandPilot API v1 and the per-design handoff keys stop answering on 2026-12-15 (HTTP 410), so every 0.x install loses its keyless calls that day; upgrade before then.
- The public tools now call API v2 (
/api/v2/..., and/api/v2/systems/{name}/exportfor tokens) instead of API v1 and/api/systems/export/{name}, and take the v2 names the hosted server uses:list_systemsis nowlist_public_systems,get_system_adoptionisget_system_manifest,get_system_tokensisexport_system_tokensandget_agent_promptisget_adoption_brief. Arguments are unchanged;export_system_tokensalso acceptstailwind-v4anddtcg. get_adoption_briefreturns the new v2 brief: a design round on a Design canvas (Claude Code) or local HTML drafts (other agents), instead of the Claude Design steps.get_design_handoff,get_design_prompt_pack,import_design_artifactsandfinish_external_designare removed from the keyless server, andDESIGNFLOW_HANDOFF_KEYis no longer read (a leftover value only prints one line asking you to remove it). Their v2 successors (get_design_context,get_design_brief,import_design_work,finish_design_import) are served by the hosted MCP: create a workspace API key in BrandPilot (Settings, API keys) and setBRANDPILOT_API_KEY, see Connect with an API key.- The Claude Design prompt pack is gone with it: claude.ai/design closes on 2026-12-14. The hosted tools return a design's context and repo rules pack for building in your own repo instead.
brandpilot-mcp/catalognow exports the four public tools only, with their v2 endpoints.
Environment variables
| Variable | Default | Purpose |
|---|---|---|
BRANDPILOT_API_KEY | (none) | Workspace API key; turns on proxy mode |
BRANDPILOT_MCP_URL | ${BRANDPILOT_ORIGIN}/api/mcp | Hosted MCP endpoint in proxy mode. Must be https, except on localhost |
BRANDPILOT_TIMEOUT_MS | 70000 | Per-request timeout in proxy mode (1000 to 600000) |
BRANDPILOT_ORIGIN | https://brandpilot.dev | Origin for the public tools, and the base of the default BRANDPILOT_MCP_URL - override to point at a local dev server |
Local development
npm install
npm run build
npm test
The e2e tests drive the built server against a fake origin that answers API v2 and returns 410 on every v1 path. To run them against a local BrandPilot instead, set BRANDPILOT_E2E_ORIGIN=http://localhost:3005 (any origin that serves API v2) before npm test.
npm link then an MCP config pointing at the linked bin is the fastest way to verify against a live server: in API-key mode confirm whoami names your workspace; without a key confirm list_public_systems returns the curated pool and nothing private.
See CHANGELOG.md for release notes.
الأسئلة الشائعة
ما هو dev.brandpilot/brandpilot-mcp؟
BrandPilot brands and design systems for coding agents: tokens, design context, repo rules.
كيف أثبّت dev.brandpilot/brandpilot-mcp؟
يعمل كخادم بعيد. في Claude Code: claude mcp add --transport http brandpilot-mcp 'https://brandpilot.dev/api/mcp' --header 'Authorization: <Bearer followed by a workspace API key from BrandPilot (Settings, API keys), e.g. "Bearer bp_live_...">'. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.
هل يحتاج dev.brandpilot/brandpilot-mcp إلى مفتاح API؟
نعم. يتطلب BRANDPILOT_API_KEY, Authorization، وتضبطها في إعداداته.
هل dev.brandpilot/brandpilot-mcp مفتوح المصدر؟
نعم. شيفرته متاحة على GitHub بترخيص MIT.
من يصون dev.brandpilot/brandpilot-mcp؟
ينشره aquaminh. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.
من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.