Compare commits
33 Commits
feat/docke
...
pxpeterxu-
Author | SHA1 | Date | |
---|---|---|---|
f60d68af2c | |||
3ce688b55c | |||
74af27f995 | |||
1e0bcb173d | |||
93b1e47f65 | |||
de0b138d80 | |||
fa19b62300 | |||
353638f5d7 | |||
059ec83cd7 | |||
1762a5851c | |||
6d452be0b0 | |||
0aa5e5a30e | |||
8e2b6e6734 | |||
e967bb51c8 | |||
b00cc9e6f5 | |||
5c67d68be4 | |||
9a52dafb03 | |||
435c8f1223 | |||
7391f5160d | |||
940902de73 | |||
9aef7f43c4 | |||
720cd7a445 | |||
6d6110c78b | |||
7acdff90ef | |||
a2760f0aea | |||
37203bae5a | |||
5b35bc163c | |||
181f1e943c | |||
2a80988a02 | |||
5762b32a69 | |||
55e7ca3100 | |||
953f748e0d | |||
fd1c8b9704 |
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 }}
|
38
.github/workflows/docker-publish.yml
vendored
Normal file
38
.github/workflows/docker-publish.yml
vendored
Normal file
@ -0,0 +1,38 @@
|
||||
name: Docker Publish
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
|
||||
jobs:
|
||||
docker:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Login to Docker Hub
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
username: ${{ secrets.DOCKERHUB_USERNAME }}
|
||||
password: ${{ secrets.DOCKERHUB_TOKEN }}
|
||||
|
||||
- name: Extract metadata for Docker
|
||||
id: meta
|
||||
uses: docker/metadata-action@v5
|
||||
with:
|
||||
images: ${{ secrets.DOCKERHUB_USERNAME }}/gitlab-mcp
|
||||
tags: |
|
||||
type=semver,pattern={{version}}
|
||||
latest
|
||||
|
||||
- name: Build and push Docker image
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
push: true
|
||||
tags: ${{ steps.meta.outputs.tags }}
|
163
.github/workflows/pr-test.yml
vendored
Normal file
163
.github/workflows/pr-test.yml
vendored
Normal file
@ -0,0 +1,163 @@
|
||||
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 }}
|
||||
GITLAB_PERSONAL_ACCESS_TOKEN: ${{ secrets.GITLAB_PERSONAL_ACCESS_TOKEN }}
|
||||
|
||||
- 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
|
||||
echo "Package created successfully"
|
||||
|
||||
- name: Security audit
|
||||
run: npm audit --production || echo "Some vulnerabilities found"
|
||||
continue-on-error: true
|
||||
|
||||
- name: Test MCP server startup
|
||||
run: |
|
||||
echo "MCP server startup test temporarily disabled for debugging"
|
||||
echo "GITLAB_PERSONAL_ACCESS_TOKEN is: ${GITLAB_PERSONAL_ACCESS_TOKEN:0:10}..."
|
||||
env:
|
||||
GITLAB_API_URL: ${{ secrets.GITLAB_API_URL }}
|
||||
GITLAB_TOKEN: ${{ secrets.GITLAB_TOKEN_TEST }}
|
||||
GITLAB_PERSONAL_ACCESS_TOKEN: ${{ secrets.GITLAB_PERSONAL_ACCESS_TOKEN }}
|
||||
|
||||
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: ${{ github.event_name == 'push' || github.event.pull_request.head.repo.full_name == github.repository }}
|
||||
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 }}
|
||||
GITLAB_PERSONAL_ACCESS_TOKEN: ${{ secrets.GITLAB_PERSONAL_ACCESS_TOKEN }}
|
||||
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
|
||||
.DS_Store
|
||||
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"
|
||||
}
|
3
.secrets
Normal file
3
.secrets
Normal file
@ -0,0 +1,3 @@
|
||||
DOCKERHUB_USERNAME=DOCKERHUB_USERNAME
|
||||
DOCKERHUB_TOKEN=DOCKERHUB_TOKEN
|
||||
GITHUB_TOKEN=DOCKERHUB_TOKEN
|
21
CHANGELOG.md
21
CHANGELOG.md
@ -1,3 +1,23 @@
|
||||
## [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
|
||||
@ -11,6 +31,7 @@
|
||||
### 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)
|
||||
|
29
README.md
29
README.md
@ -26,7 +26,9 @@ 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 wiki api?
|
||||
"USE_MILESTONE": "false", // use milestone api?
|
||||
"USE_PIPELINE": "false" // use pipeline api?
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -52,13 +54,19 @@ 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",
|
||||
"-e",
|
||||
"USE_PIPELINE",
|
||||
"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",
|
||||
"USE_PIPELINE": "true"
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -77,10 +85,13 @@ $ 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.
|
||||
- `USE_PIPELINE`: When set to 'true', enables the pipeline-related tools (list_pipelines, get_pipeline, list_pipeline_jobs, get_pipeline_job, get_pipeline_job_output, create_pipeline, retry_pipeline, cancel_pipeline). By default, pipeline 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
|
||||
@ -131,5 +142,17 @@ $ sh scripts/image_push.sh docker_user_name
|
||||
48. `list_pipeline_jobs` - List all jobs in a specific pipeline
|
||||
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
|
||||
51. `list_merge_requests` - List merge requests in a GitLab project with filtering options
|
||||
51. `create_pipeline` - Create a new pipeline for a branch or tag
|
||||
52. `retry_pipeline` - Retry a failed or canceled pipeline
|
||||
53. `cancel_pipeline` - Cancel a running pipeline
|
||||
54. `list_merge_requests` - List merge requests in a GitLab project with filtering options
|
||||
55. `list_milestones` - List milestones in a GitLab project with filtering options
|
||||
56. `get_milestone` - Get details of a specific milestone
|
||||
57. `create_milestone` - Create a new milestone in a GitLab project
|
||||
58. `edit_milestone ` - Edit an existing milestone in a GitLab project
|
||||
59. `delete_milestone` - Delete a milestone from a GitLab project
|
||||
60. `get_milestone_issue` - Get issues associated with a specific milestone
|
||||
61. `get_milestone_merge_requests` - Get merge requests associated with a specific milestone
|
||||
62. `promote_milestone` - Promote a milestone to the next stage
|
||||
63. `get_milestone_burndown_events` - Get burndown events for a specific milestone
|
||||
<!-- 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!
|
6
event.json
Normal file
6
event.json
Normal file
@ -0,0 +1,6 @@
|
||||
{
|
||||
"action": "published",
|
||||
"release": {
|
||||
"tag_name": "v1.0.52"
|
||||
}
|
||||
}
|
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",
|
||||
"version": "1.0.47",
|
||||
"version": "1.0.52",
|
||||
"description": "MCP server for using the GitLab API",
|
||||
"license": "MIT",
|
||||
"author": "zereight",
|
||||
@ -20,7 +20,13 @@
|
||||
"prepare": "npm run build",
|
||||
"watch": "tsc --watch",
|
||||
"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": {
|
||||
"@modelcontextprotocol/sdk": "1.8.0",
|
||||
@ -35,6 +41,11 @@
|
||||
"devDependencies": {
|
||||
"@types/node": "^22.13.10",
|
||||
"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"
|
||||
}
|
||||
}
|
||||
|
617
schemas.ts
617
schemas.ts
@ -22,27 +22,34 @@ export const GitLabPipelineSchema = z.object({
|
||||
started_at: z.string().nullable().optional(),
|
||||
finished_at: z.string().nullable().optional(),
|
||||
coverage: z.number().nullable().optional(),
|
||||
user: z.object({
|
||||
id: z.number(),
|
||||
name: z.string(),
|
||||
username: z.string(),
|
||||
avatar_url: z.string().nullable().optional(),
|
||||
}).optional(),
|
||||
detailed_status: z.object({
|
||||
icon: z.string().optional(),
|
||||
text: z.string().optional(),
|
||||
label: z.string().optional(),
|
||||
group: z.string().optional(),
|
||||
tooltip: z.string().optional(),
|
||||
has_details: z.boolean().optional(),
|
||||
details_path: z.string().optional(),
|
||||
illustration: z.object({
|
||||
image: z.string().optional(),
|
||||
size: z.string().optional(),
|
||||
title: z.string().optional(),
|
||||
}).nullable().optional(),
|
||||
favicon: z.string().optional(),
|
||||
}).optional(),
|
||||
user: z
|
||||
.object({
|
||||
id: z.number(),
|
||||
name: z.string(),
|
||||
username: z.string(),
|
||||
avatar_url: z.string().nullable().optional(),
|
||||
})
|
||||
.optional(),
|
||||
detailed_status: z
|
||||
.object({
|
||||
icon: z.string().optional(),
|
||||
text: z.string().optional(),
|
||||
label: z.string().optional(),
|
||||
group: z.string().optional(),
|
||||
tooltip: z.string().optional(),
|
||||
has_details: z.boolean().optional(),
|
||||
details_path: z.string().optional(),
|
||||
illustration: z
|
||||
.object({
|
||||
image: z.string().optional(),
|
||||
size: z.string().optional(),
|
||||
title: z.string().optional(),
|
||||
})
|
||||
.nullable()
|
||||
.optional(),
|
||||
favicon: z.string().optional(),
|
||||
})
|
||||
.optional(),
|
||||
});
|
||||
|
||||
// Pipeline job related schemas
|
||||
@ -58,42 +65,75 @@ export const GitLabPipelineJobSchema = z.object({
|
||||
started_at: z.string().nullable().optional(),
|
||||
finished_at: z.string().nullable().optional(),
|
||||
duration: z.number().nullable().optional(),
|
||||
user: z.object({
|
||||
id: z.number(),
|
||||
name: z.string(),
|
||||
username: z.string(),
|
||||
avatar_url: z.string().nullable().optional(),
|
||||
}).optional(),
|
||||
commit: z.object({
|
||||
id: z.string(),
|
||||
short_id: z.string(),
|
||||
title: z.string(),
|
||||
author_name: z.string(),
|
||||
author_email: z.string(),
|
||||
}).optional(),
|
||||
pipeline: z.object({
|
||||
id: z.number(),
|
||||
project_id: z.number(),
|
||||
status: z.string(),
|
||||
ref: z.string(),
|
||||
sha: z.string(),
|
||||
}).optional(),
|
||||
user: z
|
||||
.object({
|
||||
id: z.number(),
|
||||
name: z.string(),
|
||||
username: z.string(),
|
||||
avatar_url: z.string().nullable().optional(),
|
||||
})
|
||||
.optional(),
|
||||
commit: z
|
||||
.object({
|
||||
id: z.string(),
|
||||
short_id: z.string(),
|
||||
title: z.string(),
|
||||
author_name: z.string(),
|
||||
author_email: z.string(),
|
||||
})
|
||||
.optional(),
|
||||
pipeline: z
|
||||
.object({
|
||||
id: z.number(),
|
||||
project_id: z.number(),
|
||||
status: z.string(),
|
||||
ref: z.string(),
|
||||
sha: z.string(),
|
||||
})
|
||||
.optional(),
|
||||
web_url: z.string().optional(),
|
||||
});
|
||||
|
||||
// Schema for listing pipelines
|
||||
export const ListPipelinesSchema = z.object({
|
||||
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"),
|
||||
status: z.enum(['created', 'waiting_for_resource', 'preparing', 'pending', 'running', 'success', 'failed', 'canceled', 'skipped', 'manual', 'scheduled']).optional().describe("The status of pipelines"),
|
||||
scope: z
|
||||
.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"),
|
||||
sha: z.string().optional().describe("The SHA of pipelines"),
|
||||
yaml_errors: z.boolean().optional().describe("Returns pipelines with invalid configurations"),
|
||||
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_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"),
|
||||
updated_after: z
|
||||
.string()
|
||||
.optional()
|
||||
.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"),
|
||||
per_page: z.number().optional().describe("Number of items per page (max 100)"),
|
||||
});
|
||||
@ -108,12 +148,42 @@ export const GetPipelineSchema = z.object({
|
||||
export const ListPipelineJobsSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
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"),
|
||||
page: z.number().optional().describe("Page number for pagination"),
|
||||
per_page: z.number().optional().describe("Number of items per page (max 100)"),
|
||||
});
|
||||
|
||||
// Schema for creating a new pipeline
|
||||
export const CreatePipelineSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
ref: z.string().describe("The branch or tag to run the pipeline on"),
|
||||
variables: z
|
||||
.array(
|
||||
z.object({
|
||||
key: z.string().describe("The key of the variable"),
|
||||
value: z.string().describe("The value of the variable"),
|
||||
})
|
||||
)
|
||||
.optional()
|
||||
.describe("An array of variables to use for the pipeline"),
|
||||
});
|
||||
|
||||
// Schema for retrying a pipeline
|
||||
export const RetryPipelineSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
pipeline_id: z.number().describe("The ID of the pipeline to retry"),
|
||||
});
|
||||
|
||||
// Schema for canceling a pipeline
|
||||
export const CancelPipelineSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
pipeline_id: z.number().describe("The ID of the pipeline to cancel"),
|
||||
});
|
||||
|
||||
// Schema for the input parameters for pipeline job operations
|
||||
export const GetPipelineJobOutputSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
@ -287,21 +357,10 @@ export const GetRepositoryTreeSchema = z.object({
|
||||
ref: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe(
|
||||
"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"),
|
||||
page_token: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("The tree record ID for pagination"),
|
||||
.describe("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"),
|
||||
page_token: z.string().optional().describe("The tree record ID for pagination"),
|
||||
pagination: z.string().optional().describe("Pagination method (keyset)"),
|
||||
});
|
||||
|
||||
@ -333,6 +392,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
|
||||
export const CreateRepositoryOptionsSchema = z.object({
|
||||
name: z.string(),
|
||||
@ -543,21 +618,21 @@ export const GitLabDiscussionNoteSchema = z.object({
|
||||
old_path: z.string(),
|
||||
new_path: z.string(),
|
||||
position_type: z.enum(["text", "image", "file"]),
|
||||
old_line: z.number().nullable(),
|
||||
new_line: z.number().nullable(),
|
||||
old_line: z.number().nullish(), // This is missing for image diffs
|
||||
new_line: z.number().nullish(), // This is missing for image diffs
|
||||
line_range: z
|
||||
.object({
|
||||
start: z.object({
|
||||
line_code: z.string(),
|
||||
type: z.enum(["new", "old", "expanded"]),
|
||||
old_line: z.number().nullable(),
|
||||
new_line: z.number().nullable(),
|
||||
old_line: z.number().nullish(), // This is missing for image diffs
|
||||
new_line: z.number().nullish(), // This is missing for image diffs
|
||||
}),
|
||||
end: z.object({
|
||||
line_code: z.string(),
|
||||
type: z.enum(["new", "old", "expanded"]),
|
||||
old_line: z.number().nullable(),
|
||||
new_line: z.number().nullable(),
|
||||
old_line: z.number().nullish(), // This is missing for image diffs
|
||||
new_line: z.number().nullish(), // This is missing for image diffs
|
||||
}),
|
||||
})
|
||||
.nullable()
|
||||
@ -590,11 +665,13 @@ export const UpdateMergeRequestNoteSchema = ProjectParamsSchema.extend({
|
||||
note_id: z.number().describe("The ID of a thread note"),
|
||||
body: z.string().optional().describe("The content of the note or reply"),
|
||||
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), {
|
||||
message: "Only one of 'body' or 'resolved' can be provided, not both"
|
||||
});
|
||||
})
|
||||
.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), {
|
||||
message: "Only one of 'body' or 'resolved' can be provided, not both",
|
||||
});
|
||||
|
||||
// Input schema for adding a note to an existing merge request discussion
|
||||
export const CreateMergeRequestNoteSchema = ProjectParamsSchema.extend({
|
||||
@ -627,27 +704,15 @@ export const CreateOrUpdateFileSchema = ProjectParamsSchema.extend({
|
||||
content: z.string().describe("Content of the file"),
|
||||
commit_message: z.string().describe("Commit message"),
|
||||
branch: z.string().describe("Branch to create/update the file in"),
|
||||
previous_path: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("Path of the file to move/rename"),
|
||||
previous_path: z.string().optional().describe("Path of the file to move/rename"),
|
||||
last_commit_id: z.string().optional().describe("Last known file commit ID"),
|
||||
commit_id: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("Current file commit ID (for update operations)"),
|
||||
commit_id: z.string().optional().describe("Current file commit ID (for update operations)"),
|
||||
});
|
||||
|
||||
export const SearchRepositoriesSchema = z.object({
|
||||
search: z.string().describe("Search query"), // Changed from query to match GitLab API
|
||||
page: z
|
||||
.number()
|
||||
.optional()
|
||||
.describe("Page number for pagination (default: 1)"),
|
||||
per_page: z
|
||||
.number()
|
||||
.optional()
|
||||
.describe("Number of results per page (default: 20)"),
|
||||
page: z.number().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({
|
||||
@ -657,10 +722,7 @@ export const CreateRepositorySchema = z.object({
|
||||
.enum(["private", "internal", "public"])
|
||||
.optional()
|
||||
.describe("Repository visibility level"),
|
||||
initialize_with_readme: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Initialize with README.md"),
|
||||
initialize_with_readme: z.boolean().optional().describe("Initialize with README.md"),
|
||||
});
|
||||
|
||||
export const GetFileContentsSchema = ProjectParamsSchema.extend({
|
||||
@ -684,10 +746,7 @@ export const PushFilesSchema = ProjectParamsSchema.extend({
|
||||
export const CreateIssueSchema = ProjectParamsSchema.extend({
|
||||
title: z.string().describe("Issue title"),
|
||||
description: z.string().optional().describe("Issue description"),
|
||||
assignee_ids: z
|
||||
.array(z.number())
|
||||
.optional()
|
||||
.describe("Array of user IDs to assign"),
|
||||
assignee_ids: z.array(z.number()).optional().describe("Array of user IDs to assign"),
|
||||
labels: z.array(z.string()).optional().describe("Array of label names"),
|
||||
milestone_id: z.number().optional().describe("Milestone ID to assign"),
|
||||
});
|
||||
@ -698,10 +757,7 @@ export const CreateMergeRequestSchema = ProjectParamsSchema.extend({
|
||||
source_branch: z.string().describe("Branch containing changes"),
|
||||
target_branch: z.string().describe("Branch to merge into"),
|
||||
draft: z.boolean().optional().describe("Create as draft merge request"),
|
||||
allow_collaboration: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Allow commits from upstream members"),
|
||||
allow_collaboration: z.boolean().optional().describe("Allow commits from upstream members"),
|
||||
});
|
||||
|
||||
export const ForkRepositorySchema = ProjectParamsSchema.extend({
|
||||
@ -725,24 +781,15 @@ export const GitLabMergeRequestDiffSchema = z.object({
|
||||
});
|
||||
|
||||
export const GetMergeRequestSchema = ProjectParamsSchema.extend({
|
||||
merge_request_iid: z
|
||||
.number()
|
||||
.optional()
|
||||
.describe("The IID of a merge request"),
|
||||
merge_request_iid: z.number().optional().describe("The IID of a merge request"),
|
||||
source_branch: z.string().optional().describe("Source branch name"),
|
||||
});
|
||||
|
||||
export const UpdateMergeRequestSchema = GetMergeRequestSchema.extend({
|
||||
title: z.string().optional().describe("The title of the merge request"),
|
||||
description: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("The description of the merge request"),
|
||||
description: z.string().optional().describe("The description of the merge request"),
|
||||
target_branch: z.string().optional().describe("The target branch"),
|
||||
assignee_ids: z
|
||||
.array(z.number())
|
||||
.optional()
|
||||
.describe("The ID of the users to assign the MR to"),
|
||||
assignee_ids: z.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"),
|
||||
state_event: z
|
||||
.enum(["close", "reopen"])
|
||||
@ -752,10 +799,7 @@ export const UpdateMergeRequestSchema = GetMergeRequestSchema.extend({
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Flag indicating if the source branch should be removed"),
|
||||
squash: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Squash commits into a single commit when merging"),
|
||||
squash: z.boolean().optional().describe("Squash commits into a single commit when merging"),
|
||||
draft: z.boolean().optional().describe("Work in progress merge request"),
|
||||
});
|
||||
|
||||
@ -775,38 +819,14 @@ export const CreateNoteSchema = z.object({
|
||||
// Issues API operation schemas
|
||||
export const ListIssuesSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
assignee_id: z
|
||||
.number()
|
||||
.optional()
|
||||
.describe("Return issues assigned to the given user ID"),
|
||||
assignee_username: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("Return issues assigned to the given username"),
|
||||
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"),
|
||||
assignee_id: z.number().optional().describe("Return issues assigned to the given user ID"),
|
||||
assignee_username: z.string().optional().describe("Return issues assigned to the given username"),
|
||||
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"),
|
||||
milestone: z.string().optional().describe("Milestone title"),
|
||||
scope: z
|
||||
@ -818,18 +838,9 @@ export const ListIssuesSchema = z.object({
|
||||
.enum(["opened", "closed", "all"])
|
||||
.optional()
|
||||
.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"),
|
||||
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"),
|
||||
});
|
||||
@ -845,10 +856,7 @@ export const ListMergeRequestsSchema = z.object({
|
||||
.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_id: z.number().optional().describe("Returns merge requests created by the given user ID"),
|
||||
author_username: z
|
||||
.string()
|
||||
.optional()
|
||||
@ -904,14 +912,8 @@ export const ListMergeRequestsSchema = z.object({
|
||||
.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"),
|
||||
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"),
|
||||
per_page: z.number().optional().describe("Number of items per page"),
|
||||
});
|
||||
@ -926,28 +928,13 @@ export const UpdateIssueSchema = z.object({
|
||||
issue_iid: z.number().describe("The internal ID of the project issue"),
|
||||
title: z.string().optional().describe("The title of the issue"),
|
||||
description: z.string().optional().describe("The description of the issue"),
|
||||
assignee_ids: z
|
||||
.array(z.number())
|
||||
.optional()
|
||||
.describe("Array of user IDs to assign issue to"),
|
||||
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)"),
|
||||
assignee_ids: z.array(z.number()).optional().describe("Array of user IDs to assign issue to"),
|
||||
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"),
|
||||
milestone_id: z.number().optional().describe("Milestone ID to assign"),
|
||||
state_event: z
|
||||
.enum(["close", "reopen"])
|
||||
.optional()
|
||||
.describe("Update issue state (close/reopen)"),
|
||||
state_event: z.enum(["close", "reopen"]).optional().describe("Update issue state (close/reopen)"),
|
||||
weight: z.number().optional().describe("Weight of the issue (0-9)"),
|
||||
});
|
||||
|
||||
@ -973,8 +960,14 @@ export const ListIssueDiscussionsSchema = z.object({
|
||||
issue_iid: z.number().describe("The internal ID of the project issue"),
|
||||
page: z.number().optional().describe("Page number for pagination"),
|
||||
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"),
|
||||
order_by: z.enum(["created_at", "updated_at"]).optional().describe("Return issue discussions ordered by created_at or updated_at fields"),
|
||||
sort: z
|
||||
.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({
|
||||
@ -986,12 +979,8 @@ export const GetIssueLinkSchema = z.object({
|
||||
export const CreateIssueLinkSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
issue_iid: z.number().describe("The internal ID of a project's issue"),
|
||||
target_project_id: z
|
||||
.string()
|
||||
.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"),
|
||||
target_project_id: z.string().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
|
||||
.enum(["relates_to", "blocks", "is_blocked_by"])
|
||||
.optional()
|
||||
@ -1009,10 +998,7 @@ export const ListNamespacesSchema = z.object({
|
||||
search: z.string().optional().describe("Search term for namespaces"),
|
||||
page: z.number().optional().describe("Page number for pagination"),
|
||||
per_page: z.number().optional().describe("Number of items per page"),
|
||||
owned: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Filter for namespaces owned by current user"),
|
||||
owned: z.boolean().optional().describe("Filter for namespaces owned by current user"),
|
||||
});
|
||||
|
||||
export const GetNamespaceSchema = z.object({
|
||||
@ -1032,18 +1018,9 @@ export const ListProjectsSchema = z.object({
|
||||
search: z.string().optional().describe("Search term for projects"),
|
||||
page: z.number().optional().describe("Page number for pagination"),
|
||||
per_page: z.number().optional().describe("Number of items per page"),
|
||||
search_namespaces: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.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"),
|
||||
search_namespaces: z.boolean().optional().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"),
|
||||
archived: z.boolean().optional().describe("Filter for archived projects"),
|
||||
visibility: z
|
||||
@ -1051,14 +1028,7 @@ export const ListProjectsSchema = z.object({
|
||||
.optional()
|
||||
.describe("Filter by project visibility"),
|
||||
order_by: z
|
||||
.enum([
|
||||
"id",
|
||||
"name",
|
||||
"path",
|
||||
"created_at",
|
||||
"updated_at",
|
||||
"last_activity_at",
|
||||
])
|
||||
.enum(["id", "name", "path", "created_at", "updated_at", "last_activity_at"])
|
||||
.optional()
|
||||
.describe("Return projects ordered by field"),
|
||||
sort: z
|
||||
@ -1073,10 +1043,7 @@ export const ListProjectsSchema = z.object({
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Filter projects with merge requests feature enabled"),
|
||||
min_access_level: z
|
||||
.number()
|
||||
.optional()
|
||||
.describe("Filter by minimum access level"),
|
||||
min_access_level: z.number().optional().describe("Filter by minimum access level"),
|
||||
});
|
||||
|
||||
// Label operation schemas
|
||||
@ -1086,20 +1053,14 @@ export const ListLabelsSchema = z.object({
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Whether or not to include issue and merge request counts"),
|
||||
include_ancestor_groups: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Include ancestor groups"),
|
||||
include_ancestor_groups: z.boolean().optional().describe("Include ancestor groups"),
|
||||
search: z.string().optional().describe("Keyword to filter labels by"),
|
||||
});
|
||||
|
||||
export const GetLabelSchema = z.object({
|
||||
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"),
|
||||
include_ancestor_groups: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Include ancestor groups"),
|
||||
include_ancestor_groups: z.boolean().optional().describe("Include ancestor groups"),
|
||||
});
|
||||
|
||||
export const CreateLabelSchema = z.object({
|
||||
@ -1107,15 +1068,9 @@ export const CreateLabelSchema = z.object({
|
||||
name: z.string().describe("The name of the label"),
|
||||
color: z
|
||||
.string()
|
||||
.describe(
|
||||
"The color of the label given in 6-digit hex notation with leading '#' sign"
|
||||
),
|
||||
.describe("The color of the label given in 6-digit hex notation with leading '#' sign"),
|
||||
description: z.string().optional().describe("The description of the label"),
|
||||
priority: z
|
||||
.number()
|
||||
.nullable()
|
||||
.optional()
|
||||
.describe("The priority of the label"),
|
||||
priority: z.number().nullable().optional().describe("The priority of the label"),
|
||||
});
|
||||
|
||||
export const UpdateLabelSchema = z.object({
|
||||
@ -1125,18 +1080,9 @@ export const UpdateLabelSchema = z.object({
|
||||
color: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe(
|
||||
"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"),
|
||||
.describe("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"),
|
||||
});
|
||||
|
||||
export const DeleteLabelSchema = z.object({
|
||||
@ -1147,10 +1093,7 @@ export const DeleteLabelSchema = z.object({
|
||||
// Group projects schema
|
||||
export const ListGroupProjectsSchema = z.object({
|
||||
group_id: z.string().describe("Group ID or path"),
|
||||
include_subgroups: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Include projects from subgroups"),
|
||||
include_subgroups: z.boolean().optional().describe("Include projects from subgroups"),
|
||||
search: z.string().optional().describe("Search term to filter projects"),
|
||||
order_by: z
|
||||
.enum(["name", "path", "created_at", "updated_at", "last_activity_at"])
|
||||
@ -1172,24 +1115,12 @@ export const ListGroupProjectsSchema = z.object({
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Filter projects with merge requests feature enabled"),
|
||||
min_access_level: z
|
||||
.number()
|
||||
.optional()
|
||||
.describe("Filter by minimum access level"),
|
||||
with_programming_language: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("Filter by programming language"),
|
||||
min_access_level: z.number().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"),
|
||||
statistics: z.boolean().optional().describe("Include project statistics"),
|
||||
with_custom_attributes: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Include custom attributes"),
|
||||
with_security_reports: z
|
||||
.boolean()
|
||||
.optional()
|
||||
.describe("Include security reports"),
|
||||
with_custom_attributes: z.boolean().optional().describe("Include custom attributes"),
|
||||
with_security_reports: z.boolean().optional().describe("Include security reports"),
|
||||
});
|
||||
|
||||
// Add wiki operation schemas
|
||||
@ -1206,20 +1137,14 @@ export const CreateWikiPageSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
title: z.string().describe("Title of the wiki page"),
|
||||
content: z.string().describe("Content of the wiki page"),
|
||||
format: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("Content format, e.g., markdown, rdoc"),
|
||||
format: z.string().optional().describe("Content format, e.g., markdown, rdoc"),
|
||||
});
|
||||
export const UpdateWikiPageSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
slug: z.string().describe("URL-encoded slug 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"),
|
||||
format: z
|
||||
.string()
|
||||
.optional()
|
||||
.describe("Content format, e.g., markdown, rdoc"),
|
||||
format: z.string().optional().describe("Content format, e.g., markdown, rdoc"),
|
||||
});
|
||||
export const DeleteWikiPageSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
@ -1256,52 +1181,115 @@ export const MergeRequestThreadPositionSchema = z.object({
|
||||
export const CreateMergeRequestThreadSchema = ProjectParamsSchema.extend({
|
||||
merge_request_iid: z.number().describe("The IID of a merge request"),
|
||||
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)"),
|
||||
});
|
||||
|
||||
// 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 type GitLabAuthor = z.infer<typeof GitLabAuthorSchema>;
|
||||
export type GitLabFork = z.infer<typeof GitLabForkSchema>;
|
||||
export type GitLabIssue = z.infer<typeof GitLabIssueSchema>;
|
||||
export type GitLabIssueWithLinkDetails = z.infer<
|
||||
typeof GitLabIssueWithLinkDetailsSchema
|
||||
>;
|
||||
export type GitLabIssueWithLinkDetails = z.infer<typeof GitLabIssueWithLinkDetailsSchema>;
|
||||
export type GitLabMergeRequest = z.infer<typeof GitLabMergeRequestSchema>;
|
||||
export type GitLabRepository = z.infer<typeof GitLabRepositorySchema>;
|
||||
export type GitLabFileContent = z.infer<typeof GitLabFileContentSchema>;
|
||||
export type GitLabDirectoryContent = z.infer<
|
||||
typeof GitLabDirectoryContentSchema
|
||||
>;
|
||||
export type GitLabDirectoryContent = z.infer<typeof GitLabDirectoryContentSchema>;
|
||||
export type GitLabContent = z.infer<typeof GitLabContentSchema>;
|
||||
export type FileOperation = z.infer<typeof FileOperationSchema>;
|
||||
export type GitLabTree = z.infer<typeof GitLabTreeSchema>;
|
||||
export type GitLabCommit = z.infer<typeof GitLabCommitSchema>;
|
||||
export type GitLabReference = z.infer<typeof GitLabReferenceSchema>;
|
||||
export type CreateRepositoryOptions = z.infer<
|
||||
typeof CreateRepositoryOptionsSchema
|
||||
>;
|
||||
export type CreateRepositoryOptions = z.infer<typeof CreateRepositoryOptionsSchema>;
|
||||
export type CreateIssueOptions = z.infer<typeof CreateIssueOptionsSchema>;
|
||||
export type CreateMergeRequestOptions = z.infer<
|
||||
typeof CreateMergeRequestOptionsSchema
|
||||
>;
|
||||
export type CreateMergeRequestOptions = z.infer<typeof CreateMergeRequestOptionsSchema>;
|
||||
export type CreateBranchOptions = z.infer<typeof CreateBranchOptionsSchema>;
|
||||
export type GitLabCreateUpdateFileResponse = z.infer<
|
||||
typeof GitLabCreateUpdateFileResponseSchema
|
||||
>;
|
||||
export type GitLabCreateUpdateFileResponse = z.infer<typeof GitLabCreateUpdateFileResponseSchema>;
|
||||
export type GitLabSearchResponse = z.infer<typeof GitLabSearchResponseSchema>;
|
||||
export type GitLabMergeRequestDiff = z.infer<
|
||||
typeof GitLabMergeRequestDiffSchema
|
||||
>;
|
||||
export type GitLabMergeRequestDiff = z.infer<typeof GitLabMergeRequestDiffSchema>;
|
||||
export type CreateNoteOptions = z.infer<typeof CreateNoteSchema>;
|
||||
export type GitLabIssueLink = z.infer<typeof GitLabIssueLinkSchema>;
|
||||
export type ListIssueDiscussionsOptions = z.infer<typeof ListIssueDiscussionsSchema>;
|
||||
export type UpdateIssueNoteOptions = z.infer<typeof UpdateIssueNoteSchema>;
|
||||
export type CreateIssueNoteOptions = z.infer<typeof CreateIssueNoteSchema>;
|
||||
export type GitLabNamespace = z.infer<typeof GitLabNamespaceSchema>;
|
||||
export type GitLabNamespaceExistsResponse = z.infer<
|
||||
typeof GitLabNamespaceExistsResponseSchema
|
||||
>;
|
||||
export type GitLabNamespaceExistsResponse = z.infer<typeof GitLabNamespaceExistsResponseSchema>;
|
||||
export type GitLabProject = z.infer<typeof GitLabProjectSchema>;
|
||||
export type GitLabLabel = z.infer<typeof GitLabLabelSchema>;
|
||||
export type ListWikiPagesOptions = z.infer<typeof ListWikiPagesSchema>;
|
||||
@ -1320,3 +1308,16 @@ export type GitLabPipeline = z.infer<typeof GitLabPipelineSchema>;
|
||||
export type ListPipelinesOptions = z.infer<typeof ListPipelinesSchema>;
|
||||
export type GetPipelineOptions = z.infer<typeof GetPipelineSchema>;
|
||||
export type ListPipelineJobsOptions = z.infer<typeof ListPipelineJobsSchema>;
|
||||
export type CreatePipelineOptions = z.infer<typeof CreatePipelineSchema>;
|
||||
export type RetryPipelineOptions = z.infer<typeof RetryPipelineSchema>;
|
||||
export type CancelPipelineOptions = z.infer<typeof CancelPipelineSchema>;
|
||||
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 path from 'path';
|
||||
import { fileURLToPath } from 'url';
|
||||
import fs from "fs";
|
||||
import path from "path";
|
||||
import { fileURLToPath } from "url";
|
||||
|
||||
const __filename = fileURLToPath(import.meta.url);
|
||||
const __dirname = path.dirname(__filename);
|
||||
|
||||
async function main() {
|
||||
const repoRoot = path.resolve(__dirname, '..');
|
||||
const indexPath = path.join(repoRoot, 'index.ts');
|
||||
const readmePath = path.join(repoRoot, 'README.md');
|
||||
const repoRoot = path.resolve(__dirname, "..");
|
||||
const indexPath = path.join(repoRoot, "index.ts");
|
||||
const readmePath = path.join(repoRoot, "README.md");
|
||||
|
||||
// 1. Read index.ts
|
||||
const code = fs.readFileSync(indexPath, 'utf-8');
|
||||
const code = fs.readFileSync(indexPath, "utf-8");
|
||||
|
||||
// 2. Extract allTools array block
|
||||
const match = code.match(/const allTools = \[([\s\S]*?)\];/);
|
||||
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);
|
||||
}
|
||||
const toolsBlock = match[1];
|
||||
@ -33,18 +33,18 @@ async function main() {
|
||||
const lines = tools.map((tool, index) => {
|
||||
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
|
||||
const readme = fs.readFileSync(readmePath, 'utf-8');
|
||||
const readme = fs.readFileSync(readmePath, "utf-8");
|
||||
const updated = readme.replace(
|
||||
/<!-- TOOLS-START -->([\s\S]*?)<!-- TOOLS-END -->/,
|
||||
`<!-- TOOLS-START -->\n${markdown}\n<!-- TOOLS-END -->`
|
||||
);
|
||||
|
||||
// 6. Write back
|
||||
fs.writeFileSync(readmePath, updated, 'utf-8');
|
||||
console.log('README.md tools section updated.');
|
||||
fs.writeFileSync(readmePath, updated, "utf-8");
|
||||
console.log("README.md tools section updated.");
|
||||
}
|
||||
|
||||
main().catch(err => {
|
||||
|
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) {
|
||||
const errorBody = await response.text();
|
||||
throw new Error(
|
||||
`GitLab API error: ${response.status} ${response.statusText}\n${errorBody}`
|
||||
);
|
||||
throw new Error(`GitLab API error: ${response.status} ${response.statusText}\n${errorBody}`);
|
||||
}
|
||||
|
||||
const data = await response.json();
|
||||
|
154
test/validate-api.js
Executable file
154
test/validate-api.js
Executable file
@ -0,0 +1,154 @@
|
||||
#!/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),
|
||||
},
|
||||
{
|
||||
name: "List pipelines",
|
||||
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/pipelines?per_page=5`,
|
||||
validate: data => Array.isArray(data),
|
||||
},
|
||||
];
|
||||
|
||||
let allPassed = true;
|
||||
let firstPipelineId = null;
|
||||
|
||||
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`);
|
||||
|
||||
// If we found pipelines, save the first one for additional testing
|
||||
if (test.name === "List pipelines" && data.length > 0) {
|
||||
firstPipelineId = data[0].id;
|
||||
}
|
||||
} 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;
|
||||
}
|
||||
}
|
||||
|
||||
// Test pipeline-specific endpoints if we have a pipeline ID
|
||||
if (firstPipelineId) {
|
||||
console.log(`Found pipeline #${firstPipelineId}, testing pipeline-specific endpoints...\n`);
|
||||
|
||||
const pipelineTests = [
|
||||
{
|
||||
name: `Get pipeline #${firstPipelineId} details`,
|
||||
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/pipelines/${firstPipelineId}`,
|
||||
validate: data => data.id === firstPipelineId && data.status,
|
||||
},
|
||||
{
|
||||
name: `List pipeline #${firstPipelineId} jobs`,
|
||||
url: `${GITLAB_API_URL}/api/v4/projects/${encodeURIComponent(TEST_PROJECT_ID)}/pipelines/${firstPipelineId}/jobs`,
|
||||
validate: data => Array.isArray(data),
|
||||
},
|
||||
];
|
||||
|
||||
for (const test of pipelineTests) {
|
||||
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