MCP Github Notifications

🚀 GitHub 通知 MCP 服务器

本项目是一个基于 Model Context Protocol (MCP) 的服务器，它提供了管理 GitHub 通知的工具。借助该服务器，像 Claude 这样的 AI 助手能够通过自然语言命令，协助您高效管理 GitHub 通知。

🚀 快速开始

本服务器允许您借助 AI 助手，通过自然语言命令管理 GitHub 通知。以下是使用前的准备及操作步骤。

✨ 主要特性

• 列出并过滤您的 GitHub 通知
• 标记通知为已读
• 查看通知线程详细信息
• 订阅或取消订阅通知线程
• 标记线程为完成
• 管理特定存储库的通知
• 控制存储库通知设置（所有活动、默认或静音）

📦 安装指南

先决条件

• Node.js 18 或更高版本
• 具有 notifications 或 repo 范围的 GitHub 个人访问令牌 (classic)

安装步骤

1. 克隆此仓库

   git clone https://github.com/yourusername/github-notifications-mcp-server.git
   cd github-notifications-mcp-server
   

2. 安装依赖项

   npm install
   

3. 构建项目

   npm run build
   

4. 创建包含您的 GitHub 令牌的 .env 文件

   GITHUB_TOKEN=your_github_personal_access_token_here
   

💻 使用示例

直接运行服务器

npm start

与 Claude Desktop 结合使用

将服务器添加到 claude_desktop_config.json 文件中：

{
  "mcpServers": {
    "github-notifications": {
      "command": "node",
      "args": ["/absolute/path/to/github-notifications-mcp-server/build/index.js"],
      "env": {
        "GITHUB_TOKEN": "your_github_personal_access_token_here"
      }
    }
  }
}

可用工具

示例提示

以下是可用于 Claude Desktop 的示例提示，一旦服务器连接成功：

• "你能检查我的 GitHub 通知吗？"
• "显示我过去 24 小时内的未读通知。"
• "将所有通知标记为已读。"
• "你能告诉我关于编号 12345 的通知线程吗？"
• "取消订阅 12345 号线程的通知。"
• "我在 octocat/Hello-World 仓库有什么通知？"
• "将 octocat/Hello-World 仓库中的所有通知标记为已读。"
• "关注 octocat/Hello-World 仓库的所有活动。"
• "将 octocat/Hello-World 仓库设置为默认设置（参与和 @ 提及）。"
• "检查我对 octocat/Hello-World 仓库的通知设置。"
• "使 octocat/Hello-World 仓库静音。"

🔧 技术细节

URL 处理

此服务器会自动将 GitHub API URL 转换为其对应的网络界面 URL。例如：

• API URL：https://api.github.com/repos/nodejs/node/pulls/57557
• 转换为：https://github.com/nodejs/node/pull/57557

转换处理：

• 域名从 api.github.com/repos 到 github.com 的转换
• 路径更正，用于拉取请求（将 pulls 更改为 pull）
• 保留额外的路径段

项目结构

github-notifications-mcp-server/
├── src/                    # 源代码
│   ├── tools/              # 工具实现
│   ├── types/              # 类型定义
│   ├── utils/              # 工具函数
│   ├── index.js           # 入口文件
│   └── package.json       # 包含依赖项和脚本的文件
└── build/                 # 构建输出目录，包含可执行文件

如何构建

在项目根目录运行以下命令：

npm run build

这将使用 webpack 将所有模块打包到 build/main.js 中，并且会在构建完成后提供相关信息。

📄 许可证

此项目的许可信息请参考 LICENSE 文件。

这是一个用于管理 GitHub 通知的 MCP 服务器，通过自然语言处理和自动化脚本实现对通知的高效处理。