What it does
Enforce brand writing guidelines in Claude Code — PostToolUse hook + MCP server
- Connects 在你的电脑上运行
- Account or key No key needed
- Category 营销与社交媒体
可搭配使用
教 AI 做这类工作的 Skill,可与本项一起使用
为什么排在这里
列表按使用分(满分 100)排序,由以下部分组成
| 热度 | 0/80 | GitHub 星标或每周下载量:较大的计 60,较小的计 20 |
|---|---|---|
| 新鲜度 | 3/12 | 30 天内有发布或代码更新得满分 |
| 仍在响应 | 0/8 | 上次检查时云端端点有响应 |
| 使用分 | 3/100 |
质量: 基础检查通过 3/3 项(仅展示,不用于排序) · 上升势头: 暂无数据 (只用于“上升中”标签)
安装
选择你使用的 AI 应用,然后复制设置。
用一句话让 AI 帮你安装
请帮我安装 Brand Voice。按照 https://mcp.popnx.com/i/zoharbabin-brand-voice.md 操作,先把命令给我看,等我同意后再运行。粘贴到能在你电脑上工作的 AI(如 Claude Code、Cursor)。它会读取我们的步骤,先给你看命令,等你同意。无需密钥,无需注册。 · 查看 AI 会读取的全文
通过 3/3 项检查 · 在你的电脑上运行 · ✓ 命令已检查 2026年11月13日
第一步:你用哪个 AI?
选择你用的应用,步骤会显示在下方。
可连接 Claude,但需要先准备
需要先在电脑上安装 Node.js(只需一次) · 仅限电脑上的 Claude 应用(Windows 或 Mac),网页和手机不可用
让 AI 帮你安装
把这段话复制到 Claude 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Claude 安装 MCP server Brand Voice,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "mcpServers": { "brand-voice": { "command": "npx", "args": [ "-y", "brand-voice" ] } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 Brand Voice 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 Node.js(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -v- 显示版本号(例如 v26.13.1)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
node -v安装一次,所有需要 Node.js 的工具都能用
打开电脑版 Claude 应用的设置文件
SettingsDeveloperEdit Config
粘贴这些设置并保存文件
{ "mcpServers": { "brand-voice": { "command": "npx", "args": [ "-y", "brand-voice" ] } } }退出 Claude 再重新打开
试一试
用 Brand Voice 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Claude 说正在使用 Brand Voice,或回答中出现 Brand Voice 的工具名称,就表示连接成功
菜单名称已于 2026年11月11日 对照 Anthropic 帮助页面核实 · 你的界面可能因版本略有不同
ChatGPT 暂时无法连接 Brand Voice
Brand Voice 需要安装在你的电脑上,而 ChatGPT 只能连接在网上运行的服务器
你可以改用这些方式
A · 使用能连接 Brand Voice 的应用
- 需要先在电脑上安装 Node.js(只需一次) · 仅限电脑上的 Claude 应用(Windows 或 Mac),网页和手机不可用
- 需要先在电脑上安装 Node.js(只需一次)
- 需要先在电脑上安装 Node.js(只需一次)
- 需要先在电脑上安装 Node.js(只需一次)
B · 营销与社交媒体 类中能连接 ChatGPT 的其他服务器
从同类中使用较多的里挑选,仅限用地址即可连接、无需密钥的
- Google Ads + Meta Ads + SEO/GEO MCP✓ ChatGPT
- Cargo✓ ChatGPT
- NotFair✓ ChatGPT
可连接 Claude Code,但需要先准备
需要先在电脑上安装 Node.js(只需一次)
让 AI 帮你安装
把这段话复制到 Claude Code 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Claude Code 安装 MCP server Brand Voice,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):claude mcp add --scope user brand-voice -- npx -y brand-voice 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 Brand Voice 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 Node.js(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -v- 显示版本号(例如 v26.13.1)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
node -v安装一次,所有需要 Node.js 的工具都能用
打开终端
Mac:按 Command+空格,输入 Terminal · Windows:打开 PowerShell
粘贴这条命令并按 Enter
claude mcp add --scope user brand-voice -- npx -y brand-voice在 Claude Code 中输入 /mcp
应能看到 Brand Voice 在列表中并显示已连接
试一试
用 Brand Voice 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Claude Code 说正在使用 Brand Voice,或回答中出现 Brand Voice 的工具名称,就表示连接成功
菜单名称已于 2026年11月11日 对照 Anthropic 帮助页面核实 · 你的界面可能因版本略有不同
可连接 Cursor,但需要先准备
需要先在电脑上安装 Node.js(只需一次)
让 AI 帮你安装
把这段话复制到 Cursor 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Cursor 安装 MCP server Brand Voice,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "mcpServers": { "brand-voice": { "command": "npx", "args": [ "-y", "brand-voice" ] } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 Brand Voice 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 Node.js(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -v- 显示版本号(例如 v26.13.1)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
node -v安装一次,所有需要 Node.js 的工具都能用
在 Cursor 中以 Agent 模式打开 AI 聊天
试一试
用 Brand Voice 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Cursor 说正在使用 Brand Voice,或回答中出现 Brand Voice 的工具名称,就表示连接成功
菜单名称已于 2026年11月11日 对照 Cursor 帮助页面核实 · 你的界面可能因版本略有不同
可连接 VS Code,但需要先准备
需要先在电脑上安装 Node.js(只需一次)
让 AI 帮你安装
把这段话复制到 VS Code 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 VS Code 安装 MCP server Brand Voice,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "servers": { "brand-voice": { "type": "stdio", "command": "npx", "args": [ "-y", "brand-voice" ] } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 Brand Voice 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 Node.js(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -v- 显示版本号(例如 v26.13.1)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
node -v安装一次,所有需要 Node.js 的工具都能用
在 VS Code 中以 Agent 模式打开 AI 聊天
试一试
用 Brand Voice 告诉我你能帮我做什么,然后做一件给我看✓ 如果 VS Code 说正在使用 Brand Voice,或回答中出现 Brand Voice 的工具名称,就表示连接成功
菜单名称已于 2026年11月11日 对照 VS Code 帮助页面核实 · 你的界面可能因版本略有不同
开发者专用:终端命令和 JSON 设置
安装在电脑上
Claude Code
claude mcp add --scope user brand-voice -- npx -y brand-voiceClaude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"brand-voice": {
"command": "npx",
"args": [
"-y",
"brand-voice"
]
}
}
}Cursor (~/.cursor/mcp.json)
{
"mcpServers": {
"brand-voice": {
"command": "npx",
"args": [
"-y",
"brand-voice"
]
}
}
}VS Code (mcp.json)
{
"servers": {
"brand-voice": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"brand-voice"
]
}
}
}这些设置是根据作者在注册中心的条目生成的。如果 README 的写法不同,请以 README 为准。
一览
哪些应用可以使用它
依据这个服务器的连接方式和各应用自己的文档,检查于 2026年11月10日。
在你的电脑上运行,适用于
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
它能做什么
它在你的电脑上运行;安装后,工具列表会显示在你的 AI 应用中。
基础检查i
我们检查的是任何人都能看到的信息;我们没有阅读代码。不适用的检查项不计入总数。 · 检查于 2026年11月19日
- ✓ 通过
作者与仓库一致
注册名称已通过 GitHub 账户 zoharbabin 验证,该账户拥有此仓库
- ✓ 通过
仍在维护
代码最后更新于5个月前
- ✓ 通过
有许可证
使用 MIT
- – 不适用
端点有响应
它在你的电脑上运行,没有互联网端点
- – 不适用
使用 OAuth 登录
在你的电脑上运行,改用本地设置
- … 尚未检查
工具描述中没有隐藏指令
它在你的电脑上运行;我们只能读取互联网端点的工具列表
已公开的漏洞(OSV.dev)
OSV.dev 中没有 brand-voice@0.1.8 的记录
只检查这个版本的包本身,不包括所有依赖 · 检查于 2026年11月16日
作者:申请重新检查或报告信息错误
给作者:在 README 中加徽章
如果你是作者,可把这段代码贴到 README。徽章会链接回本页。
[](https://mcp.popnx.com/en/servers/zoharbabin-brand-voice)讨论
提问、分享技巧或报告无法使用。按“有帮助”数量排序。
用户评价
还没有评价
与“营销与社交媒体”中的其他服务器比较i
- 星标数多于此分类中其他 4190 个服务器的 0%
- 发布到注册中心的时间比此分类中其他 4190 个服务器的 12% 更新
- 基础检查结果等于或优于此分类中其他 4190 个服务器的 99%
与注册中心里这个分类中所有活跃的服务器比较。只有当发布者拥有该仓库时,星标数才计入。
常见问题
Brand Voice 安全吗?
它在 3 项适用的基础检查中通过了 3 项。我们没有阅读代码。在添加密钥或令牌之前,请先看看这个服务器要求哪些权限,并使用只具备所需权限的密钥。
它需要哪些密钥或代码?
注册中心没有列出必需的密钥,不过有些服务器会在首次使用时要求你登录。
它在我的电脑上运行还是在云端?
它在你的电脑上运行。你的 AI 应用会在需要时启动它,数据不会经过作者的服务器(除非它自己调用在线服务)。
它还在维护吗?
GitHub 仓库最后更新于5个月前,最新版本(0.1.8)于5个月前进入注册中心。
哪些应用可以使用它?
支持 MCP 的应用,例如 Claude Desktop、Claude Code、Cursor 和 VS Code。你的电脑上还需要有 Node.js。
有什么可以替代它?
同一分类中有:Relaticle, ChatbotX, X (Twitter) MCP Server by Xquik, Betterlytics, BibiGPT YouTube Video Summarizer
功能相近的其他选择
同一分类、其他作者、命令已通过检查。官方的排在前面,再按星标排序。
如何看卡片:↓ 每周下载量i★ GitHub 星标i三大支柱:评价 · 检查 · 使用情况i更新 = 最新版本发布到注册中心的时间i
Relaticle
Open-source CRM your AI agents can write to: companies, people, opportunities, tasks and notes.
ChatbotX
Omnichannel customer messaging, CRM contacts, flows, sequences, broadcasts, and AI automation.
X (Twitter) MCP Server by Xquik
Xquik is the world's fastest and cheapest X (Twitter) data API with the most complete X data.
Betterlytics
Query your Betterlytics web analytics from AI agents: traffic, funnels, journeys, errors, uptime.
BibiGPT YouTube Video Summarizer
AI video summarizer: summarize and transcribe YouTube, Bilibili, TikTok and podcast videos.
| 本项 Brand Voice | Relaticle | ChatbotX | X (Twitter) MCP Server by Xquik | Betterlytics | BibiGPT YouTube Video Summarizer | |
|---|---|---|---|---|---|---|
| 运行位置 | 需要安装在电脑上 | 在云端运行,无需安装 | 在云端运行,无需安装 | 在云端运行,无需安装 | 在云端运行,无需安装 | 在云端运行,无需安装 |
| 需要密钥 | 否 | 否 | 否 | 否 | 是 | 否 |
| 可在 Claude 中按 + 添加 | 否 | 否 | 否 | 否 | 否 | 否 |
| 基础检查 | 3/3 | 4/4 | 4/4 | 4/4 | 4/4 | 4/4 |
| 许可证 | MIT | AGPL-3.0 | NOASSERTION | MIT | AGPL-3.0 | MIT |
| 价格 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 |
作者的 README
打开 README
按原文从作者的仓库复制。PopNx MCP 没有审查或背书其内容。HTML、图片和脚本已被移除。链接会离开本站。
brand-voice
Brand writing enforcement for Claude Code — automatic, configurable, zero-friction.
Every time Claude writes or edits a Markdown file, brand-voice checks it against your brand guidelines and signals Claude to fix violations before the file saves. No manual review. No rule reminders in every prompt.
Claude reads the violation list, corrects the file, and retries the write — automatically.
Why brand-voice?
Your brand guidelines live in a doc somewhere. Claude doesn't read them unless you paste them into every prompt. Even then, the rules drift over time.
brand-voice makes the rules structural:
- Works for any company — configure your own vocabulary, voice, and visual identity
- Auto-corrects, doesn't just report — the PostToolUse hook blocks bad writes and triggers a retry
- Covers the full stack — hook for Claude Code, MCP server for on-demand checks, CLI for CI pipelines
- Smart about code — ignores fenced blocks, indented code, inline code spans, and table cells
- Escape hatches —
.brand-voice-ignorefor whole files,for individual lines - Visual identity included — colors, fonts, logo URLs live in the same guidelines file
Install
npm install -g brand-voice
Or run without installing:
npx brand-voice@latest check
Requires Node.js 18+.
Quick Start
Option A — Guided setup in Claude Code (recommended)
Run the setup skill inside any Claude Code session:
/brand-voice-setup
The skill does everything:
- Asks whether you have existing brand docs or want to answer four questions
- Optionally researches your brand automatically via web
- Writes
brand-guidelines.mdto your project - Injects a summary block into
CLAUDE.md - Registers the PostToolUse hook in
.claude/settings.json - Registers the MCP server in
.mcp.json
After setup, every .md and .mdx file Claude touches is checked automatically.
Option B — Manual setup
# 1. Install
npm install -g brand-voice
2. Create brand-guidelines.md in your project root (see schema below)
3. Register the hook
brand-voice setup
How It Works
Three components work together:
| Component | What it does |
|---|---|
PostToolUse hook (brand-voice-check) | Runs after every Write/Edit/MultiEdit on .md/.mdx; exits 2 with violations so Claude auto-corrects, exits 0 when clean |
MCP server (brand-voice-mcp) | Exposes analyze_readability and apply_suggestions for on-demand analysis and word-level fixes |
CLI (brand-voice) | Standalone checker for CI pipelines, ratchet baselines, and GitHub PR annotations |
What gets checked
| Rule | Severity | Description |
|---|---|---|
| Forbidden terms | error | Whole-word, case-insensitive match — blocks the write |
| Avoid terms | warning | Same matching — signals a preferred alternative |
| Sentence length | warning | Configurable max words per sentence (default: 25) |
| Passive voice | warning | Auxiliary + past-participle pattern detection |
| Readability grade | warning | Flesch-Kincaid grade per sentence vs. your target |
Code blocks, inline code, indented blocks, and table rows are never checked — only prose.
Never checked: physical line length or line breaks. The CLAUDE.md injection always includes a formatting rule telling Claude to write continuous paragraphs and let the renderer word-wrap, but the analyzer itself has no line-width rule and never will — sentence length is measured in words, not characters or lines, so hard-wrapped and unwrapped prose score identically.
PostToolUse hook exit codes
| Code | Meaning |
|---|---|
0 | No violations — file accepted |
2 | Violations found — Claude reads output, corrects, and retries |
Exit 1 is never used (it aborts the session rather than triggering a retry).
brand-guidelines.md
One Markdown file holds your entire brand configuration. Keep it under 600 words so it fits cleanly in context.
# Brand Guidelines
Persona
Who you are and who you write for.
Tone & Voice
- Direct, honest, clear
- Person: second ← "first" | "second" | "third"
- Voice: active ← "active" | "passive"
- Sentences: max 25 words
- Contractions: yes ← "yes" | "no"
- Exclamation marks: no
Vocabulary
Always use: Acme, Acme Platform, APIs Avoid: leverage, utilize, synergy, seamless Forbidden: [competitor names, unverified claims]
On-Tone Examples
Connect your data in minutes — Acme handles the routing.
Off-Tone Examples
Leverage our cutting-edge platform to seamlessly integrate.
Visual Identity
- Primary color: #006EFA
- Secondary color: #0050C3
- Accent color: #FF9DFF
- Background color: #FFFFFF
- Text color: #282828
- Logo (light): https://cdn.example.com/logo-light.svg
- Logo (dark): https://cdn.example.com/logo-dark.svg
- Heading font: Inter
- Body font: Source Sans Pro
Formatting Rules
- Heading style: sentence case
- Oxford comma: yes
- Readability target: 8th grade
Quick Reference
Repeat your top 5 rules here. This section appears last — where LLM attention is highest — to reinforce critical rules against context-window attention drop-off.
See example/brand-guidelines.md for a complete working example.
Section aliases
## On-Brand Examples and ## Off-Brand Examples are accepted as aliases for ## On-Tone Examples / ## Off-Tone Examples. All other section names are case-insensitive exact matches.
Search path
The hook and CLI search for brand-guidelines.md in this order:
- Current working directory
~/.claude/brand-guidelines.md(user scope — enforces rules across all your projects)- Parent directories up to the git root
Suppressing Violations
Skip files or directories — .brand-voice-ignore
Create a .brand-voice-ignore file in your project root. Uses gitignore-style patterns:
# Auto-generated content
dist/ CHANGELOG.md
Agent prompt files — intentional brand vocabulary exceptions
data/prompts/**
Vendor docs
vendor/
Skip a single line — inline comment
<!-- brand-voice-disable-line -->
Add this comment anywhere on a line to suppress all violations on that line. Useful for one-off exceptions where the violation is intentional.
MCP Server
analyze_readability
Check a file or inline text for violations and readability scores.
Inputs:
| Field | Type | Required | Description |
|---|---|---|---|
file | string | one of file/text | Absolute or relative path to a .md/.mdx file |
text | string | one of file/text | Inline Markdown to analyze |
cwd | string | no | Working directory for locating brand-guidelines.md |
Returns: { filePath, passed, violations[], readabilityScores, visualIdentity }
apply_suggestions
Apply safe word-level substitutions for forbidden/avoid terms. Does not fix sentence length, passive voice, or grade — those need human judgment.
Inputs:
| Field | Type | Required | Description |
|---|---|---|---|
file | string | yes | Path to the file to fix |
dryRun | boolean | no | Preview diff without writing (default: false) |
Returns: diff + change list (dry run) or confirmation + change list (live)
Tip: Run dryRun: true first to preview, then apply.
CI Integration
brand-voice works independently of Claude Code — add it to any pipeline.
Check all `.md` files:
npx brand-voice@latest check
Check only files changed in the current branch:
npx brand-voice@latest check --changed-only
GitHub Actions inline annotations (PR diff comments):
npx brand-voice@latest check --reporter github-pr-review
Ratchet enforcement — block regressions without requiring a clean slate:
# Run once, commit the file
npx brand-voice@latest baseline --save
In CI: fail only if violations increase above baseline
npx brand-voice@latest check --baseline .brand-voice-baseline.json
Example GitHub Actions workflow:
name: Brand Voice
on: pull_request: paths: ['.md', '.mdx']
jobs: prose: runs-on: ubuntu-latest steps:
- uses: actions/checkout@v4 with: { fetch-depth: 0 }
- run: npx brand-voice@latest check --changed-only --reporter github-pr-review
Exit 0 = clean or within baseline. Exit 1 = errors found or baseline exceeded.
CLI Reference
brand-voice <command> [options]
Commands: check [file] Check a file or all .md files in cwd setup Print instructions to run /brand-voice-setup in Claude Code import Normalize a brand-guidelines.md into cwd baseline --save Save current violation count as ratchet baseline vale-sync Check that the Vale binary is available
Check options: --changed-only Only check files changed in git (requires git) --baseline Compare against a baseline JSON file (ratchet check) --reporter github-pr-review Emit GitHub Actions annotation format
Programmatic API
import { parseGuidelines, analyzeText, loadGuidelines } from 'brand-voice';
const guidelines = loadGuidelines(process.cwd()); if (guidelines) { const result = analyzeText(markdownString, 'doc.md', guidelines); console.log(result.violations); // Violation[] console.log(result.readabilityScores); // ReadabilityScores console.log(result.passed); // false if any error-severity violations }
See src/types.ts for full type definitions.
Distribution Patterns
| Scenario | What to do |
|---|---|
| Solo developer | Run /brand-voice-setup once per project; commit brand-guidelines.md |
| Team | Commit brand-guidelines.md, .claude/settings.json, and .mcp.json; teammates get enforcement on git pull |
| Global (all projects) | Run /brand-voice-setup with the global flag; writes to ~/.claude/brand-guidelines.md |
| claude.ai (browser) | Setup skill outputs a paste block for Claude Project instructions — no hook or MCP needed |
| Enterprise / CI | Use brand-voice check in pipelines; commit .brand-voice-baseline.json for ratchet enforcement |
Requirements
- Node.js 18+
- `brand-guidelines.md` — created by
/brand-voice-setupor written manually - Vale — optional; only required for
vale-sync
Contributing
Bug reports, feature requests, and pull requests are welcome. See CONTRIBUTING.md for setup instructions, key invariants to preserve, and code style guidance.
License
MIT — see LICENSE.