brandrail 0.9.0 → 0.10.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Thiago Baptistella (Brandrail)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -21,6 +21,34 @@ npx brandrail check --changed --upload    # only changed lines, results in the d
 Brandrail only ever receives its hash, and the files it writes into the repo hold no key. AI tools start
 `npx brandrail mcp`, which checks code on your machine: code is never uploaded. In CI, set `BRANDRAIL_KEY` instead.
 
+## MCP server
+
+`brandrail mcp` is an MCP server for Claude Code, Cursor, Copilot, Codex, Windsurf and any other MCP client.
+It runs on your machine over stdio; code is checked locally and never uploaded. It works without an account,
+using starter tokens; connect an account (or set `BRANDRAIL_KEY`) to use your own Brand Kit.
+
+```json
+{
+  "mcpServers": {
+    "brandrail": { "command": "npx", "args": ["-y", "brandrail", "mcp"] }
+  }
+}
+```
+
+`npx brandrail connect` writes this config for you, plus the rule files each AI tool reads.
+
+| Tool | What it does |
+| --- | --- |
+| `get_guidelines` | The project's design system rules: components to use in its framework, allowed tokens, what the checker enforces. Called once before writing UI. |
+| `get_design_tokens` | Every colour, spacing, radius and type token with the CSS variable to use. |
+| `find_component` | Finds the component for a need ("date picker", "primary action") with its import, rules and an example. |
+| `get_component_docs` | Full docs for one component in the project's framework: import or tag, props, rules, example. |
+| `get_template` | A whole page (list, detail, form, settings, dashboard, sign-in) built from your components, with the files to create and the page's rules. |
+| `get_migration_map` | What replaces each piece of Material, MUI, Bootstrap, Ant, Chakra or PrimeNG. |
+| `validate_snippet` | Runs the checker on generated code and returns a brand score and each fix. |
+
+All tools are read-only. Docs: https://www.brandrail.com.au/docs/connect
+
 ## Commands
 
 | Command | |
@@ -37,3 +65,7 @@ Brandrail only ever receives its hash, and the files it writes into the repo hol
 | `whoami`, `logout` | Show or remove the saved sign-in |
 
 Nothing is uploaded unless you pass `--upload`, and code snippets are never uploaded.
+
+## Licence
+
+MIT. The Brandrail web app and dashboard are a separate, paid service: https://www.brandrail.com.au/pricing