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 端點

風格包

StyleMCP 使用風格包（YAML 文件）來定義你的品牌規則。

可用的風格包

示例：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

環境變量

MCP 工具

當作為 MCP 服務器使用時，StyleMCP 提供以下工具：

驗證內容

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 許可證。