Changerawr MCP Server

Changerawr MCP 服务

Changerawr 的模型上下文协议（MCP）服务，让 Claude 等 AI 助手能够通过自然语言管理变更日志、项目和内容。

功能

🚀 项目管理

• 列出、创建、更新和删除项目
• 配置项目设置（公开可见性、自动发布、审批要求）

📝 变更日志管理

• 创建、更新、发布和取消发布变更日志条目
• 支持版本控制和标签
• 支持丰富格式的 Markdown 内容

🏷️ 标签整理

• 创建和管理用于整理条目的标签
• 项目专属标签管理

📊 分析与洞察

• 获取仪表板统计数据和分析信息
• 跟踪项目信息

🔧 项目设置

• 更新项目配置
• 管理默认标签和发布设置

安装与设置

前提条件

• 已安装 Node.js 18+
• 可访问 Changerawr 实例
• Changerawr 管理员 API 密钥

1. 克隆代码库

git clone <repository-url>
cd changerawr-mcp-server

2. 安装依赖项

npm install

3. 获取 Changerawr API 密钥

1. 登录 Changerawr 管理面板
2. 前往 Settings → API Keys
3. 创建具有管理员权限的新 API 密钥
4. 复制密钥（格式：chr_...）

4. 配置 Claude Desktop

将此配置添加到 Claude Desktop 的 config.json：

Windows 位置： %APPDATA%\Claude\config.json macOS 位置： ~/Library/Application Support/Claude/config.json

{
  "mcpServers": {
    "changerawr": {
      "command": "npx",
      "args": ["tsx", "C:\\Users\\username\\WebstormProjects\\changerawr-mcp-server\\src\\index.ts"],
      "env": {
        "CHANGERAWR_API_KEY": "chr_your_api_key_here",
        "CHANGERAWR_BASE_URL": "https://your-changerawr-domain.com",
        "NODE_ENV": "development"
      }
    }
  }
}

重要提示： 将路径替换为实际的项目位置，并更新环境变量：

• CHANGERAWR_API_KEY：你的 Changerawr API 密钥
• CHANGERAWR_BASE_URL：你的 Changerawr 实例 URL

5. 重启 Claude Desktop

完全退出 Claude Desktop，然后重新启动，使配置生效。

使用示例

项目管理

创建新项目：

“创建一个名为 ‘Mobile App’ 的新项目，启用自动发布并将其设为公开”

列出所有项目：

“显示我在 Changerawr 中的所有项目”

更新项目设置：

“将 Mobile App 项目设为私有，并要求审批所有更改”

变更日志管理

创建变更日志草稿：

“为版本 2.1.0 创建一个变更日志条目，标题为 ‘Enhanced Search Features’，并介绍新的搜索功能”

创建并立即发布：

“为版本 2.1.1 创建并立即发布一个关于错误修复的变更日志条目”

发布草稿：

“显示未发布的变更日志条目，并发布关于增强安全性的那一条”

更新现有条目：

“更新 ID 为 xyz 的变更日志条目，加入性能改进相关信息”

标签管理

列出项目标签：

“显示 Mobile App 项目的所有可用标签”

创建新标签：

“为 Mobile App 项目创建名为 ‘Security Update’ 的新标签”

分析

获取仪表板统计数据：

“显示仪表板统计数据和近期活动”

可用工具

此 MCP 服务提供 22 个工具，用于全面管理 Changerawr：

项目工具（5 个）

• list_projects - 列出所有项目
• get_project - 获取项目详情
• create_project - 创建新项目
• update_project - 更新项目设置
• delete_project - 删除项目（管理员）

变更日志工具（8 个）

• list_changelog_entries - 筛选并列出变更日志条目
• get_changelog_entry - 获取指定条目的详情
• create_changelog_entry - 创建新的草稿条目
• update_changelog_entry - 更新现有条目
• publish_changelog_entry - 发布条目，使其公开
• unpublish_changelog_entry - 对公众隐藏条目
• delete_changelog_entry - 永久删除条目（管理员）
• create_and_publish_changelog_entry - 一步创建并发布

标签工具（3 个）

• list_tags - 列出项目标签
• create_tag - 创建新的项目标签
• delete_tag - 删除标签（API 支持有限）

设置工具（2）

• get_project_settings - 获取项目配置
• update_project_settings - 更新项目设置

分析工具（1）

• get_dashboard_stats - 获取仪表板统计数据

资源（3）

• changerawr://projects - 所有项目的列表
• changerawr://projects/{projectId}/changelog - 项目变更日志条目
• changerawr://tags - 可用标签

工作流

草稿 → 审核 → 发布（推荐）

1. 创建草稿：create_changelog_entry - 创建未发布的条目
2. 审核内容：编辑并审核内容
3. 发布：publish_changelog_entry - 让用户可以查看该条目

立即发布

1. 创建并发布：create_and_publish_changelog_entry - 一步完成

管理员权限

所有 API 密钥均具有管理员访问权限，可执行以下操作：

• ✅ 即时创建/删除项目
• ✅ 立即发布/取消发布
• ✅ 直接删除条目
• ✅ 完全控制项目设置
• ✅ 管理标签

故障排除

连接问题

1. 验证 API 密钥：确保密钥以 chr_ 开头，并具有管理员权限
2. 检查 URL：确认 Changerawr 实例 URL 正确
3. 测试连接：尝试在浏览器中访问 Changerawr 实例

Claude Desktop 问题

1. 检查日志：Windows：%APPDATA%\Claude\logs\
2. 彻底重启：从系统托盘关闭 Claude Desktop
3. 验证配置路径：确保 config.json 中的文件路径正确

工具故障

1. 检查 stderr 输出：MCP 服务会记录详细的错误信息
2. 验证项目 ID：确保使用正确的项目/条目 ID
3. API 权限：确认 API 密钥具有管理员访问权限

开发

在开发模式下运行

cd changerawr-mcp-server
npx tsx src/index.ts

测试工具

使用 MCP Inspector 进行测试：

npx @modelcontextprotocol/inspector npx tsx src/index.ts

环境变量

变量	必需	描述
CHANGERAWR_API_KEY	✅	你的 Changerawr API 密钥（以 chr_ 开头）
CHANGERAWR_BASE_URL	✅	你的 Changerawr 实例 URL
NODE_ENV	❌	设置为 development 以启用详细日志记录

架构

src/
├── index.ts              # Main MCP server entry point
├── client/
│   └── changerawr-client.ts  # API client with Zod validation
├── tools/                # MCP tools for AI interactions
│   ├── index.ts          # Tool registry
│   ├── project-tools.ts  # Project management (5 tools)
│   ├── changelog-tools.ts # Changelog operations (8 tools)
│   ├── tag-tools.ts      # Tag management (3 tools)
│   ├── settings-tools.ts # Project settings (2 tools)
│   └── analytics-tools.ts # Dashboard analytics (1 tool)
├── resources/            # MCP resources for data access
│   ├── index.ts          # Resource registry
│   ├── project-resources.ts
│   └── changelog-resources.ts
└── utils/
    └── validation.ts     # Input validation utilities

安全

• 使用 Changerawr 现有的 API 密钥身份验证
• 遵循管理员权限和基于角色的访问控制
• 所有操作均通过 Changerawr 的审计系统记录
• 通过输入验证和错误处理确保操作安全

许可证

MIT 许可证 - 详情请参阅 LICENSE 文件

支持

如有问题或疑问：

• 查看上方的故障排除部分
• 查看 Claude Desktop 日志，获取详细错误信息
• 确保可以访问 Changerawr 实例，且 API 密钥有效