项目介绍
Changerawr MCP Server
用于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密钥
- 登录到您的Changerawr管理面板
- 导航至设置 → API密钥
- 创建一个具有管理员权限的新API密钥
- 复制该密钥（格式：
chr_...）
4. 配置Claude桌面
在您的Claude桌面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桌面
完全关闭Claude桌面并重新启动以使配置生效。
使用示例
项目管理
创建新项目:
"创建一个名为'Mobile App'的新项目，启用自动发布并设为公开"
列出所有项目:
"显示我在Changerawr中的所有项目"
更新项目设置:
"将'Mobile App'项目设为私有，并要求对所有更改进行审批"
变更日志管理
创建草稿变更日志条目:
"为版本2.1.0创建一个标题为'增强搜索功能'的变更日志条目，详细说明新的搜索功能"
创建并立即发布:
"为版本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- 可用标签
工作流程
草稿 → 审查 → 发布（推荐）
- 创建草稿:
create_changelog_entry- 创建未发布的条目 - 审查内容: 编辑和审查内容
- 发布:
publish_changelog_entry- 使其对用户可见
即时发布
- 创建并发布:
create_and_publish_changelog_entry- 一步完成过程
管理员权限
所有API密钥都具有管理员访问权限，允许：
- ✅ 即时项目创建/删除
- ✅ 即时发布/取消发布
- ✅ 直接条目删除
- ✅ 完整的项目设置控制
- ✅ 标签管理
故障排除
连接问题
- 验证API密钥: 确保它以
chr_开头且具有管理员权限 - 检查URL: 确认您的Changerawr实例URL正确
- 测试连接: 尝试在浏览器中访问您的Changerawr实例
Claude桌面问题
- 检查日志: Windows:
%APPDATA%\Claude\logs\ - 完全重启: 从系统托盘关闭Claude桌面
- 验证配置路径: 确认config.json中的文件路径正确
工具失败
- 检查stderr输出: MCP服务器记录详细的错误信息
- 验证项目ID: 确认您使用正确的项目/条目ID
- 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 # 主MCP服务器入口点
├── client/
│ └── changerawr-client.ts # 带Zod验证的API客户端
├── tools/ # 用于AI交互的MCP工具
│ ├── index.ts # 工具注册表
│ ├── project-tools.ts # 项目管理（5个工具）
│ ├── changelog-tools.ts # 变更日志操作（8个工具）
│ ├── tag-tools.ts # 标签管理（3个工具）
│ ├── settings-tools.ts # 项目设置（2个工具）
│ └── analytics-tools.ts # 仪表板分析（1个工具）
├── resources/ # 用于数据访问的MCP资源
│ ├── index.ts # 资源注册表
│ ├── project-resources.ts
│ └── changelog-resources.ts
└── utils/
└── validation.ts # 输入验证实用程序
安全
- 使用Changerawr现有的API密钥认证
- 尊重管理员权限和基于角色的访问
- 所有操作通过Changerawr的审计系统记录
- 输入验证和错误处理确保安全操作
许可证
MIT许可证 - 查看LICENSE文件了解详情
支持
对于问题和疑问：
- 查看上面的故障排除部分
- 查看Claude桌面日志以获取详细的错误信息
- 确认您的Changerawr实例可访问且API密钥有效