跳到主要内容
gitee logo

Gitee MCP Server

Gitee MCP 服务器是一个用于 Gitee 的模型上下文协议(Model Context Protocol,MCP)服务器实现。它提供了一系列与 Gitee API 交互的工具,使 AI 助手能够管理仓库、问题、拉取请求等。

Install MCP Server

功能特点

  • 与 Gitee 仓库、Issue、Pull Request 和通知进行交互
  • 可配置的 API 基础 URL,支持不同的 Gitee 实例
  • 命令行标志,便于配置
  • 支持个人、组织和企业操作
  • 支持动态启用/禁用工具集

安装(npx 启动可直接跳过该步骤)

前提条件

  • Go 1.23.0 或更高版本
  • 拥有访问令牌的 Gitee 账户,前往获取

从源代码构建

  1. 克隆仓库:

    git clone https://gitee.com/oschina/mcp-gitee.git
    cd mcp-gitee
  2. 构建项目:

    make build

    将 ./bin/mcp-gitee 移动至系统环境变量

使用 go install 安装

go install gitee.com/oschina/mcp-gitee@latest

使用方法

检查 mcp-gitee 版本:

mcp-gitee --version

MCP Hosts 配置

配置示例:点击查看更多应用配置

  • 连接官方 remote mcp-gitee server(免安装)
{
"mcpServers": {
"gitee": {
"url": "https://api.gitee.com/mcp",
"headers": {
"Authorization": "Bearer <your personal access token>"
}
}
}
}
  • npx 启动
{
"mcpServers": {
"gitee": {
"command": "npx",
"args": [
"-y",
"@gitee/mcp-gitee@latest"
],
"env": {
"GITEE_API_BASE": "https://gitee.com/api/v5",
"GITEE_ACCESS_TOKEN": "<your personal access token>"
}
}
}
}
  • 可执行文件启动
{
"mcpServers": {
"gitee": {
"command": "mcp-gitee",
"env": {
"GITEE_API_BASE": "https://gitee.com/api/v5",
"GITEE_ACCESS_TOKEN": "<your personal access token>"
}
}
}
}

命令行选项

  • --token:Gitee 访问令牌
  • --api-base:Gitee API 基础 URL(默认:https://gitee.com/api/v5)
  • --version:显示版本信息
  • --transport:传输类型(stdio、sse 或 http,默认:stdio)
  • --address:启动服务器的主机和端口(默认:localhost:8000)
  • --enabled-toolsets: 逗号分隔的要启用的工具列表(如果指定,则只启用这些工具)
  • --disabled-toolsets: 逗号分隔的要禁用的工具列表

环境变量

您也可以使用环境变量配置服务器:

  • GITEE_ACCESS_TOKEN:Gitee 访问令牌
  • GITEE_API_BASE:Gitee API 基础 URL
  • ENABLED_TOOLSETS: 逗号分隔的要启用的工具列表
  • DISABLED_TOOLSETS: 逗号分隔的要禁用的工具列表

工具集管理

工具集管理支持两种模式:

  1. 启用指定工具(白名单模式):

    • 使用 --enabled-toolsets 参数或 ENABLED_TOOLSETS 环境变量
    • 指定后,只有列出的工具会被启用,其他工具都会被禁用
    • 例如:--enabled-toolsets="update_enterprise_issue,list_enterprise_repositories"
  2. 禁用指定工具(黑名单模式):

    • 使用 --disabled-toolsets 参数或 DISABLED_TOOLSETS 环境变量
    • 指定后,列出的工具会被禁用,其他工具保持启用
    • 例如:--disabled-toolsets="update_enterprise_issue,list_enterprise_repositories"

注意:

  • 如果同时指定了 enabled-toolsetsdisabled-toolsets,则 enabled-toolsets 优先
  • 工具名称区分大小写

许可证

本项目采用 MIT 许可证。有关更多详细信息,请参阅 LICENSE 文件。

可用工具

服务器提供了各种与 Gitee 交互的工具:

工具类别描述
list_user_repos仓库列出用户授权的仓库
get_file_content仓库获取仓库中文件的内容
create_user_repo仓库创建用户仓库
create_org_repo仓库创建组织仓库
create_enter_repo仓库创建企业仓库
fork_repository仓库Fork 仓库
create_release仓库为仓库创建发行版
list_releases仓库列出仓库发行版
search_open_source_repositories仓库搜索开源仓库
list_repo_pullsPull Request列出仓库中的拉取请求
merge_pullPull Request合并拉取请求
create_pullPull Request创建拉取请求
update_pullPull Request更新拉取请求
get_pull_detailPull Request获取拉取请求的详细信息
comment_pullPull Request评论拉取请求
list_pull_commentsPull Request列出拉取请求的所有评论
get_diff_filesPull Request获取拉取请求的差异文件
create_issueIssue创建 Issue
update_issueIssue更新 Issue
get_repo_issue_detailIssue获取仓库 Issue 的详细信息
list_repo_issuesIssue列出仓库 Issue
comment_issueIssue评论 Issue
list_issue_commentsIssue列出 Issue 的评论
get_user_info用户获取当前认证用户信息
search_users用户搜索用户
list_user_notifications通知列出用户通知

贡献

我们欢迎开源社区的贡献!如果您想为这个项目做出贡献,请按照以下指南操作:

  1. Fork 这个仓库。
  2. 为您的功能或 bug 修复创建一个新分支。
  3. 进行更改,并确保代码有良好的文档。
  4. 提交一个 pull request,并附上清晰的更改描述。

如需进一步了解或遇到问题,欢迎查阅 官方文档 或联系技术支持。