Start a brand system
brand_startAdopt existing brand guidelines from PDFs, websites, Figma libraries, or hosted sources into a portable .brand runtime; use auto mode to extract, compile tokens, and generate reports in one call.
Instructions
Adopt a brand into a portable .brand/ runtime from whatever source already exists: existing brand guidelines (PDF), a website URL, a Figma library, or a hosted Brandcode Studio brand. THE entry point when the user says 'use my existing brand guidelines with AI', 'I have a PDF brand guide', 'use our Figma library', 'create a brand system', 'extract brand from website', or 'set up brand guidelines'. Pass website_url, guideline_pdf, figma_file_key, or brandcode_url — or pass no source and it discovers local candidates and presents a menu with a privacy explanation. Set mode='auto' with a website_url to run the full pipeline (extract, compile DTCG tokens + design-synthesis.json + DESIGN.md + brand runtime + interaction policy, generate HTML report) in one call. If .brand/ already exists, returns current status with next steps. NOT for reading an already-compiled brand (use brand_runtime or brand_context) or for sharing an existing brand with a team (use brand_brandcode_connect).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | 'auto' (recommended): runs full pipeline in one call when website_url is provided. 'interactive': assesses available sources (including files discovered in the working directory) and presents a source menu. | interactive |
| industry | No | Industry vertical for smarter extraction (e.g. 'fintech', 'healthcare', 'content marketing') | |
| client_name | Yes | Company or brand name (e.g. 'Acme Corp') | |
| website_url | No | Company website URL to extract brand identity from (e.g. 'https://acme.com') | |
| brandcode_url | No | Brandcode Studio brand URL for adopting an existing hosted brand (e.g. 'https://brandcode.studio/start/brands/acme'). Routes adoption through brand_brandcode_connect. | |
| guideline_pdf | No | Path to a PDF brand guideline in or under the working directory (e.g. './brand-guidelines.pdf'). Routes adoption through brand_extract_pdf. | |
| figma_file_key | No | Figma file key for design-file extraction. Routes adoption through brand_extract_figma. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _metadata | Yes |