gitmanager/gitlab-mcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #38 from ncrum/feat/merge-request-note

Browse Source 
Adds threaded comment support for merge requests
This commit is contained in:
zereight
2025-05-15 10:51:48 +09:00
committed by GitHub
parent 3565d1b397 353e62a401
commit 2fec95d469
3 changed files with 203 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -55,31 +55,33 @@ When using with the Claude App, you need to set up your API key and URLs directl
11. `get_merge_request_diffs` - Get the changes/diffs of a merge request (Either mergeRequestIid or branchName must be provided)
12. `update_merge_request` - Update a merge request (Either mergeRequestIid or branchName must be provided)
13. `create_note` - Create a new note (comment) to an issue or merge request
14. `mr_discussions` - List discussion items for a merge request
15. `update_merge_request_note` - Modify an existing merge request thread note
16. `list_issues` - List issues in a GitLab project with filtering options
17. `get_issue` - Get details of a specific issue in a GitLab project
18. `update_issue` - Update an issue in a GitLab project
19. `delete_issue` - Delete an issue from a GitLab project
20. `list_issue_links` - List all issue links for a specific issue
21. `get_issue_link` - Get a specific issue link
22. `create_issue_link` - Create an issue link between two issues
23. `delete_issue_link` - Delete an issue link
24. `list_namespaces` - List all namespaces available to the current user
25. `get_namespace` - Get details of a namespace by ID or path
26. `verify_namespace` - Verify if a namespace path exists
27. `get_project` - Get details of a specific project
28. `list_projects` - List projects accessible by the current user
29. `list_labels` - List labels for a project
30. `get_label` - Get a single label from a project
31. `create_label` - Create a new label in a project
32. `update_label` - Update an existing label in a project
33. `delete_label` - Delete a label from a project
34. `list_group_projects` - List projects in a GitLab group with filtering options
35. `list_wiki_pages` - List wiki pages in a GitLab project
36. `get_wiki_page` - Get details of a specific wiki page
37. `create_wiki_page` - Create a new wiki page in a GitLab project
38. `update_wiki_page` - Update an existing wiki page in a GitLab project
39. `delete_wiki_page` - Delete a wiki page from a GitLab project
40. `get_repository_tree` - Get the repository tree for a GitLab project (list files and directories)
14. `create_merge_request_thread` - Create a new thread on a merge request
15. `mr_discussions` - List discussion items for a merge request
16. `update_merge_request_note` - Modify an existing merge request thread note
17. `create_merge_request_note` - Add a new note to an existing merge request thread
18. `list_issues` - List issues in a GitLab project with filtering options
19. `get_issue` - Get details of a specific issue in a GitLab project
20. `update_issue` - Update an issue in a GitLab project
21. `delete_issue` - Delete an issue from a GitLab project
22. `list_issue_links` - List all issue links for a specific issue
23. `get_issue_link` - Get a specific issue link
24. `create_issue_link` - Create an issue link between two issues
25. `delete_issue_link` - Delete an issue link
26. `list_namespaces` - List all namespaces available to the current user
27. `get_namespace` - Get details of a namespace by ID or path
28. `verify_namespace` - Verify if a namespace path exists
29. `get_project` - Get details of a specific project
30. `list_projects` - List projects accessible by the current user
31. `list_labels` - List labels for a project
32. `get_label` - Get a single label from a project
33. `create_label` - Create a new label in a project
34. `update_label` - Update an existing label in a project
35. `delete_label` - Delete a label from a project
36. `list_group_projects` - List projects in a GitLab group with filtering options
37. `list_wiki_pages` - List wiki pages in a GitLab project
38. `get_wiki_page` - Get details of a specific wiki page
39. `create_wiki_page` - Create a new wiki page in a GitLab project
40. `update_wiki_page` - Update an existing wiki page in a GitLab project
41. `delete_wiki_page` - Delete a wiki page from a GitLab project
42. `get_repository_tree` - Get the repository tree for a GitLab project (list files and directories)
<!-- TOOLS-END -->

139
index.ts
View File

@ -75,6 +75,7 @@ import {
UpdateLabelSchema,
DeleteLabelSchema,
CreateNoteSchema,
CreateMergeRequestThreadSchema,
ListGroupProjectsSchema,
ListWikiPagesSchema,
GetWikiPageSchema,
@ -86,6 +87,7 @@ import {
GitLabDiscussionNoteSchema, // Added
GitLabDiscussionSchema,
UpdateMergeRequestNoteSchema, // Added
CreateMergeRequestNoteSchema, // Added
ListMergeRequestDiscussionsSchema,
type GitLabFork,
type GitLabReference,
@ -108,6 +110,7 @@ import {
// Discussion Types
type GitLabDiscussionNote, // Added
type GitLabDiscussion,
type MergeRequestThreadPosition,
type GetWikiPageOptions,
type CreateWikiPageOptions,
type UpdateWikiPageOptions,
@ -263,6 +266,11 @@ const allTools = [
description: "Create a new note (comment) to an issue or merge request",
inputSchema: zodToJsonSchema(CreateNoteSchema),
},
{
name: "create_merge_request_thread",
description: "Create a new thread on a merge request",
inputSchema: zodToJsonSchema(CreateMergeRequestThreadSchema),
},
{
name: "mr_discussions",
description: "List discussion items for a merge request",
@ -273,6 +281,11 @@ const allTools = [
description: "Modify an existing merge request thread note",
inputSchema: zodToJsonSchema(UpdateMergeRequestNoteSchema),
},
{
name: "create_merge_request_note",
description: "Add a new note to an existing merge request thread",
inputSchema: zodToJsonSchema(CreateMergeRequestNoteSchema),
},
{
name: "list_issues",
description: "List issues in a GitLab project with filtering options",
@ -1056,6 +1069,47 @@ async function updateMergeRequestNote(
return GitLabDiscussionNoteSchema.parse(data);
}
/**
* Add a new note to an existing merge request thread
* 기존 병합 요청 스레드에 새 노트 추가
*
* @param {string} projectId - The ID or URL-encoded path of the project
* @param {number} mergeRequestIid - The IID of a merge request
* @param {string} discussionId - The ID of a thread
* @param {string} body - The content of the new note
* @param {string} [createdAt] - The creation date of the note (ISO 8601 format)
* @returns {Promise<GitLabDiscussionNote>} The created note
*/
async function createMergeRequestNote(
projectId: string,
mergeRequestIid: number,
discussionId: string,
body: string,
createdAt?: string
): Promise<GitLabDiscussionNote> {
projectId = decodeURIComponent(projectId); // Decode project ID
const url = new URL(
`${GITLAB_API_URL}/projects/${encodeURIComponent(
projectId
)}/merge_requests/${mergeRequestIid}/discussions/${discussionId}/notes`
);
const payload: { body: string; created_at?: string } = { body };
if (createdAt) {
payload.created_at = createdAt;
}
const response = await fetch(url.toString(), {
...DEFAULT_FETCH_CONFIG,
method: "POST",
body: JSON.stringify(payload),
});
await handleGitLabError(response);
const data = await response.json();
return GitLabDiscussionNoteSchema.parse(data);
}
/**
* Create or update a file in a GitLab project
* 파일 생성 또는 업데이트
@ -1523,6 +1577,59 @@ async function createNote(
return await response.json();
}
/**
* Create a new thread on a merge request
* 📦 새로운 함수: createMergeRequestThread - 병합 요청에 새로운 스레드(토론)를 생성하는 함수
* (New function: createMergeRequestThread - Function to create a new thread (discussion) on a merge request)
*
* This function provides more capabilities than createNote, including the ability to:
* - Create diff notes (comments on specific lines of code)
* - Specify exact positions for comments
* - Set creation timestamps
*
* @param {string} projectId - The ID or URL-encoded path of the project
* @param {number} mergeRequestIid - The internal ID of the merge request
* @param {string} body - The content of the thread
* @param {MergeRequestThreadPosition} [position] - Position information for diff notes
* @param {string} [createdAt] - ISO 8601 formatted creation date
* @returns {Promise<GitLabDiscussion>} The created discussion thread
*/
async function createMergeRequestThread(
projectId: string,
mergeRequestIid: number,
body: string,
position?: MergeRequestThreadPosition,
createdAt?: string
): Promise<GitLabDiscussion> {
projectId = decodeURIComponent(projectId); // Decode project ID
const url = new URL(
`${GITLAB_API_URL}/projects/${encodeURIComponent(
projectId
)}/merge_requests/${mergeRequestIid}/discussions`
);
const payload: Record<string, any> = { body };
// Add optional parameters if provided
if (position) {
payload.position = position;
}
if (createdAt) {
payload.created_at = createdAt;
}
const response = await fetch(url.toString(), {
...DEFAULT_FETCH_CONFIG,
method: "POST",
body: JSON.stringify(payload),
});
await handleGitLabError(response);
const data = await response.json();
return GitLabDiscussionSchema.parse(data);
}
/**
* List all namespaces
* 사용 가능한 모든 네임스페이스 목록 조회
@ -2281,6 +2388,22 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
};
}
case "create_merge_request_note": {
const args = CreateMergeRequestNoteSchema.parse(
request.params.arguments
);
const note = await createMergeRequestNote(
args.project_id,
args.merge_request_iid,
args.discussion_id,
args.body,
args.created_at
);
return {
content: [{ type: "text", text: JSON.stringify(note, null, 2) }],
};
}
case "get_merge_request": {
const args = GetMergeRequestSchema.parse(request.params.arguments);
const mergeRequest = await getMergeRequest(
@ -2457,6 +2580,22 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
};
}
case "create_merge_request_thread": {
const args = CreateMergeRequestThreadSchema.parse(request.params.arguments);
const { project_id, merge_request_iid, body, position, created_at } = args;
const thread = await createMergeRequestThread(
project_id,
merge_request_iid,
body,
position,
created_at
);
return {
content: [{ type: "text", text: JSON.stringify(thread, null, 2) }],
};
}
case "list_issues": {
const args = ListIssuesSchema.parse(request.params.arguments);
const { project_id, ...options } = args;

35
schemas.ts
View File

@ -483,6 +483,14 @@ export const UpdateMergeRequestNoteSchema = ProjectParamsSchema.extend({
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({
merge_request_iid: z.number().describe("The IID of a merge request"),
discussion_id: z.string().describe("The ID of a thread"),
body: z.string().describe("The content of the note or reply"),
created_at: z.string().optional().describe("Date the note was created at (ISO 8601 format)"),
});
// API Operation Parameter Schemas
export const CreateOrUpdateFileSchema = ProjectParamsSchema.extend({
@ -1008,6 +1016,30 @@ export const GitLabWikiPageSchema = z.object({
updated_at: z.string().optional(),
});
// Merge Request Thread position schema - used for diff notes
export const MergeRequestThreadPositionSchema = z.object({
base_sha: z.string().describe("Base commit SHA in the source branch"),
head_sha: z.string().describe("SHA referencing HEAD of the source branch"),
start_sha: z.string().describe("SHA referencing the start commit of the source branch"),
position_type: z.enum(["text", "image", "file"]).describe("Type of position reference"),
new_path: z.string().optional().describe("File path after change"),
old_path: z.string().optional().describe("File path before change"),
new_line: z.number().nullable().optional().describe("Line number after change"),
old_line: z.number().nullable().optional().describe("Line number before change"),
width: z.number().optional().describe("Width of the image (for image diffs)"),
height: z.number().optional().describe("Height of the image (for image diffs)"),
x: z.number().optional().describe("X coordinate on the image (for image diffs)"),
y: z.number().optional().describe("Y coordinate on the image (for image diffs)"),
});
// Schema for creating a new merge request thread
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"),
created_at: z.string().optional().describe("Date the thread was created at (ISO 8601 format)"),
});
// Export types
export type GitLabAuthor = z.infer<typeof GitLabAuthorSchema>;
export type GitLabFork = z.infer<typeof GitLabForkSchema>;
@ -1057,3 +1089,6 @@ export type DeleteWikiPageOptions = z.infer<typeof DeleteWikiPageSchema>;
export type GitLabWikiPage = z.infer<typeof GitLabWikiPageSchema>;
export type GitLabTreeItem = z.infer<typeof GitLabTreeItemSchema>;
export type GetRepositoryTreeOptions = z.infer<typeof GetRepositoryTreeSchema>;
export type MergeRequestThreadPosition = z.infer<typeof MergeRequestThreadPositionSchema>;
export type CreateMergeRequestThreadOptions = z.infer<typeof CreateMergeRequestThreadSchema>;
export type CreateMergeRequestNoteOptions = z.infer<typeof CreateMergeRequestNoteSchema>;