变更日志管理服务器

Changerawr MCP Server是一个基于模型上下文协议(MCP)的服务,通过自然语言使AI助手能够管理变更日志、项目和内容。

  • by Changerawr
  • TypeScript
  • 本地部署
  • 2 星标
  • 更新于
在 GitHub 查看 changerawr/mcp-server

使用说明

变更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. 引导到 设置→ API密钥
  3. 创建具有管理员权限的新API密钥
  4. 复制密钥(格式: chr_...)

4.配置克劳德桌面

将此配置添加到您的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 Desktop并重新启动,以使配置生效。

使用示例

项目管理

创建新项目:

“创建一个名为“移动应用程序”的新项目,启用自动发布并将其公开”

列出所有项目:

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

更新项目设置:

“将移动应用程序项目设置为私有,并要求对所有更改进行批准”

变更日志管理

创建草稿更改日志条目:

“为2.1.0版本创建一个名为“增强搜索功能”的变更日志条目,其中包含有关新搜索功能的详细信息”

立即创建并发布:

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

发布草稿:

“显示未发布的更改日志条目,并发布有关增强安全性的条目”

更新现有条目:

“更新ID为xyz的更改日志条目,以包含有关性能改进的信息”

标签管理

列出项目的标记:

“显示移动应用程序项目可用的所有标签”

创建新标签:

为移动应用项目创建一个名为“安全更新”的新标签

分析

获取仪表板统计信息:

“显示仪表板统计信息和最近的活动”

可用工具

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. 检查网址:验证您的Changerawr实例URL是否正确
  3. 测试连接:尝试在浏览器中访问您的Changerawr实例

Claude桌面问题

  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检查器进行测试:

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许可证-有关详细信息,请参阅许可证文件

支持

对于问题和疑问:

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