Brand Peel Developer Portal: API, CLI, and MCP
Quickstart
Call Brand Peel endpoints with cURL, TypeScript, or Python. Every endpoint supports CORS and content negotiation.
curl -s https://brandpeel.app/api/v1/tools?category=Design%20System \
-H "Accept: application/json"
Request JSON, or send Accept: text/markdown to get the same content in Markdown.
import { fetch } from 'undici'
// Fetch public tools catalog
const response = await fetch('https://brandpeel.app/api/v1/tools')
const data = await response.json()
console.log('Available Brand Peel tools:', data.total)
Generate a typed client from /openapi.json if you want TypeScript types. The spec itself is OpenAPI 3.1 JSON, not a .d.ts file.
import requests
# Fetch OpenAPI spec or brand guide schema
schema = requests.get("https://brandpeel.app/api/v1/brand-guide/schema").json()
print("Brand Package Title:", schema["title"])
Load the JSON schemas and wire token exports into your CI/CD pipeline.
Public REST API reference
These public, unauthenticated endpoints are ready for apps, agents, and development scripts.
Check API and agent service health
Returns operational status, version, and links to machine-readable agent discovery documents.
Retrieve latest desktop release downloads
Get download URLs and checksums for Windows (setup/portable x64), macOS (universal DMG), and Linux.
List and search 190+ free branding utilities
Filter by category (Design System, Positioning, etc.) or search keywords.
Get a single tool catalog entry
Name, summary, category, outcome, URL, and keywords for one tool. This is catalog metadata, not a calculation API.
JSON Schema for brand packages & tokens
Standardized JSON Schema draft 2020-12 for color palettes, typography, and theme exports.
Agent capabilities & function calling specs
Machine-readable decision criteria and LLM function calling definitions.
CLI commands & execution manifest
Command definitions for scripting brand token transformations.
Brand Peel CLI tool
Inspect a desktop export, check contrast, compile tokens, and read the public API from your terminal.
Package:@merginit/brandpeel
Official CLI published on npm. Use npx without a permanent install, or install globally.
# Export brand tokens to Tailwind CSS v4 variables
npx @merginit/brandpeel export ./my-brand-export --format tailwind-v4 -o ./src/theme.css
# Validate a Brand Peel desktop export and check WCAG 2 contrast
npx @merginit/brandpeel doctor ./my-brand-export --strict
# Compile identity.md, visual.md, and guidelines.md into repo documentation
npx @merginit/brandpeel compile-book ./my-brand-export -o ./BRAND.md
Model Context Protocol (MCP)
A stdio mode of the same CLI. Cursor, Claude Desktop, Windsurf, or Antigravity spawn it as a local process.
Add this block to Cursor's mcp.json or Claude Desktop's claude_desktop_config.json. MCP is a mode of @merginit/brandpeel, not a separate npm package.
{
"mcpServers": {
"brandpeel": {
"command": "npx",
"args": ["-y", "@merginit/brandpeel", "mcp"]
}
}
}
The process speaks MCP over stdin/stdout and wraps the CLI you already have: inspect and doctor a desktop export, export tokens, compile BRAND.md, and call the public API. It does not generate palettes from scratch.
API versioning & deprecation policy
This is how versioning and deprecation work for developers, agents, and automation scripts.
URL versioning
Production endpoints live under /api/v1/. Breaking schema changes will be introduced under a new version prefix (/api/v2/).
90-day sunset window
A deprecated endpoint stays available for at least 90 calendar days after the official announcement.
RFC response headers
Every API response includes X-API-Version: 1.0.0 and a Link to this policy. Deprecated resources add an RFC 9745 Deprecation: @timestamp header; a scheduled retirement also adds an RFC 8594 Sunset HTTP-date.