feat: add configuration files and scripts for project setup ✨
🚀 Breaking Changes: - Introduced new environment variables for GitLab API integration - Added validation script for PR checks - Updated package.json with new scripts for testing and formatting 📝 Details: - Added .prettierrc and .eslintrc.json for code formatting and linting - Created .env.example for environment variable setup - Updated CHANGELOG.md with recent changes - Added documentation for GitHub secrets setup
This commit is contained in:
24
README.md
24
README.md
@ -8,6 +8,20 @@ GitLab MCP(Model Context Protocol) Server. **Includes bug fixes and improvements
|
||||
|
||||
<a href="https://glama.ai/mcp/servers/7jwbk4r6d7"><img width="380" height="200" src="https://glama.ai/mcp/servers/7jwbk4r6d7/badge" alt="gitlab mcp MCP server" /></a>
|
||||
|
||||
## 🚀 Automated Testing
|
||||
|
||||
This project uses GitHub Actions for automated PR testing. All pull requests are automatically tested across multiple Node.js versions (18.x, 20.x, 22.x) with:
|
||||
|
||||
- ✅ Build verification
|
||||
- ✅ Type checking
|
||||
- ✅ Code linting (ESLint)
|
||||
- ✅ Code formatting (Prettier)
|
||||
- ✅ API validation tests
|
||||
- ✅ Docker build verification
|
||||
- ✅ Security audit
|
||||
|
||||
For integration testing setup, see [GitHub Secrets Setup Guide](docs/setup-github-secrets.md).
|
||||
|
||||
## Usage
|
||||
|
||||
### Using with Claude App, Cline, Roo Code, Cursor
|
||||
@ -26,7 +40,8 @@ When using with the Claude App, you need to set up your API key and URLs directl
|
||||
"GITLAB_PERSONAL_ACCESS_TOKEN": "your_gitlab_token",
|
||||
"GITLAB_API_URL": "your_gitlab_api_url",
|
||||
"GITLAB_READ_ONLY_MODE": "false",
|
||||
"USE_GITLAB_WIKI": "true"
|
||||
"USE_GITLAB_WIKI": "false",
|
||||
"USE_MILESTONE": "false"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -52,13 +67,16 @@ When using with the Claude App, you need to set up your API key and URLs directl
|
||||
"GITLAB_READ_ONLY_MODE",
|
||||
"-e",
|
||||
"USE_GITLAB_WIKI",
|
||||
"-e",
|
||||
"USE_MILESTONE",
|
||||
"iwakitakuma/gitlab-mcp"
|
||||
],
|
||||
"env": {
|
||||
"GITLAB_PERSONAL_ACCESS_TOKEN": "your_gitlab_token",
|
||||
"GITLAB_API_URL": "https://gitlab.com/api/v4", // Optional, for self-hosted GitLab
|
||||
"GITLAB_READ_ONLY_MODE": "false",
|
||||
"USE_GITLAB_WIKI": "true"
|
||||
"USE_GITLAB_WIKI": "true",
|
||||
"USE_MILESTONE": "true"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -77,10 +95,12 @@ $ sh scripts/image_push.sh docker_user_name
|
||||
- `GITLAB_API_URL`: Your GitLab API URL. (Default: `https://gitlab.com/api/v4`)
|
||||
- `GITLAB_READ_ONLY_MODE`: When set to 'true', restricts the server to only expose read-only operations. Useful for enhanced security or when write access is not needed. Also useful for using with Cursor and it's 40 tool limit.
|
||||
- `USE_GITLAB_WIKI`: When set to 'true', enables the wiki-related tools (list_wiki_pages, get_wiki_page, create_wiki_page, update_wiki_page, delete_wiki_page). By default, wiki features are disabled.
|
||||
- `USE_MILESTONE`: When set to 'true', enables the milestone-related tools (list_milestones, get_milestone, create_milestone, edit_milestone, delete_milestone, get_milestone_issue, get_milestone_merge_requests, promote_milestone, get_milestone_burndown_events). By default, milestone features are disabled.
|
||||
|
||||
## Tools 🛠️
|
||||
|
||||
+<!-- TOOLS-START -->
|
||||
|
||||
1. `create_or_update_file` - Create or update a single file in a GitLab project
|
||||
2. `search_repositories` - Search for GitLab projects
|
||||
3. `create_repository` - Create a new GitLab project
|
||||
|
Reference in New Issue
Block a user