@zereight/mcp-gitlab 1.0.2 → 1.0.4

package/README.md

@@ -1,22 +1,196 @@
-# @zereight/mcp-gitlab
+# Better GitLab MCP Server
 
-GitLab MCP(Model Context Protocol) 서버입니다.
+## @zereight/mcp-gitlab
 
-## 설치 및 실행
+[![smithery badge](https://smithery.ai/badge/@zereight/gitlab-mcp)](https://smithery.ai/server/@zereight/gitlab-mcp)
 
-```bash
-npx @zereight/mcp-gitlab
+GitLab MCP(Model Context Protocol) Server.
+
+<a href="https://glama.ai/mcp/servers/7jwbk4r6d7"><img width="380" height="200" src="https://glama.ai/mcp/servers/7jwbk4r6d7/badge" alt="gitlab mcp MCP server" /></a>
+
+## Features ✨
+
+- **Automatic Branch Creation**: Automatically creates a branch if it doesn't exist when creating/updating files or pushing changes. 🌿
+- **Comprehensive Error Handling**: Provides clear error messages for common issues. ⚠️
+- **Git History Preservation**: Operates without force-pushing, maintaining Git history. 📜
+- **Batch Operations**: Supports both single and multi-file operations. 묶음
+- **Versatile Search**: Supports project search functionality. 🔍
+
+## Tools 🛠️
+
+1. `create_or_update_file`
+
+   - Create or update a single file in a GitLab project. 📝
+   - Inputs:
+     - `project_id` (string): Project ID or namespace/project_path
+     - `file_path` (string): Path to create/update the file
+     - `content` (string): File content
+     - `commit_message` (string): Commit message
+     - `branch` (string): Branch to create/update the file in
+     - `previous_path` (optional string): Previous file path when renaming a file
+   - Returns: File content and commit details
+
+2. `push_files`
+
+   - Push multiple files in a single commit. 📤
+   - Inputs:
+     - `project_id` (string): Project ID or namespace/project_path
+     - `branch` (string): Branch to push to
+     - `files` (array): Array of files to push, each with `file_path` and `content` properties
+     - `commit_message` (string): Commit message
+   - Returns: Updated branch reference
+
+3. `search_repositories`
+
+   - Search for GitLab projects. 🔍
+   - Inputs:
+     - `search` (string): Search query
+     - `page` (optional number): Page number (default: 1)
+     - `per_page` (optional number): Results per page (default: 20, max: 100)
+   - Returns: Project search results
+
+4. `create_repository`
+
+   - Create a new GitLab project. ➕
+   - Inputs:
+     - `name` (string): Project name
+     - `description` (optional string): Project description
+     - `visibility` (optional string): Project visibility level (public, private, internal)
+     - `initialize_with_readme` (optional boolean): Initialize with README
+   - Returns: Details of the created project
+
+5. `get_file_contents`
+
+   - Get the contents of a file or directory. 📂
+   - Inputs:
+     - `project_id` (string): Project ID or namespace/project_path
+     - `file_path` (string): Path to the file/directory
+     - `ref` (optional string): Branch, tag, or commit SHA (default: default branch)
+   - Returns: File/directory content
+
+6. `create_issue`
+
+   - Create a new issue. 🐛
+   - Inputs:
+     - `project_id` (string): Project ID or namespace/project_path
+     - `title` (string): Issue title
+     - `description` (string): Issue description
+     - `assignee_ids` (optional number[]): Array of assignee IDs
+     - `milestone_id` (optional number): Milestone ID
+     - `labels` (optional string[]): Array of labels
+   - Returns: Details of the created issue
+
+7. `create_merge_request`
+
+   - Create a new merge request. 🚀
+   - Inputs:
+     - `project_id` (string): Project ID or namespace/project_path
+     - `title` (string): Merge request title
+     - `description` (string): Merge request description
+     - `source_branch` (string): Branch with changes
+     - `target_branch` (string): Branch to merge into
+     - `allow_collaboration` (optional boolean): Allow collaborators to push commits to the source branch
+     - `draft` (optional boolean): Create as a draft merge request
+   - Returns: Details of the created merge request
+
+8. `fork_repository`
+
+   - Fork a project. 🍴
+   - Inputs:
+     - `project_id` (string): Project ID or namespace/project_path to fork
+     - `namespace` (optional string): Namespace to fork into (default: user namespace)
+   - Returns: Details of the forked project
+
+9. `create_branch`
+
+   - Create a new branch. 🌿
+   - Inputs:
+     - `project_id` (string): Project ID or namespace/project_path
+     - `name` (string): New branch name
+     - `ref` (optional string): Ref to create the branch from (branch, tag, commit SHA, default: default branch)
+   - Returns: Created branch reference
+
+10. `get_merge_request`
+
+    - Get details of a merge request. ℹ️
+    - Inputs:
+      - `project_id` (string): Project ID or namespace/project_path
+      - `merge_request_iid` (number): Merge request IID
+    - Returns: Merge request details
+
+11. `get_merge_request_diffs`
+
+    - Get changes (diffs) of a merge request. diff
+    - Inputs:
+      - `project_id` (string): Project ID or namespace/project_path
+      - `merge_request_iid` (number): Merge request IID
+      - `view` (optional string): Diff view type ('inline' or 'parallel')
+    - Returns: Array of merge request diff information
+
+12. `update_merge_request`
+
+    - Update a merge request. 🔄
+    - Inputs:
+      - `project_id` (string): Project ID or namespace/project_path
+      - `merge_request_iid` (number): Merge request IID
+      - `title` (optional string): New title
+      - `description` (string): New description
+      - `target_branch` (optional string): New target branch
+      - `state_event` (optional string): Merge request state change event ('close', 'reopen')
+      - `remove_source_branch` (optional boolean): Remove source branch after merge
+      - `allow_collaboration` (optional boolean): Allow collaborators to push commits to the source branch
+    - Returns: Updated merge request details
+
+13. `create_note`
+    - Create a new note (comment) to an issue or merge request. 💬
+    - Inputs:
+      - `project_id` (string): Project ID or namespace/project_path
+      - `noteable_type` (string): Type of noteable ("issue" or "merge_request")
+      - `noteable_iid` (number): IID of the issue or merge request
+      - `body` (string): Note content
+    - Returns: Details of the created note
+
+## Environment Variable Configuration
+
+Before running the server, you need to set the following environment variables:
+
+```
+GITLAB_PERSONAL_ACCESS_TOKEN=your_gitlab_token
+GITLAB_API_URL=your_gitlab_api_url  # Default: https://gitlab.com/api/v4
+```
+
+## Usage
+
+### Using with Claude App, Cline, Roo Code
+
+When using with the Claude App, you need to set up your API key and URLs directly.
+
+```json
+{
+  "mcpServers": {
+    "GitLab communication server": {
+      "command": "npx",
+      "args": ["-y", "@zereight/mcp-gitlab"],
+      "env": {
+        "GITLAB_PERSONAL_ACCESS_TOKEN": "your_gitlab_token",
+        "GITLAB_API_URL": "your_gitlab_api_url"
+      }
+    }
+  }
+}
 ```
 
-## 환경 변수 설정
+### Using with Cursor
 
-서버를 실행하기 전에 다음 환경 변수를 설정해야 합니다:
+When using with Cursor, you can set up environment variables and run the server as follows:
 
-```bash
-GITLAB_TOKEN=your_gitlab_token
-GITLAB_API_URL=your_gitlab_api_url  # 기본값: https://gitlab.com/api/v4
 ```
+env GITLAB_PERSONAL_ACCESS_TOKEN=your_gitlab_token GITLAB_API_URL=your_gitlab_api_url npx @zereight/mcp-gitlab
+```
+
+- `GITLAB_PERSONAL_ACCESS_TOKEN`: Your GitLab personal access token.
+- `GITLAB_API_URL`: Your GitLab API URL. (Default: `https://gitlab.com/api/v4`)
 
-## 라이선스
+## License
 
 MIT License

package/build/index.js

@@ -5,7 +5,7 @@ import { CallToolRequestSchema, ListToolsRequestSchema, } from "@modelcontextpro
 import fetch from "node-fetch";
 import { z } from "zod";
 import { zodToJsonSchema } from "zod-to-json-schema";
-import { GitLabForkSchema, GitLabReferenceSchema, GitLabRepositorySchema, GitLabIssueSchema, GitLabMergeRequestSchema, GitLabContentSchema, GitLabCreateUpdateFileResponseSchema, GitLabSearchResponseSchema, GitLabTreeSchema, GitLabCommitSchema, CreateOrUpdateFileSchema, SearchRepositoriesSchema, CreateRepositorySchema, GetFileContentsSchema, PushFilesSchema, CreateIssueSchema, CreateMergeRequestSchema, ForkRepositorySchema, CreateBranchSchema, GitLabMergeRequestDiffSchema, GetMergeRequestSchema, GetMergeRequestDiffsSchema, UpdateMergeRequestSchema, } from "./schemas.js";
+import { GitLabForkSchema, GitLabReferenceSchema, GitLabRepositorySchema, GitLabIssueSchema, GitLabMergeRequestSchema, GitLabContentSchema, GitLabCreateUpdateFileResponseSchema, GitLabSearchResponseSchema, GitLabTreeSchema, GitLabCommitSchema, CreateOrUpdateFileSchema, SearchRepositoriesSchema, CreateRepositorySchema, GetFileContentsSchema, PushFilesSchema, CreateIssueSchema, CreateMergeRequestSchema, ForkRepositorySchema, CreateBranchSchema, GitLabMergeRequestDiffSchema, GetMergeRequestSchema, GetMergeRequestDiffsSchema, UpdateMergeRequestSchema, CreateNoteSchema, } from "./schemas.js";
 const server = new Server({
     name: "gitlab-mcp-server",
     version: "0.0.1",
@@ -341,6 +341,19 @@ async function updateMergeRequest(projectId, mergeRequestIid, options) {
     await handleGitLabError(response);
     return GitLabMergeRequestSchema.parse(await response.json());
 }
+// 📦 새로운 함수: createNote - 이슈 또는 병합 요청에 노트(댓글)를 추가하는 함수
+async function createNote(projectId, noteableType, // 'issue' 또는 'merge_request' 타입 명시
+noteableIid, body) {
+    // ⚙️ 응답 타입은 GitLab API 문서에 따라 조정 가능
+    const url = new URL(`${GITLAB_API_URL}/projects/${encodeURIComponent(projectId)}/${noteableType}/${noteableIid}/notes`);
+    const response = await fetch(url.toString(), {
+        method: "POST",
+        headers: DEFAULT_HEADERS,
+        body: JSON.stringify({ body }),
+    });
+    await handleGitLabError(response);
+    return await response.json(); // ⚙️ 응답 타입은 GitLab API 문서에 따라 조정 가능, 필요하면 스키마 정의
+}
 server.setRequestHandler(ListToolsRequestSchema, async () => {
     return {
         tools: [
@@ -404,6 +417,11 @@ server.setRequestHandler(ListToolsRequestSchema, async () => {
                 description: "Update a merge request",
                 inputSchema: zodToJsonSchema(UpdateMergeRequestSchema),
             },
+            {
+                name: "create_note",
+                description: "Create a new note (comment) to an issue or merge request",
+                inputSchema: zodToJsonSchema(CreateNoteSchema),
+            },
         ],
     };
 });
@@ -515,6 +533,24 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => {
                     ],
                 };
             }
+            case "create_note": {
+                try {
+                    const args = CreateNoteSchema.parse(request.params.arguments);
+                    const { project_id, noteable_type, noteable_iid, body } = args;
+                    const note = await createNote(project_id, noteable_type, noteable_iid, body);
+                    return {
+                        content: [{ type: "text", text: JSON.stringify(note, null, 2) }],
+                    };
+                }
+                catch (error) {
+                    if (error instanceof z.ZodError) {
+                        throw new Error(`Invalid arguments: ${error.errors
+                            .map((e) => `${e.path.join(".")}: ${e.message}`)
+                            .join(", ")}`);
+                    }
+                    throw error;
+                }
+            }
             default:
                 throw new Error(`Unknown tool: ${request.params.name}`);
         }

package/build/schemas.js

@@ -346,3 +346,11 @@ export const UpdateMergeRequestSchema = GetMergeRequestSchema.extend({
 export const GetMergeRequestDiffsSchema = GetMergeRequestSchema.extend({
     view: z.enum(["inline", "parallel"]).optional().describe("Diff view type"),
 });
+export const CreateNoteSchema = z.object({
+    project_id: z.string().describe("Project ID or namespace/project_path"),
+    noteable_type: z
+        .enum(["issue", "merge_request"])
+        .describe("Type of noteable (issue or merge_request)"),
+    noteable_iid: z.number().describe("IID of the issue or merge request"),
+    body: z.string().describe("Note content"),
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zereight/mcp-gitlab",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "MCP server for using the GitLab API",
   "license": "MIT",
   "author": "zereight",