项目简介

GitHub Project Manager MCP 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为 LLM 客户端提供管理 GitHub 项目的工具。通过此服务器,LLM 可以自动化项目管理流程,例如创建项目、规划 Sprint、跟踪里程碑和管理 Issue。

主要功能点

  • 项目管理:创建和管理 GitHub 项目,配置看板工作流。
  • 议题管理:创建和管理 Issue,包括优先级、指派和标签。
  • 里程碑管理:创建和跟踪里程碑,管理截止日期和进度。
  • Sprint管理:Sprint 计划和执行,Sprint 指标跟踪。
  • 自动化工作流:支持自动化看板工作流,提高项目管理效率。
  • 丰富的工具集:提供 'create_roadmap', 'plan_sprint', 'get_milestone_metrics' 等多种工具,满足不同的项目管理需求。

安装步骤

  1. 克隆仓库

    git clone https://github.com/MCP-Mirror/kunwarVivek_mcp-github-project-manager.git
    cd kunwarVivek_mcp-github-project-manager
  2. 安装依赖

    npm install
  3. 构建服务器

    npm run build

服务器配置

为了使 MCP 客户端能够连接到此服务器,您需要配置客户端的 MCP 设置。以下是一个示例配置,其中包含了启动服务器所需的命令和参数。

{
  "serverName": "github-project-manager",
  "command": "node",
  "args": [
    "dist/index.js"
  ],
  "env": {
    "GITHUB_TOKEN": "<Your GitHub Personal Access Token>",
    "GITHUB_OWNER": "<Your GitHub Repository Owner>",
    "GITHUB_REPO": "<Your GitHub Repository Name>"
  },
  "description": "GitHub Project Manager MCP Server"
}

配置参数说明

  • 'serverName': 服务器名称,客户端用此名称来标识和调用工具,例如 "github-project-manager"。
  • 'command': 启动服务器的命令,这里使用 'node' 来运行 JavaScript 代码。
  • 'args': 传递给 'node' 命令的参数,'dist/index.js' 是编译后的服务器入口文件路径。
  • 'env': 环境变量配置,请务必根据您的 GitHub 仓库信息和个人访问令牌进行配置
    • 'GITHUB_TOKEN': 您的 GitHub 个人访问令牌,需要 'repo' 和 'project' 权限。
    • 'GITHUB_OWNER': 您的 GitHub 仓库所有者用户名或组织名。
    • 'GITHUB_REPO': 您的 GitHub 仓库名称。
  • 'description': 服务器描述,用于客户端显示服务器信息。

注意

  • 确保您已设置正确的环境变量 'GITHUB_TOKEN', 'GITHUB_OWNER', 和 'GITHUB_REPO'。您可以在 MCP 客户端的配置中直接设置这些环境变量,或者在运行 MCP 客户端的环境中设置。
  • 首次使用前,您可能需要运行 'get-github-token.js' 脚本来获取 GitHub Personal Access Token,具体步骤请参考仓库 README。

基本使用方法

配置完成后,您的 MCP 客户端应该能够连接到 GitHub Project Manager MCP 服务器。您可以使用客户端提供的 'use_mcp_tool' 或类似的函数来调用服务器提供的工具。

例如,使用 'create_roadmap' 工具创建一个项目路线图:

await use_mcp_tool({
  server_name: "github-project-manager",
  tool_name: "create_roadmap",
  arguments: {
    project: {
      title: "Q1 2024 Roadmap",
      description: "Product roadmap for Q1 2024",
      visibility: "private"
    },
    milestones: [
      // ... 里程碑和议题信息
    ]
  }
});

更多工具的使用方法和参数说明,请参考仓库的 README 文档和 'src/index.ts' 文件中 'setupToolHandlers' 方法的定义。

信息

分类

开发者工具