🚀 Gitee开源工具
Gitee 是一个基于模型上下文协议（Model Context Protocol, MCP）的开源工具，它旨在简化与 Gitee 平台的交互操作。通过提供多种功能模块，能帮助开发者高效管理代码仓库、处理 pull request 和 issue 等任务。
🚀 快速开始
Gitee 工具可助力开发者高效管理代码仓库、处理 pull request 和 issue 等任务。你可按以下步骤安装使用：
📦 安装指南
安装步骤
- 克隆项目仓库：
git clone https://gitee.com/yourusername/mcp.git
cd mcp
- 安装依赖项：
go mod tidy
- 启动服务：
go run main.go --port=8080
💻 使用示例
基础用法
配置示例
环境变量配置
export GITEE_TOKEN="your_token"
export GITEE_API_BASE="https://gitee.com/api/v3"
命令行选项
--token 明文 API 令牌
--port 指定服务监听的端口 [默认: "8080"]
--mode {development|production} 设置运行模式 [可选值: development, production]
高级用法
工具集管理
管理方式
-
白名单模式：
- 使用
--enabled-tools参数或ENABLED_TOOLS环境变量指定允许的工具，其余工具将被禁用。 - 示例：
--enabled-tools="list_repos,get_file"
- 使用
-
黑名单模式：
- 使用
--disabled-tools参数或DISABLED_TOOLS环境变量指定禁止使用的工具，其余工具默认启用。 - 示例：
--disabled-tools="list_repos,get_file"
- 使用
注意事项
⚠️ 重要提示
- 若同时配置了
enabled-tools和disabled-tools，白名单优先级更高。- 工具名称区分大小写。
📚 详细文档
可用工具
该服务提供了多种与 Gitee 平台交互的功能模块：
| 属性 | 详情 |
|---|---|
| 工具名称 | list_repos、get_file_content、create_user_repo、create_org_repo、create_enter_repo、fork_repository、create_release、list_releases、search_repos、list_pulls、merge_pull、create_pull、update_pull、get_pull_detail、comment_pull、list_comments、create_issue、update_issue、get_issue_detail、list_issues、comment_issue、list_comments、get_user_info、search_users、list_notifications |
| 类别 | 代码仓库、发布、搜索、Pull Request、Issue、用户、通知 |
| 描述 | 列出用户授权的代码仓库、获取仓库中文件的内容、创建个人代码仓库、创建组织代码仓库、创建企业级代码仓库、叉取仓库、创建新发布版本、列出仓库的所有发布版本、搜索开源项目、列出仓库的Pull Request、合并Pull Request、创建新的Pull Request、更新指定的Pull Request、获取特定Pull Request的详细信息、在Pull Request上发表评论、列出Pull Request下的所有评论、创建新的Issue、更新指定的Issue、获取特定Issue的详细信息、列出仓库中的所有Issue、在Issue上发表评论、列出Issue下的所有评论、获取当前认证用户的详细信息、搜索指定用户、列出用户的所有通知 |
贡献指南
我们欢迎社区贡献！如果你希望参与项目，请遵循以下步骤：
- Fork 该项目仓库。
- 在你的Fork中创建一个新的分支用于功能开发或问题修复。
- 提交代码更改并推送至远程仓库。
- 创建 Pull Request 到原项目仓库。
💡 使用建议
- 遵循 Go 语言的编码规范和命名习惯。
- 提供完整的单元测试用例。
- 确保代码提交信息清晰易懂。
📄 许可证
本项目遵循 MIT 协议，具体条款请参考 LICENSE 文件。