MCP Gitlab Server

🚀 @yoda/digital MCP-GitLab Server

MCP-GitLab is a middleware server developed by Yoda Digital, aiming to achieve deep integration with GitLab. This project is open - sourced in TypeScript and provides the ability to interact with GitLab through RESTful APIs.

🚀 Quick Start

Installation

npm install @yoda/digital/gitlab-mcp-server

Initial Configuration

Create a config.json file:

{
  "gitlab": {
    "url": "https://gitlab.example.com",
    "private_token": "your_private_token"
  }
}

Start the service:

node index.js

✨ Features

Core Functions

• Issue and Pull Request Operations: Support the creation, query, update, and deletion of GitLab issues and pull requests.
• Code Repository Management: Provide detailed operations on repositories, including file management and directory structure operations.
• GitLab Wiki Support: Implement comprehensive management of project and group wikis.
• Team Collaboration Features: Enhance the collaboration ability within the team, supporting commenting and mentioning functions.
• Webhook Support: Provide flexible Webhook configuration and management.

📦 Installation

npm install @yoda/digital/gitlab-mcp-server

💻 Usage Examples

Basic Usage

Issue and Pull Request Operations

Create an Issue

const issue = await client.issues.create({
  title: 'This is a test issue',
  description: 'This issue is used to test the API',
  project_id: 'your_project_id'
});

Query Issues

const issues = await client.issues.list({
  project_id: 'your_project_id',
  state: 'all' // Optional: `open` or `closed`
});

Code Repository Operations

Get File Content

const fileContent = await client.repositories.getFileContent({
  project_id: 'your_project_id',
  file_path: 'path/to/file.txt',
  ref: 'main'
});

📚 Documentation

For more detailed documentation, please visit our documentation website or refer to the TypeScript definitions in the source code.

💡 Usage Scenarios

• AI - Driven Development Workflow: Empower AI assistants to interact with your GitLab repositories.
• Automated Issue and PR Management: Optimize your development process with AI assistance.
• Wiki Management: Automate document updates and knowledge base management.
• Team Collaboration: Integrate AI assistants into the team's GitLab workflow.

📈 Roadmap

• [ ] Implement GitLab CI/CD integration.
• [ ] Develop advanced project analysis features.
• [ ] Expand Webhook support.
• [ ] Support GitLab GraphQL API.

🤝 Contribution Guidelines

We welcome any contributions! Here's how you can get involved:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add awesome feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Submit a pull request.

Please ensure that you update the relevant tests and follow the project's code style.

📄 License

This project is licensed under the MIT license. For more details, please see the LICENSE file.

🎉 Acknowledgments

Thank you to all developers and community members who have contributed to this project!

🛠️ Function Modules

Issue and Pull Request Operations

• Create an issue
• Update an issue
• Delete an issue
• Query a list of issues
• Create a pull request
• Update a pull request
• Delete a pull request

Code Repository Operations

• Get file content
• Submit file changes
• Create a branch
• Switch branches
• Merge branches

GitLab Wiki

• Create a wiki page
• Update a wiki page
• Query a wiki page
• Delete a wiki page

Team Collaboration

• Post a comment
• Mention a user
• Query a list of comments

Webhook Support

• Add a Webhook
• Modify a Webhook
• Delete a Webhook
• Trigger a Webhook

📋 Documentation

• Quick Start Guide: Learn how to start using MCP - GitLab.
• Detailed API Documentation: Explore the usage and parameters of each interface.
• Best Practices: Get practical suggestions for project development.

📈 Future Roadmap

Future improvement plans include:

1. Expand API Support: Add support for more GitLab APIs.
2. Optimize Performance: Improve server response speed and processing capacity.
3. Enhance Security: Strengthen permission management and security measures.
4. Multi - platform Compatibility: Support more operating systems and deployment environments.

🤝 Contribution Guidelines

• Submit an Issue: Report bugs or propose feature requests in Issues.
• Participate in Discussions: Join our Github Discussions to share your ideas and suggestions.
• Contribute Code: Fork the repository and submit a Pull Request.

📄 License

MCP - GitLab is an open - source project licensed under the MIT license. You can freely use, modify, and distribute this project in compliance with the license agreement.

🎉 Acknowledgments

Thank you to all developers and community members who have contributed code, documentation, and tests to the MCP - GitLab project!