stylemcp

🚀 StyleMCP

StyleMCP 为 AI 模型和智能体提供可执行的品牌规则，确保每一条 AI 生成的消息都符合品牌风格。

🚀 快速开始

API

curl -X POST https://stylemcp.com/api/validate \
  -H "Content-Type: application/json" \
  -d '{"text": "Click here to learn more!"}'

响应结果：

{
  "valid": false,
  "score": 65,
  "violations": [
    {
      "rule": "no-click-here",
      "severity": "error",
      "message": "Avoid 'click here' - describe the destination instead",
      "suggestion": "Learn more about our features"
    }
  ]
}

CLI

# 安装
npm install -g stylemcp

# 验证文本
stylemcp validate "Click here to learn more"

# 验证文件
stylemcp validate src/copy/homepage.json --pack saas

# 重写文本
stylemcp rewrite "Please utilize our product" --mode aggressive

MCP（Claude 桌面版）

在 claude_desktop_config.json 中添加以下内容：

{
  "mcpServers": {
    "stylemcp": {
      "command": "npx",
      "args": ["stylemcp"]
    }
  }
}

现在，Claude 可以使用你的品牌规则来验证和重写文本。

✨ 主要特性

StyleMCP 可以验证和重写 AI 生成的文本，使其与你的品牌风格相匹配。你可以通过以下方式使用它：

• REST API：验证来自任何应用程序的文本。
• MCP 服务器：与 Claude 和其他 AI 智能体直接集成。
• CLI：在终端或 CI/CD 中检查文案。
• GitHub Action：在拉取请求中捕获不符合品牌风格的文案。

📦 安装指南

Docker

# 克隆仓库
git clone https://github.com/3DUNLMTD/stylemcp.git
cd stylemcp

# 设置环境
echo "STYLEMCP_API_KEY=$(openssl rand -hex 32)" > .env

# 使用 Docker 运行
docker compose up -d

# 检查健康状态
curl http://localhost:3000/health

手动安装

# 安装依赖
npm install

# 构建
npm run build

# 启动服务器
npm start

💻 使用示例

基础用法

# 使用 API 验证文本
curl -X POST https://stylemcp.com/api/validate \
  -H "Content-Type: application/json" \
  -d '{"text": "Click here to learn more!"}'

高级用法

# 在 CI/CD 中使用 CLI 验证文件
stylemcp validate src/copy/homepage.json --pack saas

📚 详细文档

API 端点

| 方法 | 端点 | 描述 | | ---- | ---- | ---- | | POST | /api/validate | 根据品牌规则验证文本 | | POST | /api/rewrite | 重写文本以匹配品牌风格 | | POST | /api/validate/batch | 验证多个文本 | | GET | /api/packs | 列出可用的风格包 | | GET | /api/packs/{pack}/voice | 获取语音指南 | | GET | /api/packs/{pack}/ctas | 获取 CTA 规则 | | GET | /api/mcp/sse | MCP SSE 端点 | | POST | /api/mcp/call | MCP 工具调用 |

风格包

StyleMCP 使用风格包（YAML 文件）来定义你的品牌规则。

可用的风格包

| 风格包 | 适用场景 | 主要特性 | | ---- | ---- | ---- | | saas | B2B SaaS 产品 | 专业、清晰、有帮助的语气 | | ecommerce | DTC 和零售品牌 | 友好、注重转化、无强硬 CTA | | healthcare | 医疗和健康领域 | 合规语言、无治愈声明、以人为本 | | finance | 金融科技和银行业 | 精确、风险意识强、无保证回报 |

示例：saas 风格包

• 词汇：优先使用 "use" 而非 "utilize"，使用 "help" 而非 "assist"。
• 禁用词汇："synergy"、"leverage"、"cutting-edge"、"game-changing"。
• 避免的模式："click here"、"we're sorry for any inconvenience"。
• CTA 规则：避免使用 "Submit"、"Click here"、"OK"，优先使用 "Save"、"Create"、"Sign up"。

风格包结构

packs/
  my-brand/
    manifest.yaml      # 风格包元数据
    voice.yaml         # 语气、词汇、禁用词汇
    copy_patterns.yaml # 可重复使用的文案模板
    cta_rules.yaml     # 按钮/CTA 指南
    tokens.json        # 设计令牌（可选）

创建自己的风格包

# 复制默认风格包
cp -r packs/saas packs/my-brand

# 编辑规则
nano packs/my-brand/voice.yaml

# 使用你的风格包
curl -X POST https://stylemcp.com/api/validate \
  -d '{"text": "Your text", "pack": "my-brand"}'

voice.yaml 示例

tone:
  summary: "Friendly, clear, and helpful"
  attributes:
    - name: friendly
      weight: 0.8
    - name: professional
      weight: 0.7

vocabulary:
  rules:
    - preferred: "use"
      avoid: ["utilize", "leverage"]
    - preferred: "help"
      avoid: ["assist", "facilitate"]

  forbidden:
    - "synergy"
    - "paradigm shift"
    - "game-changing"

doNot:
  - pattern: "click here"
    reason: "Poor accessibility"
    suggestion: "Describe the destination"
    severity: error

  - pattern: "\\b(obviously|simply|just)\\b"
    isRegex: true
    reason: "Can make users feel stupid"
    severity: warning

GitHub Actions

name: Brand Check
on: [pull_request]

jobs:
  validate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Validate copy
        run: |
          npx stylemcp validate src/copy/*.json \
            --min-score 80 \
            --format github

环境变量

| 变量 | 描述 | 默认值 | | ---- | ---- | ---- | | PORT | 服务器端口 | 3000 | | STYLEMCP_API_KEY | 用于身份验证的 API 密钥 | (无) | | GITHUB_WEBHOOK_SECRET | GitHub 网络钩子密钥 | (无) |

MCP 工具

当作为 MCP 服务器使用时，StyleMCP 提供以下工具： | 工具 | 描述 | | ---- | ---- | | validate_text | 根据品牌规则验证文本 | | rewrite_to_style | 重写文本以匹配品牌风格 | | get_voice_rules | 获取语音和语气指南 | | get_copy_patterns | 获取批准的文案模式 | | get_cta_rules | 获取 CTA 指南 | | get_tokens | 获取设计令牌 | | list_packs | 列出可用的风格包 |

验证内容

saas 风格包会检查以下内容：

词汇

• 使用简单词汇：使用 "use" 而非 "utilize"，使用 "help" 而非 "assist"。
• 避免行话："synergy"、"leverage"、"paradigm shift"。
• 避免弱强化词："very"、"really"、"extremely"。

模式

• 避免使用 "click here"（无障碍问题）。
• 避免使用 "we're sorry for any inconvenience"（公司式非道歉）。
• 避免使用双 "please"（听起来很急切）。
• 避免以 "Sorry" 开头（以解决方案开头）。

CTA

• 避免使用通用的 CTA："Submit"、"OK"、"Yes/No"、"Click here"。
• 使用具体的行动："Save"、"Create"、"Sign up"、"Export"。
• 最多 4 个单词。

约束

• 每句话最多 25 个单词。
• 大多数情况下避免使用感叹号。
• 使用第一人称复数（"we"、"our"）。
• 使用牛津逗号。

📄 许可证

本项目采用 MIT 许可证。