🚀 @yoda/digital MCP - GitLab 服务端
MCP - GitLab 是由 Yoda Digital 开发的中间件服务器，它基于 TypeScript 开源，借助 RESTful API 实现与 GitLab 的深度集成，为用户提供了丰富的操作能力，让 GitLab 的使用更加便捷高效。
🚀 快速开始
安装
npm install @yoda/digital/gitlab - mcp - server --save
初始化配置
创建一个 config.json 文件：
{
"gitlab": {
"url": "https://gitlab.example.com",
"private_token": "your_private_token"
}
}
启动服务：
node index.js
✨ 主要特性
- 问题与拉取请求操作：支持对 GitLab 问题和拉取请求的创建、查询、更新和删除。
- 代码库管理：提供对仓库的详细操作，包括文件管理和目录结构操作。
- GitLab Wiki 支持：实现对项目和组维基的全面管理。
- 团队协作功能：增强团队内部的协作能力，支持评论和提及功能。
- Webhook 支持：提供灵活的 Webhook 配置和管理。
📦 安装指南
npm install @yoda/digital/gitlab - mcp - server
💻 使用示例
基础用法
问题与拉取请求操作
创建问题
const issue = await client.issues.create({
title: '这是一个测试问题',
description: '这个问题是用来测试 API 的',
project_id: 'your_project_id'
});
查询问题
const issues = await client.issues.list({
project_id: 'your_project_id',
state: 'all' // 可选：`open` 或 `closed`
});
代码库操作
获取文件内容
const fileContent = await client.repositories.getFileContent({
project_id: 'your_project_id',
file_path: 'path/to/file.txt',
ref: 'main'
});
📚 详细文档
更详细的文档请访问我们的[文档网站](https://yoda - digital.github.io/mcp - gitlab - server/)或查阅源代码中的 TypeScript 定义。
💡 使用场景
- AI 驱动的开发工作流程：赋能 AI 助手与您的 GitLab 仓库交互。
- 自动化问题和 PR 管理：优化您的开发流程，借助 AI 辅助。
- Wiki 管理：实现文档更新和知识库管理的自动化。
- 团队协作：将 AI 助手整合到团队的 GitLab 工作流中。
📈 路线图
- [ ] 实现 GitLab CI/CD 集成
- [ ] 开发高级项目分析功能
- [ ] 扩展 Webhook 支持
- [ ] 支持 GitLab GraphQL API
未来的改进计划包括：
- 扩展 API 支持：增加更多 GitLab API 的支持。
- 优化性能：提升服务器响应速度和处理能力。
- 增强安全性：加强权限管理和安全措施。
- 多平台兼容性：支持更多操作系统和部署环境。
🤝 贡献指南
欢迎任何贡献！以下是参与方式：
- 叉仓库。
- 创建功能分支（
git checkout -b feature/amazing - feature）。 - 提交更改（
git commit -m '添加 awesome 功能'）。 - 推送到分支（
git push origin feature/amazing - feature）。 - 提交拉取请求。
请确保更新相关测试，并遵循项目代码风格，遵循[JavaScript 团队代码规范](https://github.com/yoda - digital/codeline/blob/main/.eslintrc.json)。
也可以通过以下方式参与项目：
- 提交问题：在[Issues](https://github.com/yoda - digital/mcp - gitlab - server/issues)中报告 bug 或提出功能需求。
- 参与讨论：加入我们的[Github Discussions](https://github.com/yoda - digital/mcp - gitlab - server/discussions)，分享您的想法和建议。
📄 许可证
本项目采用 MIT 许可证，具体内容详见LICENSE文件。MCP - GitLab 是开源项目，您可以在遵守许可协议的前提下自由使用、修改和分发本项目。
🎉 致谢
感谢所有为 MCP - GitLab 项目贡献代码、文档和测试的开发者和社区成员！