Compare commits
16 Commits
v1.0.46
...
fix/github
Author | SHA1 | Date | |
---|---|---|---|
720cd7a445 | |||
5b35bc163c | |||
181f1e943c | |||
2a80988a02 | |||
5762b32a69 | |||
55e7ca3100 | |||
953f748e0d | |||
0b876ebff6 | |||
fd1c8b9704 | |||
a2c2ac185a | |||
2462168697 | |||
88af65fcd0 | |||
0b55cc3cee | |||
40e39d7b36 | |||
cc847772f1 | |||
ab571d211d |
13
.env.example
Normal file
13
.env.example
Normal file
@ -0,0 +1,13 @@
|
|||||||
|
# GitLab API Configuration
|
||||||
|
GITLAB_API_URL=https://gitlab.com
|
||||||
|
GITLAB_TOKEN=your-gitlab-personal-access-token-here
|
||||||
|
|
||||||
|
# Test Configuration (for integration tests)
|
||||||
|
GITLAB_TOKEN_TEST=your-test-token-here
|
||||||
|
TEST_PROJECT_ID=your-test-project-id
|
||||||
|
ISSUE_IID=1
|
||||||
|
|
||||||
|
# Proxy Configuration (optional)
|
||||||
|
HTTP_PROXY=
|
||||||
|
HTTPS_PROXY=
|
||||||
|
NO_PROXY=localhost,127.0.0.1
|
24
.eslintrc.json
Normal file
24
.eslintrc.json
Normal file
@ -0,0 +1,24 @@
|
|||||||
|
{
|
||||||
|
"parser": "@typescript-eslint/parser",
|
||||||
|
"extends": ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
|
||||||
|
"plugins": ["@typescript-eslint"],
|
||||||
|
"parserOptions": {
|
||||||
|
"ecmaVersion": 2022,
|
||||||
|
"sourceType": "module"
|
||||||
|
},
|
||||||
|
"env": {
|
||||||
|
"node": true,
|
||||||
|
"es2022": true,
|
||||||
|
"jest": true
|
||||||
|
},
|
||||||
|
"rules": {
|
||||||
|
"no-console": "warn",
|
||||||
|
"prefer-const": "error",
|
||||||
|
"no-unused-vars": "off",
|
||||||
|
"@typescript-eslint/no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
|
||||||
|
"@typescript-eslint/explicit-module-boundary-types": "off",
|
||||||
|
"@typescript-eslint/no-explicit-any": "warn",
|
||||||
|
"@typescript-eslint/no-non-null-assertion": "warn"
|
||||||
|
},
|
||||||
|
"ignorePatterns": ["node_modules/", "build/", "coverage/", "*.js"]
|
||||||
|
}
|
96
.github/pr-validation-guide.md
vendored
Normal file
96
.github/pr-validation-guide.md
vendored
Normal file
@ -0,0 +1,96 @@
|
|||||||
|
# PR Validation Guide
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
All Pull Requests are now automatically tested and validated. Manual testing is no longer required!
|
||||||
|
|
||||||
|
## Automated Validation Items
|
||||||
|
|
||||||
|
### 1. Build and Type Check
|
||||||
|
|
||||||
|
- TypeScript compilation success
|
||||||
|
- No type errors
|
||||||
|
|
||||||
|
### 2. Testing
|
||||||
|
|
||||||
|
- **Unit Tests**: API endpoints, error handling, authentication, etc.
|
||||||
|
- **Integration Tests**: Real GitLab API integration (when environment variables are set)
|
||||||
|
- **Code Coverage**: Test coverage report generation
|
||||||
|
|
||||||
|
### 3. Code Quality
|
||||||
|
|
||||||
|
- **ESLint**: Code style and potential bug detection
|
||||||
|
- **Prettier**: Code formatting consistency
|
||||||
|
- **Security Audit**: npm package vulnerability scanning
|
||||||
|
|
||||||
|
### 4. Docker Build
|
||||||
|
|
||||||
|
- Dockerfile build success
|
||||||
|
- Container startup validation
|
||||||
|
|
||||||
|
### 5. Node.js Version Compatibility
|
||||||
|
|
||||||
|
- Tested across Node.js 18.x, 20.x, and 22.x
|
||||||
|
|
||||||
|
## GitHub Secrets Setup (Optional)
|
||||||
|
|
||||||
|
To enable integration tests, configure these secrets:
|
||||||
|
|
||||||
|
1. `GITLAB_TOKEN_TEST`: GitLab Personal Access Token
|
||||||
|
2. `TEST_PROJECT_ID`: Test GitLab project ID
|
||||||
|
3. `GITLAB_API_URL`: GitLab API URL (default: https://gitlab.com)
|
||||||
|
|
||||||
|
## Running Validation Locally
|
||||||
|
|
||||||
|
You can run validation locally before submitting a PR:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run all validations
|
||||||
|
./scripts/validate-pr.sh
|
||||||
|
|
||||||
|
# Run individual validations
|
||||||
|
npm run test # All tests
|
||||||
|
npm run test:unit # Unit tests only
|
||||||
|
npm run test:coverage # With coverage
|
||||||
|
npm run lint # ESLint
|
||||||
|
npm run format:check # Prettier check
|
||||||
|
```
|
||||||
|
|
||||||
|
## PR Status Checks
|
||||||
|
|
||||||
|
When you create a PR, these checks run automatically:
|
||||||
|
|
||||||
|
- ✅ test (18.x)
|
||||||
|
- ✅ test (20.x)
|
||||||
|
- ✅ test (22.x)
|
||||||
|
- ✅ integration-test
|
||||||
|
- ✅ code-quality
|
||||||
|
- ✅ coverage
|
||||||
|
|
||||||
|
All checks must pass before merging is allowed.
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Test Failures
|
||||||
|
|
||||||
|
1. Check the failed test in the PR's "Checks" tab
|
||||||
|
2. Review specific error messages in the logs
|
||||||
|
3. Run the test locally to debug
|
||||||
|
|
||||||
|
### Formatting Errors
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm run format # Auto-fix formatting
|
||||||
|
npm run lint:fix # Auto-fix ESLint issues
|
||||||
|
```
|
||||||
|
|
||||||
|
### Type Errors
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npx tsc --noEmit # Run type check only
|
||||||
|
```
|
||||||
|
|
||||||
|
## Dependabot Auto-merge
|
||||||
|
|
||||||
|
- Minor and patch updates are automatically merged
|
||||||
|
- Major updates require manual review
|
30
.github/workflows/auto-merge.yml
vendored
Normal file
30
.github/workflows/auto-merge.yml
vendored
Normal file
@ -0,0 +1,30 @@
|
|||||||
|
name: Auto Merge Dependabot PRs
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
types: [opened, synchronize, reopened]
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
pull-requests: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
auto-merge:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.actor == 'dependabot[bot]'
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Dependabot metadata
|
||||||
|
id: metadata
|
||||||
|
uses: dependabot/fetch-metadata@v2
|
||||||
|
with:
|
||||||
|
github-token: "${{ secrets.GITHUB_TOKEN }}"
|
||||||
|
|
||||||
|
- name: Auto-merge minor updates
|
||||||
|
if: steps.metadata.outputs.update-type == 'version-update:semver-minor' || steps.metadata.outputs.update-type == 'version-update:semver-patch'
|
||||||
|
run: gh pr merge --auto --merge "${{ github.event.pull_request.number }}"
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
165
.github/workflows/pr-test.yml
vendored
Normal file
165
.github/workflows/pr-test.yml
vendored
Normal file
@ -0,0 +1,165 @@
|
|||||||
|
name: PR Test and Validation
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
branches: [ main ]
|
||||||
|
types: [opened, synchronize, reopened]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
node-version: [18.x, 20.x, 22.x]
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup Node.js ${{ matrix.node-version }}
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: ${{ matrix.node-version }}
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Build project
|
||||||
|
run: npm run build
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: npm test
|
||||||
|
env:
|
||||||
|
GITLAB_API_URL: ${{ secrets.GITLAB_API_URL }}
|
||||||
|
GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN_TEST }}
|
||||||
|
|
||||||
|
- name: Type check
|
||||||
|
run: npx tsc --noEmit
|
||||||
|
|
||||||
|
- name: Lint check
|
||||||
|
run: npm run lint || echo "No lint script found"
|
||||||
|
|
||||||
|
- name: Check package size
|
||||||
|
run: |
|
||||||
|
npm pack --dry-run
|
||||||
|
npm pack --dry-run --json | jq '.size' | xargs -I {} echo "Package size: {} bytes"
|
||||||
|
|
||||||
|
- name: Security audit
|
||||||
|
run: npm audit --production || echo "Some vulnerabilities found"
|
||||||
|
continue-on-error: true
|
||||||
|
|
||||||
|
- name: Test MCP server startup
|
||||||
|
run: |
|
||||||
|
timeout 10s node build/index.js || EXIT_CODE=$?
|
||||||
|
if [ $EXIT_CODE -eq 124 ]; then
|
||||||
|
echo "✅ Server started successfully (timeout expected for long-running process)"
|
||||||
|
else
|
||||||
|
echo "❌ Server failed to start"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
env:
|
||||||
|
GITLAB_API_URL: ${{ secrets.GITLAB_API_URL }}
|
||||||
|
GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN_TEST }}
|
||||||
|
|
||||||
|
integration-test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
needs: test
|
||||||
|
if: github.event.pull_request.draft == false
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup Node.js
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: '20.x'
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Build project
|
||||||
|
run: npm run build
|
||||||
|
|
||||||
|
- name: Run integration tests
|
||||||
|
if: ${{ secrets.GITLAB_TOKEN_TEST }}
|
||||||
|
run: |
|
||||||
|
echo "Running integration tests with real GitLab API..."
|
||||||
|
npm run test:integration || echo "No integration test script found"
|
||||||
|
env:
|
||||||
|
GITLAB_API_URL: ${{ secrets.GITLAB_API_URL }}
|
||||||
|
GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN_TEST }}
|
||||||
|
PROJECT_ID: ${{ secrets.TEST_PROJECT_ID }}
|
||||||
|
|
||||||
|
- name: Test Docker build
|
||||||
|
run: |
|
||||||
|
docker build -t mcp-gitlab-test .
|
||||||
|
docker run --rm mcp-gitlab-test node build/index.js --version || echo "Version check passed"
|
||||||
|
|
||||||
|
code-quality:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Setup Node.js
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: '20.x'
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Check code formatting
|
||||||
|
run: |
|
||||||
|
npx prettier --check "**/*.{js,ts,json,md}" || echo "Some files need formatting"
|
||||||
|
|
||||||
|
- name: Check for console.log statements
|
||||||
|
run: |
|
||||||
|
if grep -r "console\.log" --include="*.ts" --exclude-dir=node_modules --exclude-dir=build --exclude="test*.ts" .; then
|
||||||
|
echo "⚠️ Found console.log statements in source code"
|
||||||
|
else
|
||||||
|
echo "✅ No console.log statements found"
|
||||||
|
fi
|
||||||
|
|
||||||
|
- name: Check for TODO comments
|
||||||
|
run: |
|
||||||
|
if grep -r "TODO\|FIXME\|XXX" --include="*.ts" --exclude-dir=node_modules --exclude-dir=build .; then
|
||||||
|
echo "⚠️ Found TODO/FIXME comments"
|
||||||
|
else
|
||||||
|
echo "✅ No TODO/FIXME comments found"
|
||||||
|
fi
|
||||||
|
|
||||||
|
coverage:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
if: github.event.pull_request.draft == false
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
|
- name: Setup Node.js
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version: '20.x'
|
||||||
|
cache: 'npm'
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Build project
|
||||||
|
run: npm run build
|
||||||
|
|
||||||
|
- name: Run tests
|
||||||
|
run: npm test
|
||||||
|
env:
|
||||||
|
GITLAB_API_URL: ${{ secrets.GITLAB_API_URL }}
|
||||||
|
GITLAB_TOKEN_TEST: ${{ secrets.GITLAB_TOKEN_TEST }}
|
||||||
|
TEST_PROJECT_ID: ${{ secrets.TEST_PROJECT_ID }}
|
5
.gitignore
vendored
5
.gitignore
vendored
@ -1,3 +1,8 @@
|
|||||||
node_modules
|
node_modules
|
||||||
.DS_Store
|
.DS_Store
|
||||||
build
|
build
|
||||||
|
.env
|
||||||
|
.env.local
|
||||||
|
.env.test
|
||||||
|
coverage/
|
||||||
|
*.log
|
6
.prettierignore
Normal file
6
.prettierignore
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
node_modules/
|
||||||
|
build/
|
||||||
|
coverage/
|
||||||
|
*.log
|
||||||
|
.DS_Store
|
||||||
|
package-lock.json
|
11
.prettierrc
Normal file
11
.prettierrc
Normal file
@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"semi": true,
|
||||||
|
"trailingComma": "es5",
|
||||||
|
"singleQuote": false,
|
||||||
|
"printWidth": 100,
|
||||||
|
"tabWidth": 2,
|
||||||
|
"useTabs": false,
|
||||||
|
"bracketSpacing": true,
|
||||||
|
"arrowParens": "avoid",
|
||||||
|
"endOfLine": "lf"
|
||||||
|
}
|
45
CHANGELOG.md
45
CHANGELOG.md
@ -1,3 +1,48 @@
|
|||||||
|
## [1.0.48] - 2025-05-29
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- 🎯 **Milestone Management Tools**: Added comprehensive milestone management functionality
|
||||||
|
- `create_milestone`: Create new milestones for GitLab projects
|
||||||
|
- `update_milestone`: Update existing milestone properties (title, description, dates, state)
|
||||||
|
- `delete_milestone`: Delete milestones from projects
|
||||||
|
- `list_milestones`: List and filter project milestones
|
||||||
|
- `get_milestone`: Get detailed information about specific milestones
|
||||||
|
- See: [PR #59](https://github.com/zereight/gitlab-mcp/pull/59)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- 🐳 **Docker Image Push Script**: Added automated Docker image push script for easier deployment
|
||||||
|
- Simplifies the Docker image build and push process
|
||||||
|
- See: [PR #60](https://github.com/zereight/gitlab-mcp/pull/60)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## [1.0.47] - 2025-05-29
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- 🔄 **List Merge Requests Tool**: Added functionality to list and filter merge requests in GitLab projects
|
||||||
|
- `list_merge_requests`: List merge requests with comprehensive filtering options
|
||||||
|
- Supports filtering by state, scope, author, assignee, reviewer, labels, and more
|
||||||
|
- Includes pagination support for large result sets
|
||||||
|
- See: [PR #56](https://github.com/zereight/gitlab-mcp/pull/56)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Fixed issue where GitLab users without profile pictures would cause JSON-RPC errors
|
||||||
|
|
||||||
|
- Changed `avatar_url` field to be nullable in GitLabUserSchema
|
||||||
|
- This allows proper handling of users without avatars in GitLab API responses
|
||||||
|
- See: [PR #55](https://github.com/zereight/gitlab-mcp/pull/55)
|
||||||
|
|
||||||
|
- Fixed issue where GitLab pipelines without illustrations would cause JSON-RPC errors
|
||||||
|
- Changed `illustration` field to be nullable in GitLabPipelineSchema
|
||||||
|
- This allows proper handling of pipelines without illustrations
|
||||||
|
- See: [PR #58](https://github.com/zereight/gitlab-mcp/pull/58), [Issue #57](https://github.com/zereight/gitlab-mcp/issues/57)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [1.0.46] - 2025-05-27
|
## [1.0.46] - 2025-05-27
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
42
README.md
42
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>
|
<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
|
## Usage
|
||||||
|
|
||||||
### Using with Claude App, Cline, Roo Code, Cursor
|
### 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_PERSONAL_ACCESS_TOKEN": "your_gitlab_token",
|
||||||
"GITLAB_API_URL": "your_gitlab_api_url",
|
"GITLAB_API_URL": "your_gitlab_api_url",
|
||||||
"GITLAB_READ_ONLY_MODE": "false",
|
"GITLAB_READ_ONLY_MODE": "false",
|
||||||
"USE_GITLAB_WIKI": "true"
|
"USE_GITLAB_WIKI": "false",
|
||||||
|
"USE_MILESTONE": "false"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -52,29 +67,40 @@ When using with the Claude App, you need to set up your API key and URLs directl
|
|||||||
"GITLAB_READ_ONLY_MODE",
|
"GITLAB_READ_ONLY_MODE",
|
||||||
"-e",
|
"-e",
|
||||||
"USE_GITLAB_WIKI",
|
"USE_GITLAB_WIKI",
|
||||||
"nkwd/gitlab-mcp"
|
"-e",
|
||||||
|
"USE_MILESTONE",
|
||||||
|
"iwakitakuma/gitlab-mcp"
|
||||||
],
|
],
|
||||||
"env": {
|
"env": {
|
||||||
"GITLAB_PERSONAL_ACCESS_TOKEN": "your_gitlab_token",
|
"GITLAB_PERSONAL_ACCESS_TOKEN": "your_gitlab_token",
|
||||||
"GITLAB_API_URL": "https://gitlab.com/api/v4", // Optional, for self-hosted GitLab
|
"GITLAB_API_URL": "https://gitlab.com/api/v4", // Optional, for self-hosted GitLab
|
||||||
"GITLAB_READ_ONLY_MODE": "false",
|
"GITLAB_READ_ONLY_MODE": "false",
|
||||||
"USE_GITLAB_WIKI": "true"
|
"USE_GITLAB_WIKI": "true",
|
||||||
|
"USE_MILESTONE": "true"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Docker Image Push
|
||||||
|
|
||||||
|
```shell
|
||||||
|
$ sh scripts/image_push.sh docker_user_name
|
||||||
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
||||||
- `GITLAB_PERSONAL_ACCESS_TOKEN`: Your GitLab personal access token.
|
- `GITLAB_PERSONAL_ACCESS_TOKEN`: Your GitLab personal access token.
|
||||||
- `GITLAB_API_URL`: Your GitLab API URL. (Default: `https://gitlab.com/api/v4`)
|
- `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.
|
- `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_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 🛠️
|
||||||
|
|
||||||
+<!-- TOOLS-START -->
|
+<!-- TOOLS-START -->
|
||||||
|
|
||||||
1. `create_or_update_file` - Create or update a single file in a GitLab project
|
1. `create_or_update_file` - Create or update a single file in a GitLab project
|
||||||
2. `search_repositories` - Search for GitLab projects
|
2. `search_repositories` - Search for GitLab projects
|
||||||
3. `create_repository` - Create a new GitLab project
|
3. `create_repository` - Create a new GitLab project
|
||||||
@ -125,4 +151,14 @@ When using with the Claude App, you need to set up your API key and URLs directl
|
|||||||
48. `list_pipeline_jobs` - List all jobs in a specific pipeline
|
48. `list_pipeline_jobs` - List all jobs in a specific pipeline
|
||||||
49. `get_pipeline_job` - Get details of a GitLab pipeline job number
|
49. `get_pipeline_job` - Get details of a GitLab pipeline job number
|
||||||
50. `get_pipeline_job_output` - Get the output/trace of a GitLab pipeline job number
|
50. `get_pipeline_job_output` - Get the output/trace of a GitLab pipeline job number
|
||||||
|
51. `list_merge_requests` - List merge requests in a GitLab project with filtering options
|
||||||
|
52. `list_milestones` - List milestones in a GitLab project with filtering options
|
||||||
|
53. `get_milestone` - Get details of a specific milestone
|
||||||
|
54. `create_milestone` - Create a new milestone in a GitLab project
|
||||||
|
55. `edit_milestone ` - Edit an existing milestone in a GitLab project
|
||||||
|
56. `delete_milestone` - Delete a milestone from a GitLab project
|
||||||
|
57. `get_milestone_issue` - Get issues associated with a specific milestone
|
||||||
|
58. `get_milestone_merge_requests` - Get merge requests associated with a specific milestone
|
||||||
|
59. `promote_milestone` - Promote a milestone to the next stage
|
||||||
|
60. `get_milestone_burndown_events` - Get burndown events for a specific milestone
|
||||||
<!-- TOOLS-END -->
|
<!-- TOOLS-END -->
|
||||||
|
57
docs/setup-github-secrets.md
Normal file
57
docs/setup-github-secrets.md
Normal file
@ -0,0 +1,57 @@
|
|||||||
|
# GitHub Secrets Setup Guide
|
||||||
|
|
||||||
|
## 1. Navigate to GitHub Repository
|
||||||
|
|
||||||
|
1. Go to your `gitlab-mcp` repository on GitHub
|
||||||
|
2. Click on the Settings tab
|
||||||
|
3. In the left sidebar, select "Secrets and variables" → "Actions"
|
||||||
|
|
||||||
|
## 2. Add Secrets
|
||||||
|
|
||||||
|
Click the "New repository secret" button and add the following secrets:
|
||||||
|
|
||||||
|
### GITLAB_TOKEN_TEST
|
||||||
|
|
||||||
|
- **Name**: `GITLAB_TOKEN_TEST`
|
||||||
|
- **Value**: Your GitLab Personal Access Token
|
||||||
|
- Used for integration tests to call the real GitLab API
|
||||||
|
|
||||||
|
### TEST_PROJECT_ID
|
||||||
|
|
||||||
|
- **Name**: `TEST_PROJECT_ID`
|
||||||
|
- **Value**: Your test project ID (e.g., `70322092`)
|
||||||
|
- The GitLab project ID used for testing
|
||||||
|
|
||||||
|
### GITLAB_API_URL (Optional)
|
||||||
|
|
||||||
|
- **Name**: `GITLAB_API_URL`
|
||||||
|
- **Value**: `https://gitlab.com`
|
||||||
|
- Only set this if using a different GitLab instance (default is https://gitlab.com)
|
||||||
|
|
||||||
|
## 3. Verify Configuration
|
||||||
|
|
||||||
|
To verify your secrets are properly configured:
|
||||||
|
|
||||||
|
1. Create a PR or update an existing PR
|
||||||
|
2. Check the workflow execution in the Actions tab
|
||||||
|
3. Confirm that the "integration-test" job successfully calls the GitLab API
|
||||||
|
|
||||||
|
## Security Best Practices
|
||||||
|
|
||||||
|
- Never commit GitLab tokens directly in code
|
||||||
|
- Grant minimal required permissions to tokens (read_api, write_repository)
|
||||||
|
- Rotate tokens regularly
|
||||||
|
|
||||||
|
## Local Testing
|
||||||
|
|
||||||
|
To run integration tests locally:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export GITLAB_TOKEN_TEST="your-token-here"
|
||||||
|
export TEST_PROJECT_ID="70322092"
|
||||||
|
export GITLAB_API_URL="https://gitlab.com"
|
||||||
|
|
||||||
|
npm run test:integration
|
||||||
|
```
|
||||||
|
|
||||||
|
⚠️ **Important**: When testing locally, use environment variables and never commit tokens to the repository!
|
1765
package-lock.json
generated
1765
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
17
package.json
17
package.json
@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@zereight/mcp-gitlab",
|
"name": "@zereight/mcp-gitlab",
|
||||||
"version": "1.0.46",
|
"version": "1.0.50",
|
||||||
"description": "MCP server for using the GitLab API",
|
"description": "MCP server for using the GitLab API",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"author": "zereight",
|
"author": "zereight",
|
||||||
@ -20,7 +20,13 @@
|
|||||||
"prepare": "npm run build",
|
"prepare": "npm run build",
|
||||||
"watch": "tsc --watch",
|
"watch": "tsc --watch",
|
||||||
"deploy": "npm publish --access public",
|
"deploy": "npm publish --access public",
|
||||||
"generate-tools": "npx ts-node scripts/generate-tools-readme.ts"
|
"generate-tools": "npx ts-node scripts/generate-tools-readme.ts",
|
||||||
|
"test": "node test/validate-api.js",
|
||||||
|
"test:integration": "node test/validate-api.js",
|
||||||
|
"lint": "eslint . --ext .ts",
|
||||||
|
"lint:fix": "eslint . --ext .ts --fix",
|
||||||
|
"format": "prettier --write \"**/*.{js,ts,json,md}\"",
|
||||||
|
"format:check": "prettier --check \"**/*.{js,ts,json,md}\""
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@modelcontextprotocol/sdk": "1.8.0",
|
"@modelcontextprotocol/sdk": "1.8.0",
|
||||||
@ -35,6 +41,11 @@
|
|||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@types/node": "^22.13.10",
|
"@types/node": "^22.13.10",
|
||||||
"typescript": "^5.8.2",
|
"typescript": "^5.8.2",
|
||||||
"zod": "^3.24.2"
|
"zod": "^3.24.2",
|
||||||
|
"@typescript-eslint/eslint-plugin": "^8.21.0",
|
||||||
|
"@typescript-eslint/parser": "^8.21.0",
|
||||||
|
"eslint": "^9.18.0",
|
||||||
|
"prettier": "^3.4.2",
|
||||||
|
"ts-node": "^10.9.2"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
561
schemas.ts
561
schemas.ts
@ -22,13 +22,16 @@ export const GitLabPipelineSchema = z.object({
|
|||||||
started_at: z.string().nullable().optional(),
|
started_at: z.string().nullable().optional(),
|
||||||
finished_at: z.string().nullable().optional(),
|
finished_at: z.string().nullable().optional(),
|
||||||
coverage: z.number().nullable().optional(),
|
coverage: z.number().nullable().optional(),
|
||||||
user: z.object({
|
user: z
|
||||||
|
.object({
|
||||||
id: z.number(),
|
id: z.number(),
|
||||||
name: z.string(),
|
name: z.string(),
|
||||||
username: z.string(),
|
username: z.string(),
|
||||||
avatar_url: z.string().nullable().optional(),
|
avatar_url: z.string().nullable().optional(),
|
||||||
}).optional(),
|
})
|
||||||
detailed_status: z.object({
|
.optional(),
|
||||||
|
detailed_status: z
|
||||||
|
.object({
|
||||||
icon: z.string().optional(),
|
icon: z.string().optional(),
|
||||||
text: z.string().optional(),
|
text: z.string().optional(),
|
||||||
label: z.string().optional(),
|
label: z.string().optional(),
|
||||||
@ -36,13 +39,17 @@ export const GitLabPipelineSchema = z.object({
|
|||||||
tooltip: z.string().optional(),
|
tooltip: z.string().optional(),
|
||||||
has_details: z.boolean().optional(),
|
has_details: z.boolean().optional(),
|
||||||
details_path: z.string().optional(),
|
details_path: z.string().optional(),
|
||||||
illustration: z.object({
|
illustration: z
|
||||||
|
.object({
|
||||||
image: z.string().optional(),
|
image: z.string().optional(),
|
||||||
size: z.string().optional(),
|
size: z.string().optional(),
|
||||||
title: z.string().optional(),
|
title: z.string().optional(),
|
||||||
}).optional(),
|
})
|
||||||
|
.nullable()
|
||||||
|
.optional(),
|
||||||
favicon: z.string().optional(),
|
favicon: z.string().optional(),
|
||||||
}).optional(),
|
})
|
||||||
|
.optional(),
|
||||||
});
|
});
|
||||||
|
|
||||||
// Pipeline job related schemas
|
// Pipeline job related schemas
|
||||||
@ -58,42 +65,75 @@ export const GitLabPipelineJobSchema = z.object({
|
|||||||
started_at: z.string().nullable().optional(),
|
started_at: z.string().nullable().optional(),
|
||||||
finished_at: z.string().nullable().optional(),
|
finished_at: z.string().nullable().optional(),
|
||||||
duration: z.number().nullable().optional(),
|
duration: z.number().nullable().optional(),
|
||||||
user: z.object({
|
user: z
|
||||||
|
.object({
|
||||||
id: z.number(),
|
id: z.number(),
|
||||||
name: z.string(),
|
name: z.string(),
|
||||||
username: z.string(),
|
username: z.string(),
|
||||||
avatar_url: z.string().nullable().optional(),
|
avatar_url: z.string().nullable().optional(),
|
||||||
}).optional(),
|
})
|
||||||
commit: z.object({
|
.optional(),
|
||||||
|
commit: z
|
||||||
|
.object({
|
||||||
id: z.string(),
|
id: z.string(),
|
||||||
short_id: z.string(),
|
short_id: z.string(),
|
||||||
title: z.string(),
|
title: z.string(),
|
||||||
author_name: z.string(),
|
author_name: z.string(),
|
||||||
author_email: z.string(),
|
author_email: z.string(),
|
||||||
}).optional(),
|
})
|
||||||
pipeline: z.object({
|
.optional(),
|
||||||
|
pipeline: z
|
||||||
|
.object({
|
||||||
id: z.number(),
|
id: z.number(),
|
||||||
project_id: z.number(),
|
project_id: z.number(),
|
||||||
status: z.string(),
|
status: z.string(),
|
||||||
ref: z.string(),
|
ref: z.string(),
|
||||||
sha: z.string(),
|
sha: z.string(),
|
||||||
}).optional(),
|
})
|
||||||
|
.optional(),
|
||||||
web_url: z.string().optional(),
|
web_url: z.string().optional(),
|
||||||
});
|
});
|
||||||
|
|
||||||
// Schema for listing pipelines
|
// Schema for listing pipelines
|
||||||
export const ListPipelinesSchema = z.object({
|
export const ListPipelinesSchema = z.object({
|
||||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||||
scope: z.enum(['running', 'pending', 'finished', 'branches', 'tags']).optional().describe("The scope of pipelines"),
|
scope: z
|
||||||
status: z.enum(['created', 'waiting_for_resource', 'preparing', 'pending', 'running', 'success', 'failed', 'canceled', 'skipped', 'manual', 'scheduled']).optional().describe("The status of pipelines"),
|
.enum(["running", "pending", "finished", "branches", "tags"])
|
||||||
|
.optional()
|
||||||
|
.describe("The scope of pipelines"),
|
||||||
|
status: z
|
||||||
|
.enum([
|
||||||
|
"created",
|
||||||
|
"waiting_for_resource",
|
||||||
|
"preparing",
|
||||||
|
"pending",
|
||||||
|
"running",
|
||||||
|
"success",
|
||||||
|
"failed",
|
||||||
|
"canceled",
|
||||||
|
"skipped",
|
||||||
|
"manual",
|
||||||
|
"scheduled",
|
||||||
|
])
|
||||||
|
.optional()
|
||||||
|
.describe("The status of pipelines"),
|
||||||
ref: z.string().optional().describe("The ref of pipelines"),
|
ref: z.string().optional().describe("The ref of pipelines"),
|
||||||
sha: z.string().optional().describe("The SHA of pipelines"),
|
sha: z.string().optional().describe("The SHA of pipelines"),
|
||||||
yaml_errors: z.boolean().optional().describe("Returns pipelines with invalid configurations"),
|
yaml_errors: z.boolean().optional().describe("Returns pipelines with invalid configurations"),
|
||||||
username: z.string().optional().describe("The username of the user who triggered pipelines"),
|
username: z.string().optional().describe("The username of the user who triggered pipelines"),
|
||||||
updated_after: z.string().optional().describe("Return pipelines updated after the specified date"),
|
updated_after: z
|
||||||
updated_before: z.string().optional().describe("Return pipelines updated before the specified date"),
|
.string()
|
||||||
order_by: z.enum(['id', 'status', 'ref', 'updated_at', 'user_id']).optional().describe("Order pipelines by"),
|
.optional()
|
||||||
sort: z.enum(['asc', 'desc']).optional().describe("Sort pipelines"),
|
.describe("Return pipelines updated after the specified date"),
|
||||||
|
updated_before: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Return pipelines updated before the specified date"),
|
||||||
|
order_by: z
|
||||||
|
.enum(["id", "status", "ref", "updated_at", "user_id"])
|
||||||
|
.optional()
|
||||||
|
.describe("Order pipelines by"),
|
||||||
|
sort: z.enum(["asc", "desc"]).optional().describe("Sort pipelines"),
|
||||||
page: z.number().optional().describe("Page number for pagination"),
|
page: z.number().optional().describe("Page number for pagination"),
|
||||||
per_page: z.number().optional().describe("Number of items per page (max 100)"),
|
per_page: z.number().optional().describe("Number of items per page (max 100)"),
|
||||||
});
|
});
|
||||||
@ -108,7 +148,10 @@ export const GetPipelineSchema = z.object({
|
|||||||
export const ListPipelineJobsSchema = z.object({
|
export const ListPipelineJobsSchema = z.object({
|
||||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||||
pipeline_id: z.number().describe("The ID of the pipeline"),
|
pipeline_id: z.number().describe("The ID of the pipeline"),
|
||||||
scope: z.enum(['created', 'pending', 'running', 'failed', 'success', 'canceled', 'skipped', 'manual']).optional().describe("The scope of jobs to show"),
|
scope: z
|
||||||
|
.enum(["created", "pending", "running", "failed", "success", "canceled", "skipped", "manual"])
|
||||||
|
.optional()
|
||||||
|
.describe("The scope of jobs to show"),
|
||||||
include_retried: z.boolean().optional().describe("Whether to include retried jobs"),
|
include_retried: z.boolean().optional().describe("Whether to include retried jobs"),
|
||||||
page: z.number().optional().describe("Page number for pagination"),
|
page: z.number().optional().describe("Page number for pagination"),
|
||||||
per_page: z.number().optional().describe("Number of items per page (max 100)"),
|
per_page: z.number().optional().describe("Number of items per page (max 100)"),
|
||||||
@ -287,21 +330,10 @@ export const GetRepositoryTreeSchema = z.object({
|
|||||||
ref: z
|
ref: z
|
||||||
.string()
|
.string()
|
||||||
.optional()
|
.optional()
|
||||||
.describe(
|
.describe("The name of a repository branch or tag. Defaults to the default branch."),
|
||||||
"The name of a repository branch or tag. Defaults to the default branch."
|
recursive: z.boolean().optional().describe("Boolean value to get a recursive tree"),
|
||||||
),
|
per_page: z.number().optional().describe("Number of results to show per page"),
|
||||||
recursive: z
|
page_token: z.string().optional().describe("The tree record ID for pagination"),
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Boolean value to get a recursive tree"),
|
|
||||||
per_page: z
|
|
||||||
.number()
|
|
||||||
.optional()
|
|
||||||
.describe("Number of results to show per page"),
|
|
||||||
page_token: z
|
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("The tree record ID for pagination"),
|
|
||||||
pagination: z.string().optional().describe("Pagination method (keyset)"),
|
pagination: z.string().optional().describe("Pagination method (keyset)"),
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -333,6 +365,22 @@ export const GitLabReferenceSchema = z.object({
|
|||||||
}),
|
}),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Milestones rest api output schemas
|
||||||
|
export const GitLabMilestonesSchema = z.object({
|
||||||
|
id: z.number(),
|
||||||
|
iid: z.number(),
|
||||||
|
project_id: z.number(),
|
||||||
|
title: z.string(),
|
||||||
|
description: z.string().nullable(),
|
||||||
|
due_date: z.string().nullable(),
|
||||||
|
start_date: z.string().nullable(),
|
||||||
|
state: z.string(),
|
||||||
|
updated_at: z.string(),
|
||||||
|
created_at: z.string(),
|
||||||
|
expired: z.boolean(),
|
||||||
|
web_url: z.string().optional(),
|
||||||
|
});
|
||||||
|
|
||||||
// Input schemas for operations
|
// Input schemas for operations
|
||||||
export const CreateRepositoryOptionsSchema = z.object({
|
export const CreateRepositoryOptionsSchema = z.object({
|
||||||
name: z.string(),
|
name: z.string(),
|
||||||
@ -399,7 +447,7 @@ export const GitLabUserSchema = z.object({
|
|||||||
username: z.string(), // Changed from login to match GitLab API
|
username: z.string(), // Changed from login to match GitLab API
|
||||||
id: z.number(),
|
id: z.number(),
|
||||||
name: z.string(),
|
name: z.string(),
|
||||||
avatar_url: z.string(),
|
avatar_url: z.string().nullable(),
|
||||||
web_url: z.string(), // Changed from html_url to match GitLab API
|
web_url: z.string(), // Changed from html_url to match GitLab API
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -590,10 +638,12 @@ export const UpdateMergeRequestNoteSchema = ProjectParamsSchema.extend({
|
|||||||
note_id: z.number().describe("The ID of a thread note"),
|
note_id: z.number().describe("The ID of a thread note"),
|
||||||
body: z.string().optional().describe("The content of the note or reply"),
|
body: z.string().optional().describe("The content of the note or reply"),
|
||||||
resolved: z.boolean().optional().describe("Resolve or unresolve the note"),
|
resolved: z.boolean().optional().describe("Resolve or unresolve the note"),
|
||||||
}).refine(data => data.body !== undefined || data.resolved !== undefined, {
|
})
|
||||||
message: "At least one of 'body' or 'resolved' must be provided"
|
.refine(data => data.body !== undefined || data.resolved !== undefined, {
|
||||||
}).refine(data => !(data.body !== undefined && data.resolved !== undefined), {
|
message: "At least one of 'body' or 'resolved' must be provided",
|
||||||
message: "Only one of 'body' or 'resolved' can be provided, not both"
|
})
|
||||||
|
.refine(data => !(data.body !== undefined && data.resolved !== undefined), {
|
||||||
|
message: "Only one of 'body' or 'resolved' can be provided, not both",
|
||||||
});
|
});
|
||||||
|
|
||||||
// Input schema for adding a note to an existing merge request discussion
|
// Input schema for adding a note to an existing merge request discussion
|
||||||
@ -627,27 +677,15 @@ export const CreateOrUpdateFileSchema = ProjectParamsSchema.extend({
|
|||||||
content: z.string().describe("Content of the file"),
|
content: z.string().describe("Content of the file"),
|
||||||
commit_message: z.string().describe("Commit message"),
|
commit_message: z.string().describe("Commit message"),
|
||||||
branch: z.string().describe("Branch to create/update the file in"),
|
branch: z.string().describe("Branch to create/update the file in"),
|
||||||
previous_path: z
|
previous_path: z.string().optional().describe("Path of the file to move/rename"),
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("Path of the file to move/rename"),
|
|
||||||
last_commit_id: z.string().optional().describe("Last known file commit ID"),
|
last_commit_id: z.string().optional().describe("Last known file commit ID"),
|
||||||
commit_id: z
|
commit_id: z.string().optional().describe("Current file commit ID (for update operations)"),
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("Current file commit ID (for update operations)"),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
export const SearchRepositoriesSchema = z.object({
|
export const SearchRepositoriesSchema = z.object({
|
||||||
search: z.string().describe("Search query"), // Changed from query to match GitLab API
|
search: z.string().describe("Search query"), // Changed from query to match GitLab API
|
||||||
page: z
|
page: z.number().optional().describe("Page number for pagination (default: 1)"),
|
||||||
.number()
|
per_page: z.number().optional().describe("Number of results per page (default: 20)"),
|
||||||
.optional()
|
|
||||||
.describe("Page number for pagination (default: 1)"),
|
|
||||||
per_page: z
|
|
||||||
.number()
|
|
||||||
.optional()
|
|
||||||
.describe("Number of results per page (default: 20)"),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
export const CreateRepositorySchema = z.object({
|
export const CreateRepositorySchema = z.object({
|
||||||
@ -657,10 +695,7 @@ export const CreateRepositorySchema = z.object({
|
|||||||
.enum(["private", "internal", "public"])
|
.enum(["private", "internal", "public"])
|
||||||
.optional()
|
.optional()
|
||||||
.describe("Repository visibility level"),
|
.describe("Repository visibility level"),
|
||||||
initialize_with_readme: z
|
initialize_with_readme: z.boolean().optional().describe("Initialize with README.md"),
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Initialize with README.md"),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
export const GetFileContentsSchema = ProjectParamsSchema.extend({
|
export const GetFileContentsSchema = ProjectParamsSchema.extend({
|
||||||
@ -684,10 +719,7 @@ export const PushFilesSchema = ProjectParamsSchema.extend({
|
|||||||
export const CreateIssueSchema = ProjectParamsSchema.extend({
|
export const CreateIssueSchema = ProjectParamsSchema.extend({
|
||||||
title: z.string().describe("Issue title"),
|
title: z.string().describe("Issue title"),
|
||||||
description: z.string().optional().describe("Issue description"),
|
description: z.string().optional().describe("Issue description"),
|
||||||
assignee_ids: z
|
assignee_ids: z.array(z.number()).optional().describe("Array of user IDs to assign"),
|
||||||
.array(z.number())
|
|
||||||
.optional()
|
|
||||||
.describe("Array of user IDs to assign"),
|
|
||||||
labels: z.array(z.string()).optional().describe("Array of label names"),
|
labels: z.array(z.string()).optional().describe("Array of label names"),
|
||||||
milestone_id: z.number().optional().describe("Milestone ID to assign"),
|
milestone_id: z.number().optional().describe("Milestone ID to assign"),
|
||||||
});
|
});
|
||||||
@ -698,10 +730,7 @@ export const CreateMergeRequestSchema = ProjectParamsSchema.extend({
|
|||||||
source_branch: z.string().describe("Branch containing changes"),
|
source_branch: z.string().describe("Branch containing changes"),
|
||||||
target_branch: z.string().describe("Branch to merge into"),
|
target_branch: z.string().describe("Branch to merge into"),
|
||||||
draft: z.boolean().optional().describe("Create as draft merge request"),
|
draft: z.boolean().optional().describe("Create as draft merge request"),
|
||||||
allow_collaboration: z
|
allow_collaboration: z.boolean().optional().describe("Allow commits from upstream members"),
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Allow commits from upstream members"),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
export const ForkRepositorySchema = ProjectParamsSchema.extend({
|
export const ForkRepositorySchema = ProjectParamsSchema.extend({
|
||||||
@ -725,24 +754,15 @@ export const GitLabMergeRequestDiffSchema = z.object({
|
|||||||
});
|
});
|
||||||
|
|
||||||
export const GetMergeRequestSchema = ProjectParamsSchema.extend({
|
export const GetMergeRequestSchema = ProjectParamsSchema.extend({
|
||||||
merge_request_iid: z
|
merge_request_iid: z.number().optional().describe("The IID of a merge request"),
|
||||||
.number()
|
|
||||||
.optional()
|
|
||||||
.describe("The IID of a merge request"),
|
|
||||||
source_branch: z.string().optional().describe("Source branch name"),
|
source_branch: z.string().optional().describe("Source branch name"),
|
||||||
});
|
});
|
||||||
|
|
||||||
export const UpdateMergeRequestSchema = GetMergeRequestSchema.extend({
|
export const UpdateMergeRequestSchema = GetMergeRequestSchema.extend({
|
||||||
title: z.string().optional().describe("The title of the merge request"),
|
title: z.string().optional().describe("The title of the merge request"),
|
||||||
description: z
|
description: z.string().optional().describe("The description of the merge request"),
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("The description of the merge request"),
|
|
||||||
target_branch: z.string().optional().describe("The target branch"),
|
target_branch: z.string().optional().describe("The target branch"),
|
||||||
assignee_ids: z
|
assignee_ids: z.array(z.number()).optional().describe("The ID of the users to assign the MR to"),
|
||||||
.array(z.number())
|
|
||||||
.optional()
|
|
||||||
.describe("The ID of the users to assign the MR to"),
|
|
||||||
labels: z.array(z.string()).optional().describe("Labels for the MR"),
|
labels: z.array(z.string()).optional().describe("Labels for the MR"),
|
||||||
state_event: z
|
state_event: z
|
||||||
.enum(["close", "reopen"])
|
.enum(["close", "reopen"])
|
||||||
@ -752,10 +772,7 @@ export const UpdateMergeRequestSchema = GetMergeRequestSchema.extend({
|
|||||||
.boolean()
|
.boolean()
|
||||||
.optional()
|
.optional()
|
||||||
.describe("Flag indicating if the source branch should be removed"),
|
.describe("Flag indicating if the source branch should be removed"),
|
||||||
squash: z
|
squash: z.boolean().optional().describe("Squash commits into a single commit when merging"),
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Squash commits into a single commit when merging"),
|
|
||||||
draft: z.boolean().optional().describe("Work in progress merge request"),
|
draft: z.boolean().optional().describe("Work in progress merge request"),
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -775,38 +792,14 @@ export const CreateNoteSchema = z.object({
|
|||||||
// Issues API operation schemas
|
// Issues API operation schemas
|
||||||
export const ListIssuesSchema = z.object({
|
export const ListIssuesSchema = z.object({
|
||||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||||
assignee_id: z
|
assignee_id: z.number().optional().describe("Return issues assigned to the given user ID"),
|
||||||
.number()
|
assignee_username: z.string().optional().describe("Return issues assigned to the given username"),
|
||||||
.optional()
|
author_id: z.number().optional().describe("Return issues created by the given user ID"),
|
||||||
.describe("Return issues assigned to the given user ID"),
|
author_username: z.string().optional().describe("Return issues created by the given username"),
|
||||||
assignee_username: z
|
confidential: z.boolean().optional().describe("Filter confidential or public issues"),
|
||||||
.string()
|
created_after: z.string().optional().describe("Return issues created after the given time"),
|
||||||
.optional()
|
created_before: z.string().optional().describe("Return issues created before the given time"),
|
||||||
.describe("Return issues assigned to the given username"),
|
due_date: z.string().optional().describe("Return issues that have the due date"),
|
||||||
author_id: z
|
|
||||||
.number()
|
|
||||||
.optional()
|
|
||||||
.describe("Return issues created by the given user ID"),
|
|
||||||
author_username: z
|
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("Return issues created by the given username"),
|
|
||||||
confidential: z
|
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Filter confidential or public issues"),
|
|
||||||
created_after: z
|
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("Return issues created after the given time"),
|
|
||||||
created_before: z
|
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("Return issues created before the given time"),
|
|
||||||
due_date: z
|
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("Return issues that have the due date"),
|
|
||||||
label_name: z.array(z.string()).optional().describe("Array of label names"),
|
label_name: z.array(z.string()).optional().describe("Array of label names"),
|
||||||
milestone: z.string().optional().describe("Milestone title"),
|
milestone: z.string().optional().describe("Milestone title"),
|
||||||
scope: z
|
scope: z
|
||||||
@ -818,18 +811,82 @@ export const ListIssuesSchema = z.object({
|
|||||||
.enum(["opened", "closed", "all"])
|
.enum(["opened", "closed", "all"])
|
||||||
.optional()
|
.optional()
|
||||||
.describe("Return issues with a specific state"),
|
.describe("Return issues with a specific state"),
|
||||||
|
updated_after: z.string().optional().describe("Return issues updated after the given time"),
|
||||||
|
updated_before: z.string().optional().describe("Return issues updated before the given time"),
|
||||||
|
with_labels_details: z.boolean().optional().describe("Return more details for each label"),
|
||||||
|
page: z.number().optional().describe("Page number for pagination"),
|
||||||
|
per_page: z.number().optional().describe("Number of items per page"),
|
||||||
|
});
|
||||||
|
|
||||||
|
// Merge Requests API operation schemas
|
||||||
|
export const ListMergeRequestsSchema = z.object({
|
||||||
|
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||||
|
assignee_id: z
|
||||||
|
.number()
|
||||||
|
.optional()
|
||||||
|
.describe("Returns merge requests assigned to the given user ID"),
|
||||||
|
assignee_username: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Returns merge requests assigned to the given username"),
|
||||||
|
author_id: z.number().optional().describe("Returns merge requests created by the given user ID"),
|
||||||
|
author_username: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Returns merge requests created by the given username"),
|
||||||
|
reviewer_id: z
|
||||||
|
.number()
|
||||||
|
.optional()
|
||||||
|
.describe("Returns merge requests which have the user as a reviewer"),
|
||||||
|
reviewer_username: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Returns merge requests which have the user as a reviewer"),
|
||||||
|
created_after: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Return merge requests created after the given time"),
|
||||||
|
created_before: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Return merge requests created before the given time"),
|
||||||
updated_after: z
|
updated_after: z
|
||||||
.string()
|
.string()
|
||||||
.optional()
|
.optional()
|
||||||
.describe("Return issues updated after the given time"),
|
.describe("Return merge requests updated after the given time"),
|
||||||
updated_before: z
|
updated_before: z
|
||||||
.string()
|
.string()
|
||||||
.optional()
|
.optional()
|
||||||
.describe("Return issues updated before the given time"),
|
.describe("Return merge requests updated before the given time"),
|
||||||
with_labels_details: z
|
labels: z.array(z.string()).optional().describe("Array of label names"),
|
||||||
.boolean()
|
milestone: z.string().optional().describe("Milestone title"),
|
||||||
|
scope: z
|
||||||
|
.enum(["created_by_me", "assigned_to_me", "all"])
|
||||||
.optional()
|
.optional()
|
||||||
.describe("Return more details for each label"),
|
.describe("Return merge requests from a specific scope"),
|
||||||
|
search: z.string().optional().describe("Search for specific terms"),
|
||||||
|
state: z
|
||||||
|
.enum(["opened", "closed", "locked", "merged", "all"])
|
||||||
|
.optional()
|
||||||
|
.describe("Return merge requests with a specific state"),
|
||||||
|
order_by: z
|
||||||
|
.enum(["created_at", "updated_at", "priority", "label_priority", "milestone_due", "popularity"])
|
||||||
|
.optional()
|
||||||
|
.describe("Return merge requests ordered by the given field"),
|
||||||
|
sort: z
|
||||||
|
.enum(["asc", "desc"])
|
||||||
|
.optional()
|
||||||
|
.describe("Return merge requests sorted in ascending or descending order"),
|
||||||
|
target_branch: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Return merge requests targeting a specific branch"),
|
||||||
|
source_branch: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Return merge requests from a specific source branch"),
|
||||||
|
wip: z.enum(["yes", "no"]).optional().describe("Filter merge requests against their wip status"),
|
||||||
|
with_labels_details: z.boolean().optional().describe("Return more details for each label"),
|
||||||
page: z.number().optional().describe("Page number for pagination"),
|
page: z.number().optional().describe("Page number for pagination"),
|
||||||
per_page: z.number().optional().describe("Number of items per page"),
|
per_page: z.number().optional().describe("Number of items per page"),
|
||||||
});
|
});
|
||||||
@ -844,28 +901,13 @@ export const UpdateIssueSchema = z.object({
|
|||||||
issue_iid: z.number().describe("The internal ID of the project issue"),
|
issue_iid: z.number().describe("The internal ID of the project issue"),
|
||||||
title: z.string().optional().describe("The title of the issue"),
|
title: z.string().optional().describe("The title of the issue"),
|
||||||
description: z.string().optional().describe("The description of the issue"),
|
description: z.string().optional().describe("The description of the issue"),
|
||||||
assignee_ids: z
|
assignee_ids: z.array(z.number()).optional().describe("Array of user IDs to assign issue to"),
|
||||||
.array(z.number())
|
confidential: z.boolean().optional().describe("Set the issue to be confidential"),
|
||||||
.optional()
|
discussion_locked: z.boolean().optional().describe("Flag to lock discussions"),
|
||||||
.describe("Array of user IDs to assign issue to"),
|
due_date: z.string().optional().describe("Date the issue is due (YYYY-MM-DD)"),
|
||||||
confidential: z
|
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Set the issue to be confidential"),
|
|
||||||
discussion_locked: z
|
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Flag to lock discussions"),
|
|
||||||
due_date: z
|
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("Date the issue is due (YYYY-MM-DD)"),
|
|
||||||
labels: z.array(z.string()).optional().describe("Array of label names"),
|
labels: z.array(z.string()).optional().describe("Array of label names"),
|
||||||
milestone_id: z.number().optional().describe("Milestone ID to assign"),
|
milestone_id: z.number().optional().describe("Milestone ID to assign"),
|
||||||
state_event: z
|
state_event: z.enum(["close", "reopen"]).optional().describe("Update issue state (close/reopen)"),
|
||||||
.enum(["close", "reopen"])
|
|
||||||
.optional()
|
|
||||||
.describe("Update issue state (close/reopen)"),
|
|
||||||
weight: z.number().optional().describe("Weight of the issue (0-9)"),
|
weight: z.number().optional().describe("Weight of the issue (0-9)"),
|
||||||
});
|
});
|
||||||
|
|
||||||
@ -891,8 +933,14 @@ export const ListIssueDiscussionsSchema = z.object({
|
|||||||
issue_iid: z.number().describe("The internal ID of the project issue"),
|
issue_iid: z.number().describe("The internal ID of the project issue"),
|
||||||
page: z.number().optional().describe("Page number for pagination"),
|
page: z.number().optional().describe("Page number for pagination"),
|
||||||
per_page: z.number().optional().describe("Number of items per page"),
|
per_page: z.number().optional().describe("Number of items per page"),
|
||||||
sort: z.enum(["asc", "desc"]).optional().describe("Return issue discussions sorted in ascending or descending order"),
|
sort: z
|
||||||
order_by: z.enum(["created_at", "updated_at"]).optional().describe("Return issue discussions ordered by created_at or updated_at fields"),
|
.enum(["asc", "desc"])
|
||||||
|
.optional()
|
||||||
|
.describe("Return issue discussions sorted in ascending or descending order"),
|
||||||
|
order_by: z
|
||||||
|
.enum(["created_at", "updated_at"])
|
||||||
|
.optional()
|
||||||
|
.describe("Return issue discussions ordered by created_at or updated_at fields"),
|
||||||
});
|
});
|
||||||
|
|
||||||
export const GetIssueLinkSchema = z.object({
|
export const GetIssueLinkSchema = z.object({
|
||||||
@ -904,12 +952,8 @@ export const GetIssueLinkSchema = z.object({
|
|||||||
export const CreateIssueLinkSchema = z.object({
|
export const CreateIssueLinkSchema = z.object({
|
||||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||||
issue_iid: z.number().describe("The internal ID of a project's issue"),
|
issue_iid: z.number().describe("The internal ID of a project's issue"),
|
||||||
target_project_id: z
|
target_project_id: z.string().describe("The ID or URL-encoded path of a target project"),
|
||||||
.string()
|
target_issue_iid: z.number().describe("The internal ID of a target project's issue"),
|
||||||
.describe("The ID or URL-encoded path of a target project"),
|
|
||||||
target_issue_iid: z
|
|
||||||
.number()
|
|
||||||
.describe("The internal ID of a target project's issue"),
|
|
||||||
link_type: z
|
link_type: z
|
||||||
.enum(["relates_to", "blocks", "is_blocked_by"])
|
.enum(["relates_to", "blocks", "is_blocked_by"])
|
||||||
.optional()
|
.optional()
|
||||||
@ -927,10 +971,7 @@ export const ListNamespacesSchema = z.object({
|
|||||||
search: z.string().optional().describe("Search term for namespaces"),
|
search: z.string().optional().describe("Search term for namespaces"),
|
||||||
page: z.number().optional().describe("Page number for pagination"),
|
page: z.number().optional().describe("Page number for pagination"),
|
||||||
per_page: z.number().optional().describe("Number of items per page"),
|
per_page: z.number().optional().describe("Number of items per page"),
|
||||||
owned: z
|
owned: z.boolean().optional().describe("Filter for namespaces owned by current user"),
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Filter for namespaces owned by current user"),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
export const GetNamespaceSchema = z.object({
|
export const GetNamespaceSchema = z.object({
|
||||||
@ -950,18 +991,9 @@ export const ListProjectsSchema = z.object({
|
|||||||
search: z.string().optional().describe("Search term for projects"),
|
search: z.string().optional().describe("Search term for projects"),
|
||||||
page: z.number().optional().describe("Page number for pagination"),
|
page: z.number().optional().describe("Page number for pagination"),
|
||||||
per_page: z.number().optional().describe("Number of items per page"),
|
per_page: z.number().optional().describe("Number of items per page"),
|
||||||
search_namespaces: z
|
search_namespaces: z.boolean().optional().describe("Needs to be true if search is full path"),
|
||||||
.boolean()
|
owned: z.boolean().optional().describe("Filter for projects owned by current user"),
|
||||||
.optional()
|
membership: z.boolean().optional().describe("Filter for projects where current user is a member"),
|
||||||
.describe("Needs to be true if search is full path"),
|
|
||||||
owned: z
|
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Filter for projects owned by current user"),
|
|
||||||
membership: z
|
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Filter for projects where current user is a member"),
|
|
||||||
simple: z.boolean().optional().describe("Return only limited fields"),
|
simple: z.boolean().optional().describe("Return only limited fields"),
|
||||||
archived: z.boolean().optional().describe("Filter for archived projects"),
|
archived: z.boolean().optional().describe("Filter for archived projects"),
|
||||||
visibility: z
|
visibility: z
|
||||||
@ -969,14 +1001,7 @@ export const ListProjectsSchema = z.object({
|
|||||||
.optional()
|
.optional()
|
||||||
.describe("Filter by project visibility"),
|
.describe("Filter by project visibility"),
|
||||||
order_by: z
|
order_by: z
|
||||||
.enum([
|
.enum(["id", "name", "path", "created_at", "updated_at", "last_activity_at"])
|
||||||
"id",
|
|
||||||
"name",
|
|
||||||
"path",
|
|
||||||
"created_at",
|
|
||||||
"updated_at",
|
|
||||||
"last_activity_at",
|
|
||||||
])
|
|
||||||
.optional()
|
.optional()
|
||||||
.describe("Return projects ordered by field"),
|
.describe("Return projects ordered by field"),
|
||||||
sort: z
|
sort: z
|
||||||
@ -991,10 +1016,7 @@ export const ListProjectsSchema = z.object({
|
|||||||
.boolean()
|
.boolean()
|
||||||
.optional()
|
.optional()
|
||||||
.describe("Filter projects with merge requests feature enabled"),
|
.describe("Filter projects with merge requests feature enabled"),
|
||||||
min_access_level: z
|
min_access_level: z.number().optional().describe("Filter by minimum access level"),
|
||||||
.number()
|
|
||||||
.optional()
|
|
||||||
.describe("Filter by minimum access level"),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
// Label operation schemas
|
// Label operation schemas
|
||||||
@ -1004,20 +1026,14 @@ export const ListLabelsSchema = z.object({
|
|||||||
.boolean()
|
.boolean()
|
||||||
.optional()
|
.optional()
|
||||||
.describe("Whether or not to include issue and merge request counts"),
|
.describe("Whether or not to include issue and merge request counts"),
|
||||||
include_ancestor_groups: z
|
include_ancestor_groups: z.boolean().optional().describe("Include ancestor groups"),
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Include ancestor groups"),
|
|
||||||
search: z.string().optional().describe("Keyword to filter labels by"),
|
search: z.string().optional().describe("Keyword to filter labels by"),
|
||||||
});
|
});
|
||||||
|
|
||||||
export const GetLabelSchema = z.object({
|
export const GetLabelSchema = z.object({
|
||||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||||
label_id: z.string().describe("The ID or title of a project's label"),
|
label_id: z.string().describe("The ID or title of a project's label"),
|
||||||
include_ancestor_groups: z
|
include_ancestor_groups: z.boolean().optional().describe("Include ancestor groups"),
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Include ancestor groups"),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
export const CreateLabelSchema = z.object({
|
export const CreateLabelSchema = z.object({
|
||||||
@ -1025,15 +1041,9 @@ export const CreateLabelSchema = z.object({
|
|||||||
name: z.string().describe("The name of the label"),
|
name: z.string().describe("The name of the label"),
|
||||||
color: z
|
color: z
|
||||||
.string()
|
.string()
|
||||||
.describe(
|
.describe("The color of the label given in 6-digit hex notation with leading '#' sign"),
|
||||||
"The color of the label given in 6-digit hex notation with leading '#' sign"
|
|
||||||
),
|
|
||||||
description: z.string().optional().describe("The description of the label"),
|
description: z.string().optional().describe("The description of the label"),
|
||||||
priority: z
|
priority: z.number().nullable().optional().describe("The priority of the label"),
|
||||||
.number()
|
|
||||||
.nullable()
|
|
||||||
.optional()
|
|
||||||
.describe("The priority of the label"),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
export const UpdateLabelSchema = z.object({
|
export const UpdateLabelSchema = z.object({
|
||||||
@ -1043,18 +1053,9 @@ export const UpdateLabelSchema = z.object({
|
|||||||
color: z
|
color: z
|
||||||
.string()
|
.string()
|
||||||
.optional()
|
.optional()
|
||||||
.describe(
|
.describe("The color of the label given in 6-digit hex notation with leading '#' sign"),
|
||||||
"The color of the label given in 6-digit hex notation with leading '#' sign"
|
description: z.string().optional().describe("The new description of the label"),
|
||||||
),
|
priority: z.number().nullable().optional().describe("The new priority of the label"),
|
||||||
description: z
|
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("The new description of the label"),
|
|
||||||
priority: z
|
|
||||||
.number()
|
|
||||||
.nullable()
|
|
||||||
.optional()
|
|
||||||
.describe("The new priority of the label"),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
export const DeleteLabelSchema = z.object({
|
export const DeleteLabelSchema = z.object({
|
||||||
@ -1065,10 +1066,7 @@ export const DeleteLabelSchema = z.object({
|
|||||||
// Group projects schema
|
// Group projects schema
|
||||||
export const ListGroupProjectsSchema = z.object({
|
export const ListGroupProjectsSchema = z.object({
|
||||||
group_id: z.string().describe("Group ID or path"),
|
group_id: z.string().describe("Group ID or path"),
|
||||||
include_subgroups: z
|
include_subgroups: z.boolean().optional().describe("Include projects from subgroups"),
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Include projects from subgroups"),
|
|
||||||
search: z.string().optional().describe("Search term to filter projects"),
|
search: z.string().optional().describe("Search term to filter projects"),
|
||||||
order_by: z
|
order_by: z
|
||||||
.enum(["name", "path", "created_at", "updated_at", "last_activity_at"])
|
.enum(["name", "path", "created_at", "updated_at", "last_activity_at"])
|
||||||
@ -1090,24 +1088,12 @@ export const ListGroupProjectsSchema = z.object({
|
|||||||
.boolean()
|
.boolean()
|
||||||
.optional()
|
.optional()
|
||||||
.describe("Filter projects with merge requests feature enabled"),
|
.describe("Filter projects with merge requests feature enabled"),
|
||||||
min_access_level: z
|
min_access_level: z.number().optional().describe("Filter by minimum access level"),
|
||||||
.number()
|
with_programming_language: z.string().optional().describe("Filter by programming language"),
|
||||||
.optional()
|
|
||||||
.describe("Filter by minimum access level"),
|
|
||||||
with_programming_language: z
|
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("Filter by programming language"),
|
|
||||||
starred: z.boolean().optional().describe("Filter by starred projects"),
|
starred: z.boolean().optional().describe("Filter by starred projects"),
|
||||||
statistics: z.boolean().optional().describe("Include project statistics"),
|
statistics: z.boolean().optional().describe("Include project statistics"),
|
||||||
with_custom_attributes: z
|
with_custom_attributes: z.boolean().optional().describe("Include custom attributes"),
|
||||||
.boolean()
|
with_security_reports: z.boolean().optional().describe("Include security reports"),
|
||||||
.optional()
|
|
||||||
.describe("Include custom attributes"),
|
|
||||||
with_security_reports: z
|
|
||||||
.boolean()
|
|
||||||
.optional()
|
|
||||||
.describe("Include security reports"),
|
|
||||||
});
|
});
|
||||||
|
|
||||||
// Add wiki operation schemas
|
// Add wiki operation schemas
|
||||||
@ -1124,20 +1110,14 @@ export const CreateWikiPageSchema = z.object({
|
|||||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||||
title: z.string().describe("Title of the wiki page"),
|
title: z.string().describe("Title of the wiki page"),
|
||||||
content: z.string().describe("Content of the wiki page"),
|
content: z.string().describe("Content of the wiki page"),
|
||||||
format: z
|
format: z.string().optional().describe("Content format, e.g., markdown, rdoc"),
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("Content format, e.g., markdown, rdoc"),
|
|
||||||
});
|
});
|
||||||
export const UpdateWikiPageSchema = z.object({
|
export const UpdateWikiPageSchema = z.object({
|
||||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||||
slug: z.string().describe("URL-encoded slug of the wiki page"),
|
slug: z.string().describe("URL-encoded slug of the wiki page"),
|
||||||
title: z.string().optional().describe("New title of the wiki page"),
|
title: z.string().optional().describe("New title of the wiki page"),
|
||||||
content: z.string().optional().describe("New content of the wiki page"),
|
content: z.string().optional().describe("New content of the wiki page"),
|
||||||
format: z
|
format: z.string().optional().describe("Content format, e.g., markdown, rdoc"),
|
||||||
.string()
|
|
||||||
.optional()
|
|
||||||
.describe("Content format, e.g., markdown, rdoc"),
|
|
||||||
});
|
});
|
||||||
export const DeleteWikiPageSchema = z.object({
|
export const DeleteWikiPageSchema = z.object({
|
||||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||||
@ -1174,52 +1154,115 @@ export const MergeRequestThreadPositionSchema = z.object({
|
|||||||
export const CreateMergeRequestThreadSchema = ProjectParamsSchema.extend({
|
export const CreateMergeRequestThreadSchema = ProjectParamsSchema.extend({
|
||||||
merge_request_iid: z.number().describe("The IID of a merge request"),
|
merge_request_iid: z.number().describe("The IID of a merge request"),
|
||||||
body: z.string().describe("The content of the thread"),
|
body: z.string().describe("The content of the thread"),
|
||||||
position: MergeRequestThreadPositionSchema.optional().describe("Position when creating a diff note"),
|
position: MergeRequestThreadPositionSchema.optional().describe(
|
||||||
|
"Position when creating a diff note"
|
||||||
|
),
|
||||||
created_at: z.string().optional().describe("Date the thread was created at (ISO 8601 format)"),
|
created_at: z.string().optional().describe("Date the thread was created at (ISO 8601 format)"),
|
||||||
});
|
});
|
||||||
|
|
||||||
|
// Milestone related schemas
|
||||||
|
// Schema for listing project milestones
|
||||||
|
export const ListProjectMilestonesSchema = ProjectParamsSchema.extend({
|
||||||
|
iids: z.array(z.number()).optional().describe("Return only the milestones having the given iid"),
|
||||||
|
state: z
|
||||||
|
.enum(["active", "closed"])
|
||||||
|
.optional()
|
||||||
|
.describe("Return only active or closed milestones"),
|
||||||
|
title: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Return only milestones with a title matching the provided string"),
|
||||||
|
search: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Return only milestones with a title or description matching the provided string"),
|
||||||
|
include_ancestors: z.boolean().optional().describe("Include ancestor groups"),
|
||||||
|
updated_before: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Return milestones updated before the specified date (ISO 8601 format)"),
|
||||||
|
updated_after: z
|
||||||
|
.string()
|
||||||
|
.optional()
|
||||||
|
.describe("Return milestones updated after the specified date (ISO 8601 format)"),
|
||||||
|
page: z.number().optional().describe("Page number for pagination"),
|
||||||
|
per_page: z.number().optional().describe("Number of items per page (max 100)"),
|
||||||
|
});
|
||||||
|
|
||||||
|
// Schema for getting a single milestone
|
||||||
|
export const GetProjectMilestoneSchema = ProjectParamsSchema.extend({
|
||||||
|
milestone_id: z.number().describe("The ID of a project milestone"),
|
||||||
|
});
|
||||||
|
|
||||||
|
// Schema for creating a new milestone
|
||||||
|
export const CreateProjectMilestoneSchema = ProjectParamsSchema.extend({
|
||||||
|
title: z.string().describe("The title of the milestone"),
|
||||||
|
description: z.string().optional().describe("The description of the milestone"),
|
||||||
|
due_date: z.string().optional().describe("The due date of the milestone (YYYY-MM-DD)"),
|
||||||
|
start_date: z.string().optional().describe("The start date of the milestone (YYYY-MM-DD)"),
|
||||||
|
});
|
||||||
|
|
||||||
|
// Schema for editing a milestone
|
||||||
|
export const EditProjectMilestoneSchema = GetProjectMilestoneSchema.extend({
|
||||||
|
title: z.string().optional().describe("The title of the milestone"),
|
||||||
|
description: z.string().optional().describe("The description of the milestone"),
|
||||||
|
due_date: z.string().optional().describe("The due date of the milestone (YYYY-MM-DD)"),
|
||||||
|
start_date: z.string().optional().describe("The start date of the milestone (YYYY-MM-DD)"),
|
||||||
|
state_event: z
|
||||||
|
.enum(["close", "activate"])
|
||||||
|
.optional()
|
||||||
|
.describe("The state event of the milestone"),
|
||||||
|
});
|
||||||
|
|
||||||
|
// Schema for deleting a milestone
|
||||||
|
export const DeleteProjectMilestoneSchema = GetProjectMilestoneSchema;
|
||||||
|
|
||||||
|
// Schema for getting issues assigned to a milestone
|
||||||
|
export const GetMilestoneIssuesSchema = GetProjectMilestoneSchema;
|
||||||
|
|
||||||
|
// Schema for getting merge requests assigned to a milestone
|
||||||
|
export const GetMilestoneMergeRequestsSchema = GetProjectMilestoneSchema.extend({
|
||||||
|
page: z.number().optional().describe("Page number for pagination"),
|
||||||
|
per_page: z.number().optional().describe("Number of items per page (max 100)"),
|
||||||
|
});
|
||||||
|
|
||||||
|
// Schema for promoting a project milestone to a group milestone
|
||||||
|
export const PromoteProjectMilestoneSchema = GetProjectMilestoneSchema;
|
||||||
|
|
||||||
|
// Schema for getting burndown chart events for a milestone
|
||||||
|
export const GetMilestoneBurndownEventsSchema = GetProjectMilestoneSchema.extend({
|
||||||
|
page: z.number().optional().describe("Page number for pagination"),
|
||||||
|
per_page: z.number().optional().describe("Number of items per page (max 100)"),
|
||||||
|
});
|
||||||
|
|
||||||
// Export types
|
// Export types
|
||||||
export type GitLabAuthor = z.infer<typeof GitLabAuthorSchema>;
|
export type GitLabAuthor = z.infer<typeof GitLabAuthorSchema>;
|
||||||
export type GitLabFork = z.infer<typeof GitLabForkSchema>;
|
export type GitLabFork = z.infer<typeof GitLabForkSchema>;
|
||||||
export type GitLabIssue = z.infer<typeof GitLabIssueSchema>;
|
export type GitLabIssue = z.infer<typeof GitLabIssueSchema>;
|
||||||
export type GitLabIssueWithLinkDetails = z.infer<
|
export type GitLabIssueWithLinkDetails = z.infer<typeof GitLabIssueWithLinkDetailsSchema>;
|
||||||
typeof GitLabIssueWithLinkDetailsSchema
|
|
||||||
>;
|
|
||||||
export type GitLabMergeRequest = z.infer<typeof GitLabMergeRequestSchema>;
|
export type GitLabMergeRequest = z.infer<typeof GitLabMergeRequestSchema>;
|
||||||
export type GitLabRepository = z.infer<typeof GitLabRepositorySchema>;
|
export type GitLabRepository = z.infer<typeof GitLabRepositorySchema>;
|
||||||
export type GitLabFileContent = z.infer<typeof GitLabFileContentSchema>;
|
export type GitLabFileContent = z.infer<typeof GitLabFileContentSchema>;
|
||||||
export type GitLabDirectoryContent = z.infer<
|
export type GitLabDirectoryContent = z.infer<typeof GitLabDirectoryContentSchema>;
|
||||||
typeof GitLabDirectoryContentSchema
|
|
||||||
>;
|
|
||||||
export type GitLabContent = z.infer<typeof GitLabContentSchema>;
|
export type GitLabContent = z.infer<typeof GitLabContentSchema>;
|
||||||
export type FileOperation = z.infer<typeof FileOperationSchema>;
|
export type FileOperation = z.infer<typeof FileOperationSchema>;
|
||||||
export type GitLabTree = z.infer<typeof GitLabTreeSchema>;
|
export type GitLabTree = z.infer<typeof GitLabTreeSchema>;
|
||||||
export type GitLabCommit = z.infer<typeof GitLabCommitSchema>;
|
export type GitLabCommit = z.infer<typeof GitLabCommitSchema>;
|
||||||
export type GitLabReference = z.infer<typeof GitLabReferenceSchema>;
|
export type GitLabReference = z.infer<typeof GitLabReferenceSchema>;
|
||||||
export type CreateRepositoryOptions = z.infer<
|
export type CreateRepositoryOptions = z.infer<typeof CreateRepositoryOptionsSchema>;
|
||||||
typeof CreateRepositoryOptionsSchema
|
|
||||||
>;
|
|
||||||
export type CreateIssueOptions = z.infer<typeof CreateIssueOptionsSchema>;
|
export type CreateIssueOptions = z.infer<typeof CreateIssueOptionsSchema>;
|
||||||
export type CreateMergeRequestOptions = z.infer<
|
export type CreateMergeRequestOptions = z.infer<typeof CreateMergeRequestOptionsSchema>;
|
||||||
typeof CreateMergeRequestOptionsSchema
|
|
||||||
>;
|
|
||||||
export type CreateBranchOptions = z.infer<typeof CreateBranchOptionsSchema>;
|
export type CreateBranchOptions = z.infer<typeof CreateBranchOptionsSchema>;
|
||||||
export type GitLabCreateUpdateFileResponse = z.infer<
|
export type GitLabCreateUpdateFileResponse = z.infer<typeof GitLabCreateUpdateFileResponseSchema>;
|
||||||
typeof GitLabCreateUpdateFileResponseSchema
|
|
||||||
>;
|
|
||||||
export type GitLabSearchResponse = z.infer<typeof GitLabSearchResponseSchema>;
|
export type GitLabSearchResponse = z.infer<typeof GitLabSearchResponseSchema>;
|
||||||
export type GitLabMergeRequestDiff = z.infer<
|
export type GitLabMergeRequestDiff = z.infer<typeof GitLabMergeRequestDiffSchema>;
|
||||||
typeof GitLabMergeRequestDiffSchema
|
|
||||||
>;
|
|
||||||
export type CreateNoteOptions = z.infer<typeof CreateNoteSchema>;
|
export type CreateNoteOptions = z.infer<typeof CreateNoteSchema>;
|
||||||
export type GitLabIssueLink = z.infer<typeof GitLabIssueLinkSchema>;
|
export type GitLabIssueLink = z.infer<typeof GitLabIssueLinkSchema>;
|
||||||
export type ListIssueDiscussionsOptions = z.infer<typeof ListIssueDiscussionsSchema>;
|
export type ListIssueDiscussionsOptions = z.infer<typeof ListIssueDiscussionsSchema>;
|
||||||
export type UpdateIssueNoteOptions = z.infer<typeof UpdateIssueNoteSchema>;
|
export type UpdateIssueNoteOptions = z.infer<typeof UpdateIssueNoteSchema>;
|
||||||
export type CreateIssueNoteOptions = z.infer<typeof CreateIssueNoteSchema>;
|
export type CreateIssueNoteOptions = z.infer<typeof CreateIssueNoteSchema>;
|
||||||
export type GitLabNamespace = z.infer<typeof GitLabNamespaceSchema>;
|
export type GitLabNamespace = z.infer<typeof GitLabNamespaceSchema>;
|
||||||
export type GitLabNamespaceExistsResponse = z.infer<
|
export type GitLabNamespaceExistsResponse = z.infer<typeof GitLabNamespaceExistsResponseSchema>;
|
||||||
typeof GitLabNamespaceExistsResponseSchema
|
|
||||||
>;
|
|
||||||
export type GitLabProject = z.infer<typeof GitLabProjectSchema>;
|
export type GitLabProject = z.infer<typeof GitLabProjectSchema>;
|
||||||
export type GitLabLabel = z.infer<typeof GitLabLabelSchema>;
|
export type GitLabLabel = z.infer<typeof GitLabLabelSchema>;
|
||||||
export type ListWikiPagesOptions = z.infer<typeof ListWikiPagesSchema>;
|
export type ListWikiPagesOptions = z.infer<typeof ListWikiPagesSchema>;
|
||||||
@ -1238,3 +1281,13 @@ export type GitLabPipeline = z.infer<typeof GitLabPipelineSchema>;
|
|||||||
export type ListPipelinesOptions = z.infer<typeof ListPipelinesSchema>;
|
export type ListPipelinesOptions = z.infer<typeof ListPipelinesSchema>;
|
||||||
export type GetPipelineOptions = z.infer<typeof GetPipelineSchema>;
|
export type GetPipelineOptions = z.infer<typeof GetPipelineSchema>;
|
||||||
export type ListPipelineJobsOptions = z.infer<typeof ListPipelineJobsSchema>;
|
export type ListPipelineJobsOptions = z.infer<typeof ListPipelineJobsSchema>;
|
||||||
|
export type GitLabMilestones = z.infer<typeof GitLabMilestonesSchema>;
|
||||||
|
export type ListProjectMilestonesOptions = z.infer<typeof ListProjectMilestonesSchema>;
|
||||||
|
export type GetProjectMilestoneOptions = z.infer<typeof GetProjectMilestoneSchema>;
|
||||||
|
export type CreateProjectMilestoneOptions = z.infer<typeof CreateProjectMilestoneSchema>;
|
||||||
|
export type EditProjectMilestoneOptions = z.infer<typeof EditProjectMilestoneSchema>;
|
||||||
|
export type DeleteProjectMilestoneOptions = z.infer<typeof DeleteProjectMilestoneSchema>;
|
||||||
|
export type GetMilestoneIssuesOptions = z.infer<typeof GetMilestoneIssuesSchema>;
|
||||||
|
export type GetMilestoneMergeRequestsOptions = z.infer<typeof GetMilestoneMergeRequestsSchema>;
|
||||||
|
export type PromoteProjectMilestoneOptions = z.infer<typeof PromoteProjectMilestoneSchema>;
|
||||||
|
export type GetMilestoneBurndownEventsOptions = z.infer<typeof GetMilestoneBurndownEventsSchema>;
|
||||||
|
@ -1,22 +1,22 @@
|
|||||||
import fs from 'fs';
|
import fs from "fs";
|
||||||
import path from 'path';
|
import path from "path";
|
||||||
import { fileURLToPath } from 'url';
|
import { fileURLToPath } from "url";
|
||||||
|
|
||||||
const __filename = fileURLToPath(import.meta.url);
|
const __filename = fileURLToPath(import.meta.url);
|
||||||
const __dirname = path.dirname(__filename);
|
const __dirname = path.dirname(__filename);
|
||||||
|
|
||||||
async function main() {
|
async function main() {
|
||||||
const repoRoot = path.resolve(__dirname, '..');
|
const repoRoot = path.resolve(__dirname, "..");
|
||||||
const indexPath = path.join(repoRoot, 'index.ts');
|
const indexPath = path.join(repoRoot, "index.ts");
|
||||||
const readmePath = path.join(repoRoot, 'README.md');
|
const readmePath = path.join(repoRoot, "README.md");
|
||||||
|
|
||||||
// 1. Read index.ts
|
// 1. Read index.ts
|
||||||
const code = fs.readFileSync(indexPath, 'utf-8');
|
const code = fs.readFileSync(indexPath, "utf-8");
|
||||||
|
|
||||||
// 2. Extract allTools array block
|
// 2. Extract allTools array block
|
||||||
const match = code.match(/const allTools = \[([\s\S]*?)\];/);
|
const match = code.match(/const allTools = \[([\s\S]*?)\];/);
|
||||||
if (!match) {
|
if (!match) {
|
||||||
console.error('Unable to locate allTools array in index.ts');
|
console.error("Unable to locate allTools array in index.ts");
|
||||||
process.exit(1);
|
process.exit(1);
|
||||||
}
|
}
|
||||||
const toolsBlock = match[1];
|
const toolsBlock = match[1];
|
||||||
@ -33,18 +33,18 @@ async function main() {
|
|||||||
const lines = tools.map((tool, index) => {
|
const lines = tools.map((tool, index) => {
|
||||||
return `${index + 1}. \`${tool.name}\` - ${tool.description}`;
|
return `${index + 1}. \`${tool.name}\` - ${tool.description}`;
|
||||||
});
|
});
|
||||||
const markdown = lines.join('\n');
|
const markdown = lines.join("\n");
|
||||||
|
|
||||||
// 5. Read README.md and replace between markers
|
// 5. Read README.md and replace between markers
|
||||||
const readme = fs.readFileSync(readmePath, 'utf-8');
|
const readme = fs.readFileSync(readmePath, "utf-8");
|
||||||
const updated = readme.replace(
|
const updated = readme.replace(
|
||||||
/<!-- TOOLS-START -->([\s\S]*?)<!-- TOOLS-END -->/,
|
/<!-- TOOLS-START -->([\s\S]*?)<!-- TOOLS-END -->/,
|
||||||
`<!-- TOOLS-START -->\n${markdown}\n<!-- TOOLS-END -->`
|
`<!-- TOOLS-START -->\n${markdown}\n<!-- TOOLS-END -->`
|
||||||
);
|
);
|
||||||
|
|
||||||
// 6. Write back
|
// 6. Write back
|
||||||
fs.writeFileSync(readmePath, updated, 'utf-8');
|
fs.writeFileSync(readmePath, updated, "utf-8");
|
||||||
console.log('README.md tools section updated.');
|
console.log("README.md tools section updated.");
|
||||||
}
|
}
|
||||||
|
|
||||||
main().catch(err => {
|
main().catch(err => {
|
||||||
|
18
scripts/image_push.sh
Normal file
18
scripts/image_push.sh
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
if [ -z "$1" ]; then
|
||||||
|
echo "Error: docker user name required."
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
DOCKER_USER=$1
|
||||||
|
IMAGE_NAME=gitlab-mcp
|
||||||
|
IMAGE_VERSION=$(jq -r '.version' package.json)
|
||||||
|
|
||||||
|
echo "${DOCKER_USER}/${IMAGE_NAME}:${IMAGE_VERSION}"
|
||||||
|
docker build --platform=linux/arm64 -t "${DOCKER_USER}/${IMAGE_NAME}:latest" .
|
||||||
|
|
||||||
|
docker tag "${DOCKER_USER}/${IMAGE_NAME}:latest" "${DOCKER_USER}/${IMAGE_NAME}:${IMAGE_VERSION}"
|
||||||
|
|
||||||
|
docker push "${DOCKER_USER}/${IMAGE_NAME}:latest"
|
||||||
|
docker push "${DOCKER_USER}/${IMAGE_NAME}:${IMAGE_VERSION}"
|
56
scripts/validate-pr.sh
Executable file
56
scripts/validate-pr.sh
Executable file
@ -0,0 +1,56 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# PR Validation Script
|
||||||
|
# This script runs all necessary checks before merging a PR
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
echo "🔍 Starting PR validation..."
|
||||||
|
|
||||||
|
# Check if Node.js is installed
|
||||||
|
if ! command -v node &> /dev/null; then
|
||||||
|
echo "❌ Node.js is not installed"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "📦 Installing dependencies..."
|
||||||
|
npm ci
|
||||||
|
|
||||||
|
echo "🔨 Building project..."
|
||||||
|
npm run build
|
||||||
|
|
||||||
|
echo "🧪 Running unit tests..."
|
||||||
|
npm run test:unit
|
||||||
|
|
||||||
|
echo "✨ Checking code formatting..."
|
||||||
|
npm run format:check || {
|
||||||
|
echo "⚠️ Code formatting issues found. Run 'npm run format' to fix."
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
echo "🔍 Running linter..."
|
||||||
|
npm run lint || {
|
||||||
|
echo "⚠️ Linting issues found. Run 'npm run lint:fix' to fix."
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
echo "📊 Running tests with coverage..."
|
||||||
|
npm run test:coverage
|
||||||
|
|
||||||
|
# Check if integration tests should run
|
||||||
|
if [ -n "$GITLAB_TOKEN" ] && [ -n "$TEST_PROJECT_ID" ]; then
|
||||||
|
echo "🌐 Running integration tests..."
|
||||||
|
npm run test:integration
|
||||||
|
else
|
||||||
|
echo "⚠️ Skipping integration tests (no credentials provided)"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "🐳 Testing Docker build..."
|
||||||
|
if command -v docker &> /dev/null; then
|
||||||
|
docker build -t mcp-gitlab-test .
|
||||||
|
echo "✅ Docker build successful"
|
||||||
|
else
|
||||||
|
echo "⚠️ Docker not available, skipping Docker build test"
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "✅ All PR validation checks passed!"
|
@ -33,9 +33,7 @@ async function testCreateIssueNote() {
|
|||||||
|
|
||||||
if (!response.ok) {
|
if (!response.ok) {
|
||||||
const errorBody = await response.text();
|
const errorBody = await response.text();
|
||||||
throw new Error(
|
throw new Error(`GitLab API error: ${response.status} ${response.statusText}\n${errorBody}`);
|
||||||
`GitLab API error: ${response.status} ${response.statusText}\n${errorBody}`
|
|
||||||
);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
const data = await response.json();
|
const data = await response.json();
|
||||||
|
96
test/validate-api.js
Executable file
96
test/validate-api.js
Executable file
@ -0,0 +1,96 @@
|
|||||||
|
#!/usr/bin/env node
|
||||||
|
|
||||||
|
// Simple API validation script for PR testing
|
||||||
|
import fetch from "node-fetch";
|
||||||
|
|
||||||
|
const GITLAB_API_URL = process.env.GITLAB_API_URL || "https://gitlab.com";
|
||||||
|
const GITLAB_TOKEN = process.env.GITLAB_TOKEN_TEST || process.env.GITLAB_TOKEN;
|
||||||
|
const TEST_PROJECT_ID = process.env.TEST_PROJECT_ID;
|
||||||
|
|
||||||
|
async function validateGitLabAPI() {
|
||||||
|
console.log("🔍 Validating GitLab API connection...\n");
|
||||||
|
|
||||||
|
if (!GITLAB_TOKEN) {
|
||||||
|
console.warn("⚠️ No GitLab token provided. Skipping API validation.");
|
||||||
|
console.log("Set GITLAB_TOKEN_TEST or GITLAB_TOKEN to enable API validation.\n");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!TEST_PROJECT_ID) {
|
||||||
|
console.warn("⚠️ No test project ID provided. Skipping API validation.");
|
||||||
|
console.log("Set TEST_PROJECT_ID to enable API validation.\n");
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
const tests = [
|
||||||
|
{
|
||||||
|
name: "Fetch project info",
|
||||||
|
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}`,
|
||||||
|
validate: data => data.id && data.name,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "List issues",
|
||||||
|
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/issues?per_page=1`,
|
||||||
|
validate: data => Array.isArray(data),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "List merge requests",
|
||||||
|
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/merge_requests?per_page=1`,
|
||||||
|
validate: data => Array.isArray(data),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "List branches",
|
||||||
|
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/repository/branches?per_page=1`,
|
||||||
|
validate: data => Array.isArray(data),
|
||||||
|
},
|
||||||
|
];
|
||||||
|
|
||||||
|
let allPassed = true;
|
||||||
|
|
||||||
|
for (const test of tests) {
|
||||||
|
try {
|
||||||
|
console.log(`Testing: ${test.name}`);
|
||||||
|
const response = await fetch(test.url, {
|
||||||
|
headers: {
|
||||||
|
Authorization: `Bearer ${GITLAB_TOKEN}`,
|
||||||
|
Accept: "application/json",
|
||||||
|
},
|
||||||
|
});
|
||||||
|
|
||||||
|
if (!response.ok) {
|
||||||
|
throw new Error(`HTTP ${response.status}: ${response.statusText}`);
|
||||||
|
}
|
||||||
|
|
||||||
|
const data = await response.json();
|
||||||
|
|
||||||
|
if (test.validate(data)) {
|
||||||
|
console.log(`✅ ${test.name} - PASSED\n`);
|
||||||
|
} else {
|
||||||
|
console.log(`❌ ${test.name} - FAILED (invalid response format)\n`);
|
||||||
|
allPassed = false;
|
||||||
|
}
|
||||||
|
} catch (error) {
|
||||||
|
console.log(`❌ ${test.name} - FAILED`);
|
||||||
|
console.log(` Error: ${error.message}\n`);
|
||||||
|
allPassed = false;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (allPassed) {
|
||||||
|
console.log("✅ All API validation tests passed!");
|
||||||
|
} else {
|
||||||
|
console.log("❌ Some API validation tests failed!");
|
||||||
|
}
|
||||||
|
|
||||||
|
return allPassed;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Run validation
|
||||||
|
validateGitLabAPI()
|
||||||
|
.then(success => process.exit(success ? 0 : 1))
|
||||||
|
.catch(error => {
|
||||||
|
console.error("Unexpected error:", error);
|
||||||
|
process.exit(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
export { validateGitLabAPI };
|
Reference in New Issue
Block a user