使用说明

项目简介

GitHub Kanban MCP Server 是一个 Model Context Protocol (MCP) 服务器，旨在为大型语言模型 (LLM) 提供 GitHub Issue 的看板管理功能。它允许 LLM 客户端通过标准化的 MCP 协议与 GitHub 进行交互，实现任务管理自动化和项目进度可视化。

主要功能点

Issue 看板管理: 以看板形式管理 GitHub 仓库的 Issue，方便 LLM 理解和操作任务。
Issue 列表获取: 允许 LLM 获取指定仓库的 Issue 列表，支持按状态和标签过滤。
Issue 创建: 支持 LLM 创建新的 GitHub Issue，包括标题、内容、标签和指派人员。
Issue 更新: 允许 LLM 更新现有 Issue 的标题、内容、状态、标签和指派人员。
Issue 评论: 支持 LLM 在 Issue 中添加评论，方便沟通和记录。

安装步骤

确保已安装 Node.js (18.x+) 和 npm (9.x+)。
确保已安装 GitHub CLI ('gh') 并已完成身份验证 ('gh auth login')，以便服务器可以通过 'gh' 命令行工具与 GitHub API 交互。

使用 npm 安装该 MCP 服务器:

npm install @sunwood-ai-labs/github-kanban-mcp-server

服务器配置

在 MCP 客户端的配置文件中，添加如下服务器配置信息，以便客户端能够连接和使用 GitHub Kanban MCP Server。

{
  "mcpServers": {
    "github-kanban": {
      "command": "github-kanban-mcp-server"
    }
  }
}

'mcpServers': 定义 MCP 服务器的配置 section。
'github-kanban': 为该 GitHub Kanban MCP 服务器自定义的名称，客户端将使用此名称来引用该服务器。
'command': 启动 MCP 服务器的命令。这里设置为 'github-kanban-mcp-server'，这意味着需要确保 'github-kanban-mcp-server' 命令在系统 PATH 环境变量中可被找到。通常情况下，npm 安装全局包后会自动配置。

基本使用方法

启动 MCP 服务器 (通常由 MCP 客户端负责启动和管理)。一旦客户端配置了上述服务器信息，客户端在需要时会自动启动和连接该服务器。
在 MCP 客户端中，配置并连接到名为 'github-kanban' 的 MCP 服务器。
使用 MCP 客户端提供的界面或 API，调用服务器提供的工具 (tools)，例如 'list_issues', 'create_issue' 等，并提供相应的参数 (例如仓库路径 'path')。具体可用的工具及其参数如下：

可用工具列表:

list_issues: 获取 issue 列表
- 描述: 获取看板的 issue 列表
- 参数:
  - 'path': Git 仓库的绝对路径 (必需)
  - 'state': issue 状态 ('open', 'closed', 'all') (可选)
  - 'labels': 标签数组，用于过滤 issue (可选)
create_issue: 创建 issue
- 描述: 创建新的 issue
- 参数:
  - 'path': Git 仓库的绝对路径 (必需)
  - 'title': issue 标题 (必需)
  - 'emoji': 标题前添加的 emoji (可选)
  - 'body': issue 内容 (可选)
  - 'labels': 标签数组 (可选)
  - 'assignees': 指派人员数组 (可选)
update_issue: 更新 issue
- 描述: 更新已存在的 issue
- 参数:
  - 'path': Git 仓库的绝对路径 (必需)
  - 'issue_number': issue 编号 (必需)
  - 'title': 新标题 (可选)
  - 'emoji': 标题前添加的 emoji (可选)
  - 'body': 新内容 (可选)
  - 'state': 新状态 ('open', 'closed') (可选)
  - 'labels': 新标签数组 (可选)
  - 'assignees': 新指派人员数组 (可选)
add_comment: 添加评论
- 描述: 为 issue 添加评论
- 参数:
  - 'repo': GitHub 仓库名 (例如 "owner/repo") (必需)
  - 'issue_number': issue 编号 (必需)
  - 'body': 评论内容 (Markdown 格式) (必需)
  - 'state': 评论后 issue 的状态 ('open', 'closed') (可选)

注意: 'path' 参数通常指的是本地 Git 仓库的路径，MCP Server 需要访问本地仓库以获取仓库信息。 'repo' 参数指的是 GitHub 仓库在 GitHub 上的 owner/repo 形式的名称，用于直接与 GitHub API 交互。

关键词