使用说明

项目简介

Gitee MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在让AI能够安全、便捷地操作 Gitee (国内的代码托管平台) 上的代码仓库。通过此服务器,AI可以执行诸如创建仓库、管理分支、编辑文件、处理Issue和Pull Request等多种操作,极大地扩展了AI在软件开发流程中的应用能力。

主要功能点

  • 代码仓库操作: 支持创建、Fork代码仓库。
  • 分支管理: 支持创建、列出和获取分支信息。
  • 文件操作: 支持获取文件内容、创建或更新文件、批量推送文件。
  • Issue管理: 支持创建、列出、获取、更新Issue,以及添加Issue评论。
  • Pull Request管理: 支持创建、列出、获取、更新和合并Pull Request。
  • 用户操作: 支持获取用户信息和当前用户信息。

安装步骤

  1. 环境准备: 确保已安装 Node.js (版本 >= 22.12.0) 和 npm。推荐使用 npx 运行,无需全局安装。
  2. 获取访问令牌 (Personal Access Token): 访问 Gitee 个人访问令牌 页面,创建一个 Personal Access Token,并复制保存。请务必妥善保管您的Token,避免泄露。
  3. 选择运行方式: 您可以选择通过 Smithery、NPX 或 Docker 运行 Gitee MCP Server。

服务器配置

以下是 MCP 客户端 (如 Claude 桌面版) 'mcpServers' 配置项的 JSON 示例。您需要根据选择的运行方式配置 'command' 和 'args',并将步骤2中获取的 Gitee Personal Access Token 填入 'env' 中的 'GITEE_PERSONAL_ACCESS_TOKEN' 字段。

1. NPX 运行配置 (推荐)

{
  "mcpServers": {
    "Gitee": {
      "command": "npx",
      "args": [
        "-y",
        "gitee-mcp-server"
      ],
      "env": {
        "GITEE_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"  // 替换为您的 Gitee Personal Access Token
      }
    }
  }
}
  • 'command': 指定运行 MCP 服务器的命令,这里使用 'npx' 来运行 npm 包。
  • 'args': 命令参数,'-y' 表示自动确认安装 'gitee-mcp-server', 'gitee-mcp-server' 是服务器的入口。
  • 'env': 环境变量配置, 'GITEE_PERSONAL_ACCESS_TOKEN' 用于 Gitee API 的身份验证。

2. Docker 容器运行配置

{
  "mcpServers": {
    "Gitee": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "GITEE_PERSONAL_ACCESS_TOKEN",
        "normalcoder/gitee-mcp-server"
      ],
      "env": {
        "GITEE_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>" // 替换为您的 Gitee Personal Access Token
      }
    }
  }
}
  • 'command': 指定运行 MCP 服务器的命令,这里使用 'docker' 运行 Docker 容器。
  • 'args': Docker 命令参数:
    • 'run': 运行容器。
    • '-i': 保持标准输入 (STDIN) 打开。
    • '--rm': 容器退出后自动删除。
    • '-e GITEE_PERSONAL_ACCESS_TOKEN': 设置环境变量 'GITEE_PERSONAL_ACCESS_TOKEN' 到容器中。
    • 'normalcoder/gitee-mcp-server': 使用的 Docker 镜像名称。
  • 'env': 环境变量配置,与 NPX 方式相同。

3. Smithery 自动安装 (Claude 桌面版)

如果您的 MCP 客户端是 Claude 桌面版,可以使用 Smithery 命令行工具自动安装和配置 Gitee MCP Server。

打开终端并执行以下命令:

npx -y @smithery/cli install @normal-coder/gitee-mcp-server --client claude

Smithery 会自动处理安装和配置过程。

基本使用方法

  1. 启动 MCP 服务器: 根据您选择的运行方式 (NPX, Docker 或 Smithery) 启动 Gitee MCP Server。服务器将在后台运行,并通过标准输入输出 (stdio) 与 MCP 客户端通信。
  2. 配置 MCP 客户端: 在您的 MCP 客户端 (如 Claude 桌面版) 中,配置 'mcpServers' ,填入上述相应的 JSON 配置信息。
  3. AI 调用工具: 在 AI 应用中,您可以指示 AI 调用 Gitee MCP Server 提供的工具来操作 Gitee 仓库。例如,指示 AI "创建一个名为 'test-repo' 的公开 Gitee 仓库" 或 "列出 'your-org/your-repo' 仓库的所有 Issue"。
  4. 查看日志 (可选): 如果需要调试,可以将环境变量 'DEBUG' 设置为 'true' 以启用详细日志输出。

注意: Gitee MCP Server 旨在与 MCP 客户端协同工作,您需要使用支持 MCP 协议的 AI 客户端才能充分利用其功能。

信息

分类

开发者工具