Developer Resources | Brand Peel Docs

Brand Peel provides machine-readable APIs, an official CLI tool, and open schemas designed for software developers and AI agents.

Public REST API Endpoints

All public API endpoints are served from https://brandpeel.app with CORS enabled, rate-limit metadata, X-API-Version, and a lifecycle-policy link.

Endpoint	Method	Purpose	Documentation
`/api/v1/health`	`GET`	Health check & agent discovery URLs	Health Details
`/api/v1/release/latest`	`GET`	Current desktop app downloads & checksums	Releases
`/api/v1/tools`	`GET`	190+ free branding & color utilities	Tools API
`/api/v1/tools/{slug}`	`GET`	Single tool catalog entry (metadata, not a calculator)	Tool Slug API
`/api/v1/brand-guide/schema`	`GET`	JSON Schema for design token exports	Token Schema
`/api/v1/agent-info`	`GET`	Agent guidance & function calling	Agent Info
`/api/v1/cli/manifest`	`GET`	Official CLI tool execution manifest	CLI Manifest

OpenAPI 3.1 Specification

The official OpenAPI 3.1 schema is published at:

JSON: https://brandpeel.app/openapi.json
YAML: https://brandpeel.app/openapi.yaml

Official CLI Tool

The CLI is published on npm as @merginit/brandpeel. Source code is at merginit/unpeeled.cli.

Inspect a desktop export, check contrast, compile tokens, and read the public API without a permanent install:

# Export brand tokens to Tailwind CSS v4 variables
npx @merginit/brandpeel export ./my-brand-export --format tailwind-v4 -o ./src/theme.css

# Validate the desktop export and report WCAG 2 contrast
npx @merginit/brandpeel doctor ./my-brand-export --strict

# Compile identity.md, visual.md, and guidelines.md
npx @merginit/brandpeel compile-book ./my-brand-export -o ./BRAND.md

Model Context Protocol (MCP)

MCP is a stdio mode of that CLI, not a separate npm package. Cursor, Claude Desktop, Windsurf, and similar clients spawn npx @merginit/brandpeel mcp and talk JSON-RPC over stdin/stdout.

Add this to Cursor's mcp.json or Claude Desktop's claude_desktop_config.json:

{
  "mcpServers": {
    "brandpeel": {
      "command": "npx",
      "args": ["-y", "@merginit/brandpeel", "mcp"]
    }
  }
}

That process wraps the same commands as the CLI: 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

Semantic Versioning: All production endpoints are scoped under /api/v1/. Breaking changes will only occur under /api/v2/.
90-Day Sunset Window: Deprecated endpoints remain fully operational for at least 90 days before retirement.
Lifecycle Headers: Every response links to the policy. A deprecated resource adds the RFC 9745 Deprecation: @<unix-timestamp> header; a scheduled retirement also adds an RFC 8594 Sunset HTTP-date.