article
README
🚀 GitHub 发布 MCP 服务器
这是一个功能强大的模型上下文协议(MCP)工具包,用于管理 GitHub 发布。借助此服务器,你可以全面访问、比较和分析 GitHub 存储库发布,获取丰富格式和详细信息。
🚀 快速开始
你可以使用 npx 运行此 MCP 服务器:
# 使用环境变量
GITHUB_PERSONAL_ACCESS_TOKEN=your_token npx @slinerodev/github-releases-mcp
# 或者使用 .env 文件
echo "GITHUB_PERSONAL_ACCESS_TOKEN=your_token" > .env
npx @slinerodev/github-releases-mcp
✨ 主要特性
- 🔍 详细的发布信息:获取特定版本的全面细节
- 📊 版本比较:比较两个版本之间的更改
- 📋 发布列表:获得格式化的发布列表,带过滤选项
- 🏷️ 语义化版本支持:处理各种版本格式(v1.0.0、@1.0.0、1.0.0)
- 🎯 预发布筛选:选择包含或排除预发布版本
- 📝 丰富格式:带有表情符号的输出,提高可读性
- 🔄 分页支持:处理具有大量发布的存储库
- 🔒 身份验证:可选 GitHub 令牌支持,用于私有存储库和更高的速率限制
📦 安装指南
配置
服务器接受以下可选环境变量:
GITHUB_PERSONAL_ACCESS_TOKEN:GitHub 个人访问令牌(可选)。如果提供,则会用于认证 API 请求,允许更高的速率限制和对私有存储库的访问。
💻 使用示例
客户端配置
服务器可以与各种 MCP 客户端一起使用。将以下配置添加到客户端的配置文件中:
- 光标:
~/.cursor/mcp.json - VS Code:
.vscode/settings.json(使用mcp.servers而不是mcpServers) - Claude Desktop:
claude_desktop_config.json - IntelliJ:
idea.properties
示例配置
对于 VS Code
{
"mcp.servers": [
{
"name": "GitHub Releases",
"type": "github-releases",
"config": {
"owner": "your-owner",
"repo": "your-repo",
"token": "your-token"
}
}
]
}
对于 IntelliJ
mcp.servers=github-releases
github-releases.owner=your-owner
github-releases.repo=your-repo
github-releases.token=your-token
可用工具
基础用法
获取指定存储库的所有发布信息:
mcp github-releases --owner your-owner --repo your-repo --token your-token
高级用法
列出特定版本的详细信息:
mcp github-releases --owner your-owner --repo your-repo --version 1.0.0 --token your-token
从文件创建新发布:
mcp github-releases create \
--owner your-owner \
--repo your-repo \
--token your-token \
--name "New Version" \
--tag v1.0.0 \
--description "# New Version\n## Changes"
删除指定版本的发布:
mcp github-releases delete \
--owner your-owner \
--repo your-repo \
--token your-token \
--version 1.0.0
📚 详细文档
错误处理
工具优雅地处理各种错误情况:
- 无效存储库名称
- 不存在的版本
- 无效版本格式
- API 速率限制
- 网络问题
- 身份验证错误
每个错误都会返回一个清晰的消息,说明发生了什么问题。
开发
- 安装依赖项:
pnpm install
- 运行服务器:
pnpm start
贡献
- 叉仓库
- 创建功能分支(
git checkout -b feature/amazing-feature) - 提交更改(
git commit -m 'Add some amazing feature') - 推送到分支(
git push origin feature/amazing-feature) - 打开拉取请求
📄 许可证
ISC
作者
Sergio Linero
Scan to join WeChat group