Compare commits
20 Commits
Author | SHA1 | Date | |
---|---|---|---|
cdf4697ef1 | |||
3c23675eec | |||
8df87c67d2 | |||
d318f9ea5e | |||
ed032bad48 | |||
5200cc526c | |||
1ba54342bc | |||
29659db0b7 | |||
44d8d11b4a | |||
622c112f7f | |||
0930ce3636 | |||
061e19d861 | |||
511d2d9c06 | |||
8cb7703aa1 | |||
5e254836e8 | |||
93710f2846 | |||
f3854126ac | |||
c07356bd46 | |||
c82be8c94f | |||
cd8f0e5525 |
32
CHANGELOG.md
32
CHANGELOG.md
@ -1,8 +1,40 @@
|
||||
## [1.0.62] - 2025-06-10
|
||||
|
||||
### Fixed
|
||||
|
||||
- 🔐 **Private Token Authentication Fix**: Fixed Private-Token header authentication for GitLab API
|
||||
- Removed incorrect `Bearer ` prefix from Private-Token header in legacy authentication mode
|
||||
- Fixed authentication issues when using older GitLab instances with private tokens
|
||||
- Ensures proper API authentication for both new and legacy GitLab configurations
|
||||
- See: [PR #91](https://github.com/zereight/gitlab-mcp/pull/91), [Issue #88](https://github.com/zereight/gitlab-mcp/issues/88)
|
||||
|
||||
---
|
||||
|
||||
## [1.0.60] - 2025-06-07
|
||||
|
||||
### Added
|
||||
|
||||
- 📄 **Merge Request Enhancement**: Added support for `remove_source_branch` and `squash` options for merge requests
|
||||
- Enhanced merge request functionality with additional configuration options
|
||||
- Allows automatic source branch removal after merge
|
||||
- Supports squash commits for cleaner Git history
|
||||
- See: [PR #86](https://github.com/zereight/gitlab-mcp/pull/86)
|
||||
|
||||
### Fixed
|
||||
|
||||
- 🔧 **Issue Assignment Fix**: Fixed list issues assignee username handling
|
||||
- Corrected assignee username field in issue listing functionality
|
||||
- Improved user assignment data processing for GitLab issues
|
||||
- See: [PR #87](https://github.com/zereight/gitlab-mcp/pull/87), [Issue #74](https://github.com/zereight/gitlab-mcp/issues/74)
|
||||
|
||||
---
|
||||
|
||||
## [1.0.54] - 2025-05-31
|
||||
|
||||
### Added
|
||||
|
||||
- 🌐 **Multi-Platform Support**: Added support for multiple platforms to improve compatibility across different environments
|
||||
|
||||
- Enhanced platform detection and configuration handling
|
||||
- Improved cross-platform functionality for GitLab MCP server
|
||||
- See: [PR #71](https://github.com/zereight/gitlab-mcp/pull/71), [Issue #69](https://github.com/zereight/gitlab-mcp/issues/69)
|
||||
|
@ -84,7 +84,7 @@ docker run -i --rm \
|
||||
-e USE_PIPELINE=true \
|
||||
-e SSE=true \
|
||||
-p 3333:3002 \
|
||||
gitlab-mcp
|
||||
iwakitakuma/gitlab-mcp
|
||||
```
|
||||
|
||||
```json
|
||||
|
11
RELEASE_NOTES.md
Normal file
11
RELEASE_NOTES.md
Normal file
@ -0,0 +1,11 @@
|
||||
## [1.0.62] - 2025-06-10
|
||||
|
||||
### Fixed
|
||||
|
||||
- 🔐 **Private Token Authentication Fix**: Fixed Private-Token header authentication for GitLab API
|
||||
- Removed incorrect `Bearer ` prefix from Private-Token header in legacy authentication mode
|
||||
- Fixed authentication issues when using older GitLab instances with private tokens
|
||||
- Ensures proper API authentication for both new and legacy GitLab configurations
|
||||
- See: [PR #91](https://github.com/zereight/gitlab-mcp/pull/91), [Issue #88](https://github.com/zereight/gitlab-mcp/issues/88)
|
||||
|
||||
---
|
373
index.ts
373
index.ts
@ -17,7 +17,7 @@ import path from "path";
|
||||
import express, { Request, Response } from "express";
|
||||
// Add type imports for proxy agents
|
||||
import { Agent } from "http";
|
||||
import { Agent as HttpsAgent } from 'https';
|
||||
import { Agent as HttpsAgent } from "https";
|
||||
import { URL } from "url";
|
||||
|
||||
import {
|
||||
@ -100,6 +100,7 @@ import {
|
||||
// Discussion Schemas
|
||||
GitLabDiscussionNoteSchema, // Added
|
||||
GitLabDiscussionSchema,
|
||||
PaginatedDiscussionsResponseSchema,
|
||||
UpdateMergeRequestNoteSchema, // Added
|
||||
CreateMergeRequestNoteSchema, // Added
|
||||
ListMergeRequestDiscussionsSchema,
|
||||
@ -142,8 +143,10 @@ import {
|
||||
type PromoteProjectMilestoneOptions,
|
||||
type GetMilestoneBurndownEventsOptions,
|
||||
// Discussion Types
|
||||
type GitLabDiscussionNote, // Added
|
||||
type GitLabDiscussionNote,
|
||||
type GitLabDiscussion,
|
||||
type PaginatedDiscussionsResponse,
|
||||
type PaginationOptions,
|
||||
type MergeRequestThreadPosition,
|
||||
type GetWikiPageOptions,
|
||||
type CreateWikiPageOptions,
|
||||
@ -168,6 +171,13 @@ import {
|
||||
GitLabCompareResult,
|
||||
GitLabCompareResultSchema,
|
||||
GetBranchDiffsSchema,
|
||||
ListWikiPagesOptions,
|
||||
ListCommitsSchema,
|
||||
GetCommitSchema,
|
||||
GetCommitDiffSchema,
|
||||
type ListCommitsOptions,
|
||||
type GetCommitOptions,
|
||||
type GetCommitDiffOptions,
|
||||
} from "./schemas.js";
|
||||
|
||||
/**
|
||||
@ -183,7 +193,7 @@ try {
|
||||
SERVER_VERSION = packageJson.version || SERVER_VERSION;
|
||||
}
|
||||
} catch (error) {
|
||||
console.error("Warning: Could not read version from package.json:", error);
|
||||
// Warning: Could not read version from package.json - silently continue
|
||||
}
|
||||
|
||||
const server = new Server(
|
||||
@ -199,6 +209,7 @@ const server = new Server(
|
||||
);
|
||||
|
||||
const GITLAB_PERSONAL_ACCESS_TOKEN = process.env.GITLAB_PERSONAL_ACCESS_TOKEN;
|
||||
const IS_OLD = process.env.GITLAB_IS_OLD === "true";
|
||||
const GITLAB_READ_ONLY_MODE = process.env.GITLAB_READ_ONLY_MODE === "true";
|
||||
const USE_GITLAB_WIKI = process.env.USE_GITLAB_WIKI === "true";
|
||||
const USE_MILESTONE = process.env.USE_MILESTONE === "true";
|
||||
@ -211,8 +222,8 @@ const HTTPS_PROXY = process.env.HTTPS_PROXY;
|
||||
const NODE_TLS_REJECT_UNAUTHORIZED = process.env.NODE_TLS_REJECT_UNAUTHORIZED;
|
||||
const GITLAB_CA_CERT_PATH = process.env.GITLAB_CA_CERT_PATH;
|
||||
|
||||
let sslOptions= undefined;
|
||||
if (NODE_TLS_REJECT_UNAUTHORIZED === '0') {
|
||||
let sslOptions = undefined;
|
||||
if (NODE_TLS_REJECT_UNAUTHORIZED === "0") {
|
||||
sslOptions = { rejectUnauthorized: false };
|
||||
} else if (GITLAB_CA_CERT_PATH) {
|
||||
const ca = fs.readFileSync(GITLAB_CA_CERT_PATH);
|
||||
@ -241,11 +252,15 @@ httpsAgent = httpsAgent || new HttpsAgent(sslOptions);
|
||||
httpAgent = httpAgent || new Agent();
|
||||
|
||||
// Modify DEFAULT_HEADERS to include agent configuration
|
||||
const DEFAULT_HEADERS = {
|
||||
const DEFAULT_HEADERS: Record<string, string> = {
|
||||
Accept: "application/json",
|
||||
"Content-Type": "application/json",
|
||||
Authorization: `Bearer ${GITLAB_PERSONAL_ACCESS_TOKEN}`,
|
||||
};
|
||||
if (IS_OLD) {
|
||||
DEFAULT_HEADERS["Private-Token"] = `${GITLAB_PERSONAL_ACCESS_TOKEN}`;
|
||||
} else {
|
||||
DEFAULT_HEADERS["Authorization"] = `Bearer ${GITLAB_PERSONAL_ACCESS_TOKEN}`;
|
||||
}
|
||||
|
||||
// Create a default fetch configuration object that includes proxy agents if set
|
||||
const DEFAULT_FETCH_CONFIG = {
|
||||
@ -319,8 +334,7 @@ const allTools = [
|
||||
},
|
||||
{
|
||||
name: "get_branch_diffs",
|
||||
description:
|
||||
"Get the changes/diffs between two branches or commits in a GitLab project",
|
||||
description: "Get the changes/diffs between two branches or commits in a GitLab project",
|
||||
inputSchema: zodToJsonSchema(GetBranchDiffsSchema),
|
||||
},
|
||||
{
|
||||
@ -588,6 +602,21 @@ const allTools = [
|
||||
description: "Get GitLab user details by usernames",
|
||||
inputSchema: zodToJsonSchema(GetUsersSchema),
|
||||
},
|
||||
{
|
||||
name: "list_commits",
|
||||
description: "List repository commits with filtering options",
|
||||
inputSchema: zodToJsonSchema(ListCommitsSchema),
|
||||
},
|
||||
{
|
||||
name: "get_commit",
|
||||
description: "Get details of a specific commit",
|
||||
inputSchema: zodToJsonSchema(GetCommitSchema),
|
||||
},
|
||||
{
|
||||
name: "get_commit_diff",
|
||||
description: "Get changes/diffs of a specific commit",
|
||||
inputSchema: zodToJsonSchema(GetCommitDiffSchema),
|
||||
},
|
||||
];
|
||||
|
||||
// Define which tools are read-only
|
||||
@ -626,6 +655,9 @@ const readOnlyTools = [
|
||||
"list_wiki_pages",
|
||||
"get_wiki_page",
|
||||
"get_users",
|
||||
"list_commits",
|
||||
"get_commit",
|
||||
"get_commit_diff",
|
||||
];
|
||||
|
||||
// Define which tools are related to wiki and can be toggled by USE_GITLAB_WIKI
|
||||
@ -903,13 +935,18 @@ async function listIssues(
|
||||
// Add all query parameters
|
||||
Object.entries(options).forEach(([key, value]) => {
|
||||
if (value !== undefined) {
|
||||
if (key === "labels" && Array.isArray(value)) {
|
||||
const keys = ["labels", "assignee_username"];
|
||||
if (keys.includes(key)) {
|
||||
if (Array.isArray(value)) {
|
||||
// Handle array of labels
|
||||
value.forEach(label => {
|
||||
url.searchParams.append("labels[]", label.toString());
|
||||
url.searchParams.append(`${key}[]`, label.toString());
|
||||
});
|
||||
} else {
|
||||
url.searchParams.append("labels[]", value.toString());
|
||||
url.searchParams.append(`${key}[]`, value.toString());
|
||||
}
|
||||
} else {
|
||||
url.searchParams.append(key, value.toString());
|
||||
}
|
||||
}
|
||||
});
|
||||
@ -1191,6 +1228,8 @@ async function createMergeRequest(
|
||||
labels: options.labels?.join(","),
|
||||
allow_collaboration: options.allow_collaboration,
|
||||
draft: options.draft,
|
||||
remove_source_branch: options.remove_source_branch,
|
||||
squash: options.squash,
|
||||
}),
|
||||
});
|
||||
|
||||
@ -1209,55 +1248,26 @@ async function createMergeRequest(
|
||||
}
|
||||
|
||||
/**
|
||||
* List merge request discussion items
|
||||
* 병합 요청 토론 목록 조회
|
||||
* Shared helper function for listing discussions
|
||||
* 토론 목록 조회를 위한 공유 헬퍼 함수
|
||||
*
|
||||
* @param {string} projectId - The ID or URL-encoded path of the project
|
||||
* @param {number} mergeRequestIid - The IID of a merge request
|
||||
* @returns {Promise<GitLabDiscussion[]>} List of discussions
|
||||
* @param {"issues" | "merge_requests"} resourceType - The type of resource (issues or merge_requests)
|
||||
* @param {number} resourceIid - The IID of the issue or merge request
|
||||
* @param {PaginationOptions} options - Pagination and sorting options
|
||||
* @returns {Promise<PaginatedDiscussionsResponse>} Paginated list of discussions
|
||||
*/
|
||||
async function listMergeRequestDiscussions(
|
||||
async function listDiscussions(
|
||||
projectId: string,
|
||||
mergeRequestIid: number
|
||||
): Promise<GitLabDiscussion[]> {
|
||||
resourceType: "issues" | "merge_requests",
|
||||
resourceIid: number,
|
||||
options: PaginationOptions = {}
|
||||
): Promise<PaginatedDiscussionsResponse> {
|
||||
projectId = decodeURIComponent(projectId); // Decode project ID
|
||||
const url = new URL(
|
||||
`${GITLAB_API_URL}/projects/${encodeURIComponent(
|
||||
projectId
|
||||
)}/merge_requests/${mergeRequestIid}/discussions`
|
||||
);
|
||||
|
||||
const response = await fetch(url.toString(), {
|
||||
...DEFAULT_FETCH_CONFIG,
|
||||
});
|
||||
|
||||
await handleGitLabError(response);
|
||||
const data = await response.json();
|
||||
// Ensure the response is parsed as an array of discussions
|
||||
return z.array(GitLabDiscussionSchema).parse(data);
|
||||
}
|
||||
|
||||
/**
|
||||
* List discussions for an issue
|
||||
*
|
||||
* @param {string} projectId - The ID or URL-encoded path of the project
|
||||
* @param {number} issueIid - The internal ID of the project issue
|
||||
* @param {Object} options - Pagination and sorting options
|
||||
* @returns {Promise<GitLabDiscussion[]>} List of issue discussions
|
||||
*/
|
||||
async function listIssueDiscussions(
|
||||
projectId: string,
|
||||
issueIid: number,
|
||||
options: {
|
||||
page?: number;
|
||||
per_page?: number;
|
||||
sort?: "asc" | "desc";
|
||||
order_by?: "created_at" | "updated_at";
|
||||
} = {}
|
||||
): Promise<GitLabDiscussion[]> {
|
||||
projectId = decodeURIComponent(projectId); // Decode project ID
|
||||
const url = new URL(
|
||||
`${GITLAB_API_URL}/projects/${encodeURIComponent(projectId)}/issues/${issueIid}/discussions`
|
||||
)}/${resourceType}/${resourceIid}/discussions`
|
||||
);
|
||||
|
||||
// Add query parameters for pagination and sorting
|
||||
@ -1267,22 +1277,69 @@ async function listIssueDiscussions(
|
||||
if (options.per_page) {
|
||||
url.searchParams.append("per_page", options.per_page.toString());
|
||||
}
|
||||
if (options.sort) {
|
||||
url.searchParams.append("sort", options.sort);
|
||||
}
|
||||
if (options.order_by) {
|
||||
url.searchParams.append("order_by", options.order_by);
|
||||
}
|
||||
|
||||
const response = await fetch(url.toString(), {
|
||||
...DEFAULT_FETCH_CONFIG,
|
||||
});
|
||||
|
||||
await handleGitLabError(response);
|
||||
const data = await response.json();
|
||||
const discussions = await response.json();
|
||||
|
||||
// Parse the response as an array of discussions
|
||||
return z.array(GitLabDiscussionSchema).parse(data);
|
||||
// Extract pagination headers
|
||||
const pagination = {
|
||||
x_next_page: response.headers.get("x-next-page")
|
||||
? parseInt(response.headers.get("x-next-page")!)
|
||||
: null,
|
||||
x_page: response.headers.get("x-page") ? parseInt(response.headers.get("x-page")!) : undefined,
|
||||
x_per_page: response.headers.get("x-per-page")
|
||||
? parseInt(response.headers.get("x-per-page")!)
|
||||
: undefined,
|
||||
x_prev_page: response.headers.get("x-prev-page")
|
||||
? parseInt(response.headers.get("x-prev-page")!)
|
||||
: null,
|
||||
x_total: response.headers.get("x-total") ? parseInt(response.headers.get("x-total")!) : null,
|
||||
x_total_pages: response.headers.get("x-total-pages")
|
||||
? parseInt(response.headers.get("x-total-pages")!)
|
||||
: null,
|
||||
};
|
||||
|
||||
return PaginatedDiscussionsResponseSchema.parse({
|
||||
items: discussions,
|
||||
pagination: pagination,
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* List merge request discussion items
|
||||
* 병합 요청 토론 목록 조회
|
||||
*
|
||||
* @param {string} projectId - The ID or URL-encoded path of the project
|
||||
* @param {number} mergeRequestIid - The IID of a merge request
|
||||
* @param {DiscussionPaginationOptions} options - Pagination and sorting options
|
||||
* @returns {Promise<GitLabDiscussion[]>} List of discussions
|
||||
*/
|
||||
async function listMergeRequestDiscussions(
|
||||
projectId: string,
|
||||
mergeRequestIid: number,
|
||||
options: PaginationOptions = {}
|
||||
): Promise<PaginatedDiscussionsResponse> {
|
||||
return listDiscussions(projectId, "merge_requests", mergeRequestIid, options);
|
||||
}
|
||||
|
||||
/**
|
||||
* List discussions for an issue
|
||||
*
|
||||
* @param {string} projectId - The ID or URL-encoded path of the project
|
||||
* @param {number} issueIid - The internal ID of the project issue
|
||||
* @param {DiscussionPaginationOptions} options - Pagination and sorting options
|
||||
* @returns {Promise<GitLabDiscussion[]>} List of issue discussions
|
||||
*/
|
||||
async function listIssueDiscussions(
|
||||
projectId: string,
|
||||
issueIid: number,
|
||||
options: PaginationOptions = {}
|
||||
): Promise<PaginatedDiscussionsResponse> {
|
||||
return listDiscussions(projectId, "issues", issueIid, options);
|
||||
}
|
||||
|
||||
/**
|
||||
@ -1838,9 +1895,7 @@ async function getBranchDiffs(
|
||||
|
||||
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();
|
||||
@ -2363,12 +2418,14 @@ async function listGroupProjects(
|
||||
*/
|
||||
async function listWikiPages(
|
||||
projectId: string,
|
||||
options: Omit<z.infer<typeof ListWikiPagesSchema>, "project_id"> = {}
|
||||
options: Omit<ListWikiPagesOptions, "project_id"> = {}
|
||||
): Promise<GitLabWikiPage[]> {
|
||||
projectId = decodeURIComponent(projectId); // Decode project ID
|
||||
const url = new URL(`${GITLAB_API_URL}/projects/${encodeURIComponent(projectId)}/wikis`);
|
||||
if (options.page) url.searchParams.append("page", options.page.toString());
|
||||
if (options.per_page) url.searchParams.append("per_page", options.per_page.toString());
|
||||
if (options.with_content)
|
||||
url.searchParams.append("with_content", options.with_content.toString());
|
||||
const response = await fetch(url.toString(), {
|
||||
...DEFAULT_FETCH_CONFIG,
|
||||
});
|
||||
@ -2620,10 +2677,13 @@ async function createPipeline(
|
||||
|
||||
const body: any = { ref };
|
||||
if (variables && variables.length > 0) {
|
||||
body.variables = variables.reduce((acc, { key, value }) => {
|
||||
body.variables = variables.reduce(
|
||||
(acc, { key, value }) => {
|
||||
acc[key] = value;
|
||||
return acc;
|
||||
}, {} as Record<string, string>);
|
||||
},
|
||||
{} as Record<string, string>
|
||||
);
|
||||
}
|
||||
|
||||
const response = await fetch(url.toString(), {
|
||||
@ -2699,15 +2759,20 @@ async function getRepositoryTree(options: GetRepositoryTreeOptions): Promise<Git
|
||||
if (options.page_token) queryParams.append("page_token", options.page_token);
|
||||
if (options.pagination) queryParams.append("pagination", options.pagination);
|
||||
|
||||
const headers: Record<string, string> = {
|
||||
"Content-Type": "application/json",
|
||||
};
|
||||
if (IS_OLD) {
|
||||
headers["Private-Token"] = `${GITLAB_PERSONAL_ACCESS_TOKEN}`;
|
||||
} else {
|
||||
headers["Authorization"] = `Bearer ${GITLAB_PERSONAL_ACCESS_TOKEN}`;
|
||||
}
|
||||
const response = await fetch(
|
||||
`${GITLAB_API_URL}/projects/${encodeURIComponent(
|
||||
options.project_id
|
||||
)}/repository/tree?${queryParams.toString()}`,
|
||||
{
|
||||
headers: {
|
||||
Authorization: `Bearer ${GITLAB_PERSONAL_ACCESS_TOKEN}`,
|
||||
"Content-Type": "application/json",
|
||||
},
|
||||
headers,
|
||||
}
|
||||
);
|
||||
|
||||
@ -2998,6 +3063,107 @@ async function getUsers(usernames: string[]): Promise<GitLabUsersResponse> {
|
||||
return GitLabUsersResponseSchema.parse(users);
|
||||
}
|
||||
|
||||
/**
|
||||
* List repository commits
|
||||
* 저장소 커밋 목록 조회
|
||||
*
|
||||
* @param {string} projectId - Project ID or URL-encoded path
|
||||
* @param {ListCommitsOptions} options - List commits options
|
||||
* @returns {Promise<GitLabCommit[]>} List of commits
|
||||
*/
|
||||
async function listCommits(
|
||||
projectId: string,
|
||||
options: Omit<ListCommitsOptions, "project_id"> = {}
|
||||
): Promise<GitLabCommit[]> {
|
||||
projectId = decodeURIComponent(projectId);
|
||||
const url = new URL(
|
||||
`${GITLAB_API_URL}/projects/${encodeURIComponent(projectId)}/repository/commits`
|
||||
);
|
||||
|
||||
// Add query parameters
|
||||
if (options.ref_name) url.searchParams.append("ref_name", options.ref_name);
|
||||
if (options.since) url.searchParams.append("since", options.since);
|
||||
if (options.until) url.searchParams.append("until", options.until);
|
||||
if (options.path) url.searchParams.append("path", options.path);
|
||||
if (options.author) url.searchParams.append("author", options.author);
|
||||
if (options.all) url.searchParams.append("all", options.all.toString());
|
||||
if (options.with_stats) url.searchParams.append("with_stats", options.with_stats.toString());
|
||||
if (options.first_parent) url.searchParams.append("first_parent", options.first_parent.toString());
|
||||
if (options.order) url.searchParams.append("order", options.order);
|
||||
if (options.trailers) url.searchParams.append("trailers", options.trailers.toString());
|
||||
if (options.page) url.searchParams.append("page", options.page.toString());
|
||||
if (options.per_page) url.searchParams.append("per_page", options.per_page.toString());
|
||||
|
||||
const response = await fetch(url.toString(), {
|
||||
...DEFAULT_FETCH_CONFIG,
|
||||
});
|
||||
|
||||
await handleGitLabError(response);
|
||||
|
||||
const data = await response.json();
|
||||
return z.array(GitLabCommitSchema).parse(data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a single commit
|
||||
* 단일 커밋 정보 조회
|
||||
*
|
||||
* @param {string} projectId - Project ID or URL-encoded path
|
||||
* @param {string} sha - The commit hash or name of a repository branch or tag
|
||||
* @param {boolean} [stats] - Include commit stats
|
||||
* @returns {Promise<GitLabCommit>} The commit details
|
||||
*/
|
||||
async function getCommit(
|
||||
projectId: string,
|
||||
sha: string,
|
||||
stats?: boolean
|
||||
): Promise<GitLabCommit> {
|
||||
projectId = decodeURIComponent(projectId);
|
||||
const url = new URL(
|
||||
`${GITLAB_API_URL}/projects/${encodeURIComponent(projectId)}/repository/commits/${encodeURIComponent(sha)}`
|
||||
);
|
||||
|
||||
if (stats) {
|
||||
url.searchParams.append("stats", "true");
|
||||
}
|
||||
|
||||
const response = await fetch(url.toString(), {
|
||||
...DEFAULT_FETCH_CONFIG,
|
||||
});
|
||||
|
||||
await handleGitLabError(response);
|
||||
|
||||
const data = await response.json();
|
||||
return GitLabCommitSchema.parse(data);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get commit diff
|
||||
* 커밋 변경사항 조회
|
||||
*
|
||||
* @param {string} projectId - Project ID or URL-encoded path
|
||||
* @param {string} sha - The commit hash or name of a repository branch or tag
|
||||
* @returns {Promise<GitLabMergeRequestDiff[]>} The commit diffs
|
||||
*/
|
||||
async function getCommitDiff(
|
||||
projectId: string,
|
||||
sha: string
|
||||
): Promise<GitLabMergeRequestDiff[]> {
|
||||
projectId = decodeURIComponent(projectId);
|
||||
const url = new URL(
|
||||
`${GITLAB_API_URL}/projects/${encodeURIComponent(projectId)}/repository/commits/${encodeURIComponent(sha)}/diff`
|
||||
);
|
||||
|
||||
const response = await fetch(url.toString(), {
|
||||
...DEFAULT_FETCH_CONFIG,
|
||||
});
|
||||
|
||||
await handleGitLabError(response);
|
||||
|
||||
const data = await response.json();
|
||||
return z.array(GitLabDiffSchema).parse(data);
|
||||
}
|
||||
|
||||
server.setRequestHandler(ListToolsRequestSchema, async () => {
|
||||
// Apply read-only filter first
|
||||
const tools0 = GITLAB_READ_ONLY_MODE
|
||||
@ -3012,9 +3178,7 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
|
||||
? tools1
|
||||
: tools1.filter(tool => !milestoneToolNames.includes(tool.name));
|
||||
// Toggle pipeline tools by USE_PIPELINE flag
|
||||
let tools = USE_PIPELINE
|
||||
? tools2
|
||||
: tools2.filter(tool => !pipelineToolNames.includes(tool.name));
|
||||
let tools = USE_PIPELINE ? tools2 : tools2.filter(tool => !pipelineToolNames.includes(tool.name));
|
||||
|
||||
// <<< START: Gemini 호환성을 위해 $schema 제거 >>>
|
||||
tools = tools.map(tool => {
|
||||
@ -3088,12 +3252,7 @@ server.setRequestHandler(CallToolRequestSchema, async request => {
|
||||
|
||||
case "get_branch_diffs": {
|
||||
const args = GetBranchDiffsSchema.parse(request.params.arguments);
|
||||
const diffResp = await getBranchDiffs(
|
||||
args.project_id,
|
||||
args.from,
|
||||
args.to,
|
||||
args.straight
|
||||
);
|
||||
const diffResp = await getBranchDiffs(args.project_id, args.from, args.to, args.straight);
|
||||
|
||||
if (args.excluded_file_patterns?.length) {
|
||||
const regexPatterns = args.excluded_file_patterns.map(pattern => new RegExp(pattern));
|
||||
@ -3105,9 +3264,7 @@ server.setRequestHandler(CallToolRequestSchema, async request => {
|
||||
};
|
||||
|
||||
// Filter out files that match any of the regex patterns on new files
|
||||
diffResp.diffs = diffResp.diffs.filter(diff =>
|
||||
!matchesAnyPattern(diff.new_path)
|
||||
);
|
||||
diffResp.diffs = diffResp.diffs.filter(diff => !matchesAnyPattern(diff.new_path));
|
||||
}
|
||||
return {
|
||||
content: [{ type: "text", text: JSON.stringify(diffResp, null, 2) }],
|
||||
@ -3284,9 +3441,11 @@ server.setRequestHandler(CallToolRequestSchema, async request => {
|
||||
|
||||
case "mr_discussions": {
|
||||
const args = ListMergeRequestDiscussionsSchema.parse(request.params.arguments);
|
||||
const { project_id, merge_request_iid, ...options } = args;
|
||||
const discussions = await listMergeRequestDiscussions(
|
||||
args.project_id,
|
||||
args.merge_request_iid
|
||||
project_id,
|
||||
merge_request_iid,
|
||||
options
|
||||
);
|
||||
return {
|
||||
content: [{ type: "text", text: JSON.stringify(discussions, null, 2) }],
|
||||
@ -3582,8 +3741,10 @@ server.setRequestHandler(CallToolRequestSchema, async request => {
|
||||
}
|
||||
|
||||
case "list_wiki_pages": {
|
||||
const { project_id, page, per_page } = ListWikiPagesSchema.parse(request.params.arguments);
|
||||
const wikiPages = await listWikiPages(project_id, { page, per_page });
|
||||
const { project_id, page, per_page, with_content } = ListWikiPagesSchema.parse(
|
||||
request.params.arguments
|
||||
);
|
||||
const wikiPages = await listWikiPages(project_id, { page, per_page, with_content });
|
||||
return {
|
||||
content: [{ type: "text", text: JSON.stringify(wikiPages, null, 2) }],
|
||||
};
|
||||
@ -3897,6 +4058,30 @@ server.setRequestHandler(CallToolRequestSchema, async request => {
|
||||
};
|
||||
}
|
||||
|
||||
case "list_commits": {
|
||||
const args = ListCommitsSchema.parse(request.params.arguments);
|
||||
const commits = await listCommits(args.project_id, args);
|
||||
return {
|
||||
content: [{ type: "text", text: JSON.stringify(commits, null, 2) }],
|
||||
};
|
||||
}
|
||||
|
||||
case "get_commit": {
|
||||
const args = GetCommitSchema.parse(request.params.arguments);
|
||||
const commit = await getCommit(args.project_id, args.sha, args.stats);
|
||||
return {
|
||||
content: [{ type: "text", text: JSON.stringify(commit, null, 2) }],
|
||||
};
|
||||
}
|
||||
|
||||
case "get_commit_diff": {
|
||||
const args = GetCommitDiffSchema.parse(request.params.arguments);
|
||||
const diff = await getCommitDiff(args.project_id, args.sha);
|
||||
return {
|
||||
content: [{ type: "text", text: JSON.stringify(diff, null, 2) }],
|
||||
};
|
||||
}
|
||||
|
||||
default:
|
||||
throw new Error(`Unknown tool: ${request.params.name}`);
|
||||
}
|
||||
@ -3918,12 +4103,11 @@ server.setRequestHandler(CallToolRequestSchema, async request => {
|
||||
*/
|
||||
async function runServer() {
|
||||
try {
|
||||
console.error("========================");
|
||||
console.error(`GitLab MCP Server v${SERVER_VERSION}`);
|
||||
console.error(`API URL: ${GITLAB_API_URL}`);
|
||||
console.error("========================");
|
||||
if ( !SSE )
|
||||
{
|
||||
// Server startup banner removed - inappropriate use of console.error for logging
|
||||
// Server version banner removed - inappropriate use of console.error for logging
|
||||
// API URL banner removed - inappropriate use of console.error for logging
|
||||
// Server startup banner removed - inappropriate use of console.error for logging
|
||||
if (!SSE) {
|
||||
const transport = new StdioServerTransport();
|
||||
await server.connect(transport);
|
||||
} else {
|
||||
@ -3953,7 +4137,6 @@ async function runServer() {
|
||||
console.log(`Server is running on port ${PORT}`);
|
||||
});
|
||||
}
|
||||
console.error("GitLab MCP Server running on stdio");
|
||||
} catch (error) {
|
||||
console.error("Error initializing server:", error);
|
||||
process.exit(1);
|
||||
|
201
package-lock.json
generated
201
package-lock.json
generated
@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "@zereight/mcp-gitlab",
|
||||
"version": "1.0.56",
|
||||
"version": "1.0.60",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@zereight/mcp-gitlab",
|
||||
"version": "1.0.56",
|
||||
"version": "1.0.60",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@modelcontextprotocol/sdk": "1.8.0",
|
||||
@ -27,6 +27,7 @@
|
||||
"@types/node": "^22.13.10",
|
||||
"@typescript-eslint/eslint-plugin": "^8.21.0",
|
||||
"@typescript-eslint/parser": "^8.21.0",
|
||||
"auto-changelog": "^2.4.0",
|
||||
"eslint": "^9.18.0",
|
||||
"prettier": "^3.4.2",
|
||||
"ts-node": "^10.9.2",
|
||||
@ -889,6 +890,48 @@
|
||||
"integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==",
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/auto-changelog": {
|
||||
"version": "2.5.0",
|
||||
"resolved": "https://registry.npmjs.org/auto-changelog/-/auto-changelog-2.5.0.tgz",
|
||||
"integrity": "sha512-UTnLjT7I9U2U/xkCUH5buDlp8C7g0SGChfib+iDrJkamcj5kaMqNKHNfbKJw1kthJUq8sUo3i3q2S6FzO/l/wA==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"commander": "^7.2.0",
|
||||
"handlebars": "^4.7.7",
|
||||
"import-cwd": "^3.0.0",
|
||||
"node-fetch": "^2.6.1",
|
||||
"parse-github-url": "^1.0.3",
|
||||
"semver": "^7.3.5"
|
||||
},
|
||||
"bin": {
|
||||
"auto-changelog": "src/index.js"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=8.3"
|
||||
}
|
||||
},
|
||||
"node_modules/auto-changelog/node_modules/node-fetch": {
|
||||
"version": "2.7.0",
|
||||
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.7.0.tgz",
|
||||
"integrity": "sha512-c4FRfUm/dbcWZ7U+1Wq0AwCyFL+3nt2bEw05wfxSz+DWpWsitgmSgYmy2dQdWyKC1694ELPqMs/YzUSNozLt8A==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"whatwg-url": "^5.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": "4.x || >=6.0.0"
|
||||
},
|
||||
"peerDependencies": {
|
||||
"encoding": "^0.1.0"
|
||||
},
|
||||
"peerDependenciesMeta": {
|
||||
"encoding": {
|
||||
"optional": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"node_modules/balanced-match": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.2.tgz",
|
||||
@ -1036,6 +1079,16 @@
|
||||
"node": ">= 0.8"
|
||||
}
|
||||
},
|
||||
"node_modules/commander": {
|
||||
"version": "7.2.0",
|
||||
"resolved": "https://registry.npmjs.org/commander/-/commander-7.2.0.tgz",
|
||||
"integrity": "sha512-QrWXB+ZQSVPmIWIhtEO9H+gwHaMGYiF5ChvoJ+K9ZGHG/sVsa6yiesAD1GC/x46sET00Xlwo1u49RVVVzvcSkw==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">= 10"
|
||||
}
|
||||
},
|
||||
"node_modules/concat-map": {
|
||||
"version": "0.0.1",
|
||||
"resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz",
|
||||
@ -1894,6 +1947,28 @@
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/handlebars": {
|
||||
"version": "4.7.8",
|
||||
"resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.7.8.tgz",
|
||||
"integrity": "sha512-vafaFqs8MZkRrSX7sFVUdo3ap/eNiLnb4IakshzvP56X5Nr1iGKAIqdX6tMlm6HcNRIkr6AxO5jFEoJzzpT8aQ==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"minimist": "^1.2.5",
|
||||
"neo-async": "^2.6.2",
|
||||
"source-map": "^0.6.1",
|
||||
"wordwrap": "^1.0.0"
|
||||
},
|
||||
"bin": {
|
||||
"handlebars": "bin/handlebars"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=0.4.7"
|
||||
},
|
||||
"optionalDependencies": {
|
||||
"uglify-js": "^3.1.4"
|
||||
}
|
||||
},
|
||||
"node_modules/has-flag": {
|
||||
"version": "4.0.0",
|
||||
"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz",
|
||||
@ -2007,6 +2082,19 @@
|
||||
"node": ">= 4"
|
||||
}
|
||||
},
|
||||
"node_modules/import-cwd": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/import-cwd/-/import-cwd-3.0.0.tgz",
|
||||
"integrity": "sha512-4pnzH16plW+hgvRECbDWpQl3cqtvSofHWh44met7ESfZ8UZOWWddm8hEyDTqREJ9RbYHY8gi8DqmaelApoOGMg==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"import-from": "^3.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=8"
|
||||
}
|
||||
},
|
||||
"node_modules/import-fresh": {
|
||||
"version": "3.3.1",
|
||||
"resolved": "https://registry.npmjs.org/import-fresh/-/import-fresh-3.3.1.tgz",
|
||||
@ -2024,6 +2112,29 @@
|
||||
"url": "https://github.com/sponsors/sindresorhus"
|
||||
}
|
||||
},
|
||||
"node_modules/import-from": {
|
||||
"version": "3.0.0",
|
||||
"resolved": "https://registry.npmjs.org/import-from/-/import-from-3.0.0.tgz",
|
||||
"integrity": "sha512-CiuXOFFSzkU5x/CR0+z7T91Iht4CXgfCxVOFRhh2Zyhg5wOpWvvDLQUsWl+gcN+QscYBjez8hDCt85O7RLDttQ==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"resolve-from": "^5.0.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=8"
|
||||
}
|
||||
},
|
||||
"node_modules/import-from/node_modules/resolve-from": {
|
||||
"version": "5.0.0",
|
||||
"resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz",
|
||||
"integrity": "sha512-qYg9KP24dD5qka9J47d0aVky0N+b4fTU89LN9iDnjB5waksiC49rvMB0PrUJQGoTmH50XPiqOvAjDfaijGxYZw==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"engines": {
|
||||
"node": ">=8"
|
||||
}
|
||||
},
|
||||
"node_modules/imurmurhash": {
|
||||
"version": "0.1.4",
|
||||
"resolved": "https://registry.npmjs.org/imurmurhash/-/imurmurhash-0.1.4.tgz",
|
||||
@ -2292,6 +2403,16 @@
|
||||
"url": "https://github.com/sponsors/isaacs"
|
||||
}
|
||||
},
|
||||
"node_modules/minimist": {
|
||||
"version": "1.2.8",
|
||||
"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.8.tgz",
|
||||
"integrity": "sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"funding": {
|
||||
"url": "https://github.com/sponsors/ljharb"
|
||||
}
|
||||
},
|
||||
"node_modules/ms": {
|
||||
"version": "2.1.3",
|
||||
"resolved": "https://registry.npmjs.org/ms/-/ms-2.1.3.tgz",
|
||||
@ -2314,6 +2435,13 @@
|
||||
"node": ">= 0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/neo-async": {
|
||||
"version": "2.6.2",
|
||||
"resolved": "https://registry.npmjs.org/neo-async/-/neo-async-2.6.2.tgz",
|
||||
"integrity": "sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/node-domexception": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/node-domexception/-/node-domexception-1.0.0.tgz",
|
||||
@ -2456,6 +2584,19 @@
|
||||
"node": ">=6"
|
||||
}
|
||||
},
|
||||
"node_modules/parse-github-url": {
|
||||
"version": "1.0.3",
|
||||
"resolved": "https://registry.npmjs.org/parse-github-url/-/parse-github-url-1.0.3.tgz",
|
||||
"integrity": "sha512-tfalY5/4SqGaV/GIGzWyHnFjlpTPTNpENR9Ea2lLldSJ8EWXMsvacWucqY3m3I4YPtas15IxTLQVQ5NSYXPrww==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"bin": {
|
||||
"parse-github-url": "cli.js"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">= 0.10"
|
||||
}
|
||||
},
|
||||
"node_modules/parseurl": {
|
||||
"version": "1.3.3",
|
||||
"resolved": "https://registry.npmjs.org/parseurl/-/parseurl-1.3.3.tgz",
|
||||
@ -2898,6 +3039,16 @@
|
||||
"node": ">= 14"
|
||||
}
|
||||
},
|
||||
"node_modules/source-map": {
|
||||
"version": "0.6.1",
|
||||
"resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz",
|
||||
"integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==",
|
||||
"dev": true,
|
||||
"license": "BSD-3-Clause",
|
||||
"engines": {
|
||||
"node": ">=0.10.0"
|
||||
}
|
||||
},
|
||||
"node_modules/sprintf-js": {
|
||||
"version": "1.1.3",
|
||||
"resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.1.3.tgz",
|
||||
@ -2961,6 +3112,13 @@
|
||||
"node": ">=0.6"
|
||||
}
|
||||
},
|
||||
"node_modules/tr46": {
|
||||
"version": "0.0.3",
|
||||
"resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
|
||||
"integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/ts-api-utils": {
|
||||
"version": "2.1.0",
|
||||
"resolved": "https://registry.npmjs.org/ts-api-utils/-/ts-api-utils-2.1.0.tgz",
|
||||
@ -3059,6 +3217,20 @@
|
||||
"node": ">=14.17"
|
||||
}
|
||||
},
|
||||
"node_modules/uglify-js": {
|
||||
"version": "3.19.3",
|
||||
"resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.19.3.tgz",
|
||||
"integrity": "sha512-v3Xu+yuwBXisp6QYTcH4UbH+xYJXqnq2m/LtQVWKWzYc1iehYnLixoQDN9FH6/j9/oybfd6W9Ghwkl8+UMKTKQ==",
|
||||
"dev": true,
|
||||
"license": "BSD-2-Clause",
|
||||
"optional": true,
|
||||
"bin": {
|
||||
"uglifyjs": "bin/uglifyjs"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=0.8.0"
|
||||
}
|
||||
},
|
||||
"node_modules/undici-types": {
|
||||
"version": "6.20.0",
|
||||
"resolved": "https://registry.npmjs.org/undici-types/-/undici-types-6.20.0.tgz",
|
||||
@ -3109,6 +3281,24 @@
|
||||
"node": ">= 8"
|
||||
}
|
||||
},
|
||||
"node_modules/webidl-conversions": {
|
||||
"version": "3.0.1",
|
||||
"resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
|
||||
"integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==",
|
||||
"dev": true,
|
||||
"license": "BSD-2-Clause"
|
||||
},
|
||||
"node_modules/whatwg-url": {
|
||||
"version": "5.0.0",
|
||||
"resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
|
||||
"integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==",
|
||||
"dev": true,
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"tr46": "~0.0.3",
|
||||
"webidl-conversions": "^3.0.0"
|
||||
}
|
||||
},
|
||||
"node_modules/which": {
|
||||
"version": "2.0.2",
|
||||
"resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz",
|
||||
@ -3134,6 +3324,13 @@
|
||||
"node": ">=0.10.0"
|
||||
}
|
||||
},
|
||||
"node_modules/wordwrap": {
|
||||
"version": "1.0.0",
|
||||
"resolved": "https://registry.npmjs.org/wordwrap/-/wordwrap-1.0.0.tgz",
|
||||
"integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==",
|
||||
"dev": true,
|
||||
"license": "MIT"
|
||||
},
|
||||
"node_modules/wrappy": {
|
||||
"version": "1.0.2",
|
||||
"resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz",
|
||||
|
@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@zereight/mcp-gitlab",
|
||||
"version": "1.0.56",
|
||||
"version": "1.0.62",
|
||||
"description": "MCP server for using the GitLab API",
|
||||
"license": "MIT",
|
||||
"author": "zereight",
|
||||
@ -21,6 +21,7 @@
|
||||
"watch": "tsc --watch",
|
||||
"deploy": "npm publish --access public",
|
||||
"generate-tools": "npx ts-node scripts/generate-tools-readme.ts",
|
||||
"changelog": "auto-changelog -p",
|
||||
"test": "node test/validate-api.js",
|
||||
"test:integration": "node test/validate-api.js",
|
||||
"lint": "eslint . --ext .ts",
|
||||
@ -48,6 +49,7 @@
|
||||
"prettier": "^3.4.2",
|
||||
"ts-node": "^10.9.2",
|
||||
"typescript": "^5.8.2",
|
||||
"zod": "^3.24.2"
|
||||
"zod": "^3.24.2",
|
||||
"auto-changelog": "^2.4.0"
|
||||
}
|
||||
}
|
||||
|
163
schemas.ts
163
schemas.ts
@ -94,6 +94,13 @@ export const GitLabPipelineJobSchema = z.object({
|
||||
web_url: z.string().optional(),
|
||||
});
|
||||
|
||||
// Shared base schema for various pagination options
|
||||
// See https://docs.gitlab.com/api/rest/#pagination
|
||||
export const PaginationOptionsSchema = z.object({
|
||||
page: z.number().optional().describe("Page number for pagination (default: 1)"),
|
||||
per_page: z.number().optional().describe("Number of items per page (max: 100, default: 20)"),
|
||||
});
|
||||
|
||||
// Schema for listing pipelines
|
||||
export const ListPipelinesSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
@ -134,9 +141,7 @@ export const ListPipelinesSchema = z.object({
|
||||
.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)"),
|
||||
});
|
||||
}).merge(PaginationOptionsSchema);
|
||||
|
||||
// Schema for getting a specific pipeline
|
||||
export const GetPipelineSchema = z.object({
|
||||
@ -153,9 +158,7 @@ export const ListPipelineJobsSchema = z.object({
|
||||
.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)"),
|
||||
});
|
||||
}).merge(PaginationOptionsSchema);
|
||||
|
||||
// Schema for creating a new pipeline
|
||||
export const CreatePipelineSchema = z.object({
|
||||
@ -209,7 +212,7 @@ export const GitLabUsersResponseSchema = z.record(
|
||||
id: z.number(),
|
||||
username: z.string(),
|
||||
name: z.string(),
|
||||
avatar_url: z.string(),
|
||||
avatar_url: z.string().nullable(),
|
||||
web_url: z.string(),
|
||||
}).nullable()
|
||||
);
|
||||
@ -250,7 +253,7 @@ export const GitLabNamespaceExistsResponseSchema = z.object({
|
||||
export const GitLabOwnerSchema = z.object({
|
||||
username: z.string(), // Changed from login to match GitLab API
|
||||
id: z.number(),
|
||||
avatar_url: z.string(),
|
||||
avatar_url: z.string().nullable(),
|
||||
web_url: z.string(), // Changed from html_url to match GitLab API
|
||||
name: z.string(), // Added as GitLab includes full name
|
||||
state: z.string(), // Added as GitLab includes user state
|
||||
@ -310,7 +313,7 @@ export const GitLabRepositorySchema = z.object({
|
||||
container_registry_access_level: z.string().optional(),
|
||||
issues_enabled: z.boolean().optional(),
|
||||
merge_requests_enabled: z.boolean().optional(),
|
||||
merge_requests_template: z.string().optional(),
|
||||
merge_requests_template: z.string().nullable().optional(),
|
||||
wiki_enabled: z.boolean().optional(),
|
||||
jobs_enabled: z.boolean().optional(),
|
||||
snippets_enabled: z.boolean().optional(),
|
||||
@ -404,8 +407,17 @@ export const GitLabCommitSchema = z.object({
|
||||
committer_name: z.string(),
|
||||
committer_email: z.string(),
|
||||
committed_date: z.string(),
|
||||
created_at: z.string().optional(), // Add created_at field
|
||||
message: z.string().optional(), // Add full message field
|
||||
web_url: z.string(), // Changed from html_url to match GitLab API
|
||||
parent_ids: z.array(z.string()), // Changed from parents to match GitLab API
|
||||
stats: z.object({
|
||||
additions: z.number().optional().nullable(),
|
||||
deletions: z.number().optional().nullable(),
|
||||
total: z.number().optional().nullable(),
|
||||
}).optional(), // Only present when with_stats=true
|
||||
trailers: z.record(z.string()).optional().default({}), // Git trailers, may be empty object
|
||||
extended_trailers: z.record(z.array(z.string())).optional().default({}), // Extended trailers, may be empty object
|
||||
});
|
||||
|
||||
// Reference schema
|
||||
@ -464,6 +476,8 @@ export const CreateMergeRequestOptionsSchema = z.object({
|
||||
labels: z.array(z.string()).optional(),
|
||||
allow_collaboration: z.boolean().optional(), // Changed from maintainer_can_modify to match GitLab API
|
||||
draft: z.boolean().optional(),
|
||||
remove_source_branch: z.boolean().optional().describe("Flag indicating if a merge request should remove the source branch when merging."),
|
||||
squash: z.boolean().optional().describe("If true, squash all commits into a single commit on merge.")
|
||||
});
|
||||
|
||||
export const GitLabDiffSchema = z.object({
|
||||
@ -590,7 +604,7 @@ export const GitLabForkParentSchema = z.object({
|
||||
.object({
|
||||
username: z.string(), // Changed from login to match GitLab API
|
||||
id: z.number(),
|
||||
avatar_url: z.string(),
|
||||
avatar_url: z.string().nullable(),
|
||||
})
|
||||
.optional(), // Made optional to handle cases where GitLab API doesn't include it
|
||||
web_url: z.string(), // Changed from html_url to match GitLab API
|
||||
@ -698,6 +712,24 @@ export const GitLabDiscussionNoteSchema = z.object({
|
||||
});
|
||||
export type GitLabDiscussionNote = z.infer<typeof GitLabDiscussionNoteSchema>;
|
||||
|
||||
// Reusable pagination schema for GitLab API responses.
|
||||
// See https://docs.gitlab.com/api/rest/#pagination
|
||||
export const GitLabPaginationSchema = z.object({
|
||||
x_next_page: z.number().nullable().optional(),
|
||||
x_page: z.number().optional(),
|
||||
x_per_page: z.number().optional(),
|
||||
x_prev_page: z.number().nullable().optional(),
|
||||
x_total: z.number().nullable().optional(),
|
||||
x_total_pages: z.number().nullable().optional(),
|
||||
});
|
||||
export type GitLabPagination = z.infer<typeof GitLabPaginationSchema>;
|
||||
|
||||
// Base paginated response schema that can be extended.
|
||||
// See https://docs.gitlab.com/api/rest/#pagination
|
||||
export const PaginatedResponseSchema = z.object({
|
||||
pagination: GitLabPaginationSchema.optional(),
|
||||
});
|
||||
|
||||
export const GitLabDiscussionSchema = z.object({
|
||||
id: z.string(),
|
||||
individual_note: z.boolean(),
|
||||
@ -705,10 +737,24 @@ export const GitLabDiscussionSchema = z.object({
|
||||
});
|
||||
export type GitLabDiscussion = z.infer<typeof GitLabDiscussionSchema>;
|
||||
|
||||
// Create a schema for paginated discussions response
|
||||
export const PaginatedDiscussionsResponseSchema = z.object({
|
||||
items: z.array(GitLabDiscussionSchema),
|
||||
pagination: GitLabPaginationSchema,
|
||||
});
|
||||
|
||||
// Export the paginated response type for discussions
|
||||
export type PaginatedDiscussionsResponse = z.infer<typeof PaginatedDiscussionsResponseSchema>;
|
||||
|
||||
export const ListIssueDiscussionsSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
issue_iid: z.number().describe("The internal ID of the project issue"),
|
||||
}).merge(PaginationOptionsSchema);
|
||||
|
||||
// Input schema for listing merge request discussions
|
||||
export const ListMergeRequestDiscussionsSchema = ProjectParamsSchema.extend({
|
||||
merge_request_iid: z.number().describe("The IID of a merge request"),
|
||||
});
|
||||
}).merge(PaginationOptionsSchema);
|
||||
|
||||
// Input schema for updating a merge request discussion note
|
||||
export const UpdateMergeRequestNoteSchema = ProjectParamsSchema.extend({
|
||||
@ -763,9 +809,7 @@ export const CreateOrUpdateFileSchema = ProjectParamsSchema.extend({
|
||||
|
||||
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)"),
|
||||
});
|
||||
}).merge(PaginationOptionsSchema);
|
||||
|
||||
export const CreateRepositorySchema = z.object({
|
||||
name: z.string().describe("Repository name"),
|
||||
@ -883,7 +927,7 @@ export const CreateNoteSchema = z.object({
|
||||
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"),
|
||||
assignee_username: z.array(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"),
|
||||
@ -904,9 +948,7 @@ export const ListIssuesSchema = z.object({
|
||||
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(PaginationOptionsSchema);
|
||||
|
||||
// Merge Requests API operation schemas
|
||||
export const ListMergeRequestsSchema = z.object({
|
||||
@ -977,9 +1019,7 @@ export const ListMergeRequestsSchema = z.object({
|
||||
.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"),
|
||||
per_page: z.number().optional().describe("Number of items per page"),
|
||||
});
|
||||
}).merge(PaginationOptionsSchema);
|
||||
|
||||
export const GetIssueSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
@ -1018,21 +1058,6 @@ export const ListIssueLinksSchema = z.object({
|
||||
issue_iid: z.number().describe("The internal ID of a project's issue"),
|
||||
});
|
||||
|
||||
export const ListIssueDiscussionsSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
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"),
|
||||
});
|
||||
|
||||
export const GetIssueLinkSchema = 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"),
|
||||
@ -1059,10 +1084,8 @@ export const DeleteIssueLinkSchema = z.object({
|
||||
// Namespace API operation schemas
|
||||
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"),
|
||||
});
|
||||
}).merge(PaginationOptionsSchema);
|
||||
|
||||
export const GetNamespaceSchema = z.object({
|
||||
namespace_id: z.string().describe("Namespace ID or full path"),
|
||||
@ -1079,8 +1102,6 @@ export const GetProjectSchema = z.object({
|
||||
|
||||
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"),
|
||||
@ -1107,7 +1128,7 @@ export const ListProjectsSchema = z.object({
|
||||
.optional()
|
||||
.describe("Filter projects with merge requests feature enabled"),
|
||||
min_access_level: z.number().optional().describe("Filter by minimum access level"),
|
||||
});
|
||||
}).merge(PaginationOptionsSchema);
|
||||
|
||||
// Label operation schemas
|
||||
export const ListLabelsSchema = z.object({
|
||||
@ -1163,8 +1184,6 @@ export const ListGroupProjectsSchema = z.object({
|
||||
.optional()
|
||||
.describe("Field to sort by"),
|
||||
sort: z.enum(["asc", "desc"]).optional().describe("Sort direction"),
|
||||
page: z.number().optional().describe("Page number"),
|
||||
per_page: z.number().optional().describe("Number of results per page"),
|
||||
archived: z.boolean().optional().describe("Filter for archived projects"),
|
||||
visibility: z
|
||||
.enum(["public", "internal", "private"])
|
||||
@ -1184,14 +1203,14 @@ export const ListGroupProjectsSchema = z.object({
|
||||
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"),
|
||||
});
|
||||
}).merge(PaginationOptionsSchema);
|
||||
|
||||
// Add wiki operation schemas
|
||||
export const ListWikiPagesSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
page: z.number().optional().describe("Page number for pagination"),
|
||||
per_page: z.number().optional().describe("Number of items per page"),
|
||||
});
|
||||
with_content: z.boolean().optional().describe("Include content of the wiki pages"),
|
||||
}).merge(PaginationOptionsSchema);
|
||||
|
||||
export const GetWikiPageSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or URL-encoded path"),
|
||||
slug: z.string().describe("URL-encoded slug of the wiki page"),
|
||||
@ -1209,6 +1228,7 @@ export const UpdateWikiPageSchema = z.object({
|
||||
content: z.string().optional().describe("New content of the wiki page"),
|
||||
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"),
|
||||
slug: z.string().describe("URL-encoded slug of the wiki page"),
|
||||
@ -1219,7 +1239,7 @@ export const GitLabWikiPageSchema = z.object({
|
||||
title: z.string(),
|
||||
slug: z.string(),
|
||||
format: z.string(),
|
||||
content: z.string(),
|
||||
content: z.string().optional(),
|
||||
created_at: z.string().optional(),
|
||||
updated_at: z.string().optional(),
|
||||
});
|
||||
@ -1275,9 +1295,7 @@ export const ListProjectMilestonesSchema = ProjectParamsSchema.extend({
|
||||
.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)"),
|
||||
});
|
||||
}).merge(PaginationOptionsSchema);
|
||||
|
||||
// Schema for getting a single milestone
|
||||
export const GetProjectMilestoneSchema = ProjectParamsSchema.extend({
|
||||
@ -1311,18 +1329,40 @@ export const DeleteProjectMilestoneSchema = GetProjectMilestoneSchema;
|
||||
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)"),
|
||||
});
|
||||
export const GetMilestoneMergeRequestsSchema = GetProjectMilestoneSchema.merge(PaginationOptionsSchema);
|
||||
|
||||
// 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 const GetMilestoneBurndownEventsSchema = GetProjectMilestoneSchema.merge(PaginationOptionsSchema);
|
||||
|
||||
// Add schemas for commit operations
|
||||
export const ListCommitsSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or complete URL-encoded path to project"),
|
||||
ref_name: z.string().optional().describe("The name of a repository branch, tag or revision range, or if not given the default branch"),
|
||||
since: z.string().optional().describe("Only commits after or on this date are returned in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ"),
|
||||
until: z.string().optional().describe("Only commits before or on this date are returned in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ"),
|
||||
path: z.string().optional().describe("The file path"),
|
||||
author: z.string().optional().describe("Search commits by commit author"),
|
||||
all: z.boolean().optional().describe("Retrieve every commit from the repository"),
|
||||
with_stats: z.boolean().optional().describe("Stats about each commit are added to the response"),
|
||||
first_parent: z.boolean().optional().describe("Follow only the first parent commit upon seeing a merge commit"),
|
||||
order: z.enum(["default", "topo"]).optional().describe("List commits in order"),
|
||||
trailers: z.boolean().optional().describe("Parse and include Git trailers for every commit"),
|
||||
page: z.number().optional().describe("Page number for pagination (default: 1)"),
|
||||
per_page: z.number().optional().describe("Number of items per page (max: 100, default: 20)"),
|
||||
});
|
||||
|
||||
export const GetCommitSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or complete URL-encoded path to project"),
|
||||
sha: z.string().describe("The commit hash or name of a repository branch or tag"),
|
||||
stats: z.boolean().optional().describe("Include commit stats"),
|
||||
});
|
||||
|
||||
export const GetCommitDiffSchema = z.object({
|
||||
project_id: z.string().describe("Project ID or complete URL-encoded path to project"),
|
||||
sha: z.string().describe("The commit hash or name of a repository branch or tag"),
|
||||
});
|
||||
|
||||
// Export types
|
||||
@ -1352,6 +1392,7 @@ export type GitLabMergeRequestDiff = z.infer<
|
||||
export type CreateNoteOptions = z.infer<typeof CreateNoteSchema>;
|
||||
export type GitLabIssueLink = z.infer<typeof GitLabIssueLinkSchema>;
|
||||
export type ListIssueDiscussionsOptions = z.infer<typeof ListIssueDiscussionsSchema>;
|
||||
export type ListMergeRequestDiscussionsOptions = z.infer<typeof ListMergeRequestDiscussionsSchema>;
|
||||
export type UpdateIssueNoteOptions = z.infer<typeof UpdateIssueNoteSchema>;
|
||||
export type CreateIssueNoteOptions = z.infer<typeof CreateIssueNoteSchema>;
|
||||
export type GitLabNamespace = z.infer<typeof GitLabNamespaceSchema>;
|
||||
@ -1389,3 +1430,7 @@ export type PromoteProjectMilestoneOptions = z.infer<typeof PromoteProjectMilest
|
||||
export type GetMilestoneBurndownEventsOptions = z.infer<typeof GetMilestoneBurndownEventsSchema>;
|
||||
export type GitLabUser = z.infer<typeof GitLabUserSchema>;
|
||||
export type GitLabUsersResponse = z.infer<typeof GitLabUsersResponseSchema>;
|
||||
export type PaginationOptions = z.infer<typeof PaginationOptionsSchema>;
|
||||
export type ListCommitsOptions = z.infer<typeof ListCommitsSchema>;
|
||||
export type GetCommitOptions = z.infer<typeof GetCommitSchema>;
|
||||
export type GetCommitDiffOptions = z.infer<typeof GetCommitDiffSchema>;
|
||||
|
38
scripts/create-github-release.sh
Executable file
38
scripts/create-github-release.sh
Executable file
@ -0,0 +1,38 @@
|
||||
#!/bin/bash
|
||||
set -e
|
||||
|
||||
# Extract version from package.json
|
||||
VERSION=$(jq -r .version package.json)
|
||||
|
||||
if [ -z "$VERSION" ]; then
|
||||
echo "Could not read version from package.json."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Check if release notes file exists
|
||||
if [ ! -f RELEASE_NOTES.md ]; then
|
||||
echo "RELEASE_NOTES.md file does not exist."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Generate RELEASE_NOTES.md from CHANGELOG.md for the current version
|
||||
node <<'EOF'
|
||||
const fs = require('fs');
|
||||
const changelog = fs.readFileSync('CHANGELOG.md', 'utf8');
|
||||
const pkg = JSON.parse(fs.readFileSync('package.json', 'utf8'));
|
||||
const version = pkg.version;
|
||||
|
||||
const regex = new RegExp(`## \\[${version.replace(/\./g, '\\.')}\\][\\s\\S]*?(?=\\n## |\\n?$)`, 'g');
|
||||
const match = changelog.match(regex);
|
||||
|
||||
if (match && match[0]) {
|
||||
fs.writeFileSync('RELEASE_NOTES.md', match[0].trim() + '\n');
|
||||
console.log('RELEASE_NOTES.md generated for version', version);
|
||||
} else {
|
||||
console.error('No changelog entry found for version', version);
|
||||
process.exit(1);
|
||||
}
|
||||
EOF
|
||||
|
||||
# Create GitHub release using CLI
|
||||
gh release create "$VERSION" -t "Release $VERSION" -F RELEASE_NOTES.md
|
Reference in New Issue
Block a user