@zereight/mcp-gitlab 2.1.51 → 2.1.53

package/build/schemas.js

@@ -522,6 +522,226 @@ export const CancelPipelineSchema = z.object({
     project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
     pipeline_id: z.coerce.string().describe("The ID of the pipeline to cancel"),
 });
+// --- Pipeline schedule related schemas ---
+export const GitLabPipelineScheduleVariableSchema = z.object({
+    key: z.string(),
+    value: z.string().nullable(),
+    variable_type: z.enum(["env_var", "file"]).optional(),
+    raw: z.coerce.boolean().optional(),
+});
+export const GitLabPipelineScheduleSchema = z.object({
+    id: z.coerce.string(),
+    description: z.string(),
+    ref: z.string().nullable().optional(),
+    cron: z.string(),
+    cron_timezone: z.string().optional(),
+    next_run_at: z.string().nullable().optional(),
+    active: z.coerce.boolean(),
+    created_at: z.string(),
+    updated_at: z.string(),
+    owner: z
+        .object({
+        id: z.coerce.string(),
+        name: z.string().optional(),
+        username: z.string().optional(),
+        state: z.string().optional(),
+        avatar_url: z.string().nullable().optional(),
+        web_url: z.string().optional(),
+    })
+        .nullable()
+        .optional(),
+    last_pipeline: z
+        .object({
+        id: z.coerce.string(),
+        sha: z.string().optional(),
+        ref: z.string().optional(),
+        status: z.string().optional(),
+    })
+        .nullable()
+        .optional(),
+    // Only returned to Maintainers/Owners or the schedule owner.
+    variables: z.array(GitLabPipelineScheduleVariableSchema).optional(),
+    inputs: z
+        .array(z.object({
+        name: z.string(),
+        value: z.unknown(),
+    }))
+        .optional(),
+});
+// GitLab answers POST .../play with `{"message": "201 Created"}` rather than the pipeline.
+export const GitLabPipelineSchedulePlayResultSchema = z.object({
+    message: z.string().optional(),
+});
+// A CI/CD input is typed string, number, boolean, or array — a map is not a
+// top-level input type, though array items may themselves be maps or sequences.
+const pipelineScheduleInputValue = z
+    .union([z.string(), z.number(), z.boolean(), z.array(z.unknown())])
+    .describe("The value of the input; a string, number, boolean, or array whose items may be scalars, sequences, or maps");
+// Schema for listing pipeline schedules
+export const ListPipelineSchedulesSchema = z
+    .object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    scope: z
+        .enum(["active", "inactive"])
+        .optional()
+        .describe("Return only active or only inactive pipeline schedules"),
+})
+    .merge(PaginationOptionsSchema);
+// Schema for getting a specific pipeline schedule
+export const GetPipelineScheduleSchema = z.object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    pipeline_schedule_id: z.coerce.string().describe("The ID of the pipeline schedule"),
+});
+// Schema for listing the pipelines a schedule has triggered
+export const ListPipelineSchedulePipelinesSchema = z
+    .object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    pipeline_schedule_id: z.coerce.string().describe("The ID of the pipeline schedule"),
+    scope: z
+        .enum(["running", "pending", "finished", "branches", "tags"])
+        .optional()
+        .describe("The scope of pipelines"),
+    status: z
+        .enum([
+        "created",
+        "waiting_for_resource",
+        "preparing",
+        "waiting_for_callback",
+        "pending",
+        "running",
+        "success",
+        "failed",
+        "canceling",
+        "canceled",
+        "skipped",
+        "manual",
+        "scheduled",
+    ])
+        .optional()
+        .describe("The status of pipelines"),
+    sort: z.enum(["asc", "desc"]).optional().describe("Sort pipelines (default: asc)"),
+    updated_after: z
+        .string()
+        .optional()
+        .describe("Return pipelines updated after the specified ISO 8601 date"),
+    updated_before: z
+        .string()
+        .optional()
+        .describe("Return pipelines updated before the specified ISO 8601 date"),
+    created_after: z
+        .string()
+        .optional()
+        .describe("Return pipelines created after the specified ISO 8601 date"),
+    created_before: z
+        .string()
+        .optional()
+        .describe("Return pipelines created before the specified ISO 8601 date"),
+})
+    .merge(PaginationOptionsSchema);
+// Schema for creating a pipeline schedule
+export const CreatePipelineScheduleSchema = z.object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    description: z.string().describe("The description of the pipeline schedule"),
+    ref: z
+        .string()
+        .describe("The branch or tag the scheduled pipeline runs on. Use the full ref (e.g. 'refs/heads/main') when a branch and tag share a name"),
+    cron: z.string().describe("The cron schedule expression, for example `0 1 * * *`"),
+    cron_timezone: z
+        .string()
+        .optional()
+        .describe("The time zone for the cron expression, for example 'UTC' (default) or 'Asia/Tokyo'"),
+    active: coerceBooleanString
+        .optional()
+        .describe("Whether the pipeline schedule is active (default: true)"),
+    inputs: z
+        .array(z.object({
+        name: z.string().describe("The name of a 'spec:inputs' entry in the CI/CD configuration"),
+        value: pipelineScheduleInputValue,
+    }))
+        .optional()
+        .describe('Inputs passed to the scheduled pipeline, each an object with `name` (a `spec:inputs` entry) and `value` (a string, number, boolean, or array) — for example [{"name": "deploy_strategy", "value": "blue-green"}]. Requires GitLab 18.1 or later'),
+});
+// Schema for updating a pipeline schedule
+export const UpdatePipelineScheduleSchema = z.object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    pipeline_schedule_id: z.coerce.string().describe("The ID of the pipeline schedule to update"),
+    description: z.string().optional().describe("The new description of the pipeline schedule"),
+    ref: z
+        .string()
+        .optional()
+        .describe("The new branch or tag the scheduled pipeline runs on. Use the full ref (e.g. 'refs/heads/main') when a branch and tag share a name"),
+    cron: z.string().optional().describe("The new cron schedule expression, for example `0 1 * * *`"),
+    cron_timezone: z
+        .string()
+        .optional()
+        .describe("The new time zone for the cron expression, for example 'UTC' or 'Asia/Tokyo'"),
+    active: coerceBooleanString.optional().describe("Whether the pipeline schedule is active"),
+    inputs: z
+        .array(z.object({
+        name: z.string().describe("The name of a 'spec:inputs' entry in the CI/CD configuration"),
+        value: pipelineScheduleInputValue.optional(),
+        destroy: coerceBooleanString
+            .optional()
+            .describe("Set to true to remove this input from the schedule"),
+    }))
+        .optional()
+        .describe('Inputs to add or change, each an object with `name` and `value`; to remove one, pass its `name` with `destroy` set to true — for example [{"name": "deploy_strategy", "destroy": true}]. Requires GitLab 18.1 or later'),
+});
+// Schema for deleting a pipeline schedule
+export const DeletePipelineScheduleSchema = z.object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    pipeline_schedule_id: z.coerce.string().describe("The ID of the pipeline schedule to delete"),
+});
+// Schema for running a pipeline schedule immediately
+export const PlayPipelineScheduleSchema = z.object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    pipeline_schedule_id: z.coerce.string().describe("The ID of the pipeline schedule to run"),
+});
+// Schema for taking ownership of a pipeline schedule
+export const TakeOwnershipPipelineScheduleSchema = z.object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    pipeline_schedule_id: z.coerce
+        .string()
+        .describe("The ID of the pipeline schedule to take ownership of"),
+});
+// Schema for getting a pipeline schedule variable
+export const GetPipelineScheduleVariableSchema = z.object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    pipeline_schedule_id: z.coerce.string().describe("The ID of the pipeline schedule"),
+    key: z.string().describe("The key of the variable"),
+});
+// Schema for creating a pipeline schedule variable
+export const CreatePipelineScheduleVariableSchema = z.object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    pipeline_schedule_id: z.coerce.string().describe("The ID of the pipeline schedule"),
+    key: z
+        .string()
+        .max(255)
+        .regex(/^[A-Za-z0-9_]+$/)
+        .describe("The key of the variable (max 255 characters, must match /[a-zA-Z0-9_]+/)"),
+    value: z.string().describe("The value of the variable"),
+    variable_type: z
+        .enum(["env_var", "file"])
+        .optional()
+        .describe("The type of variable: 'env_var' (default) or 'file'"),
+});
+// Schema for updating a pipeline schedule variable
+export const UpdatePipelineScheduleVariableSchema = z.object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    pipeline_schedule_id: z.coerce.string().describe("The ID of the pipeline schedule"),
+    key: z.string().describe("The key of the variable to update"),
+    value: z.string().describe("The new value of the variable"),
+    variable_type: z
+        .enum(["env_var", "file"])
+        .optional()
+        .describe("The type of variable: 'env_var' or 'file'"),
+});
+// Schema for deleting a pipeline schedule variable
+export const DeletePipelineScheduleVariableSchema = z.object({
+    project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
+    pipeline_schedule_id: z.coerce.string().describe("The ID of the pipeline schedule"),
+    key: z.string().describe("The key of the variable to delete"),
+});
 // Schema for the input parameters for pipeline job operations
 export const GetPipelineJobOutputSchema = z.object({
     project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
@@ -2135,6 +2355,19 @@ export const ListMergeRequestsSchema = z
         .describe("Return more details for each label"),
 })
     .merge(PaginationOptionsSchema);
+export const ListGroupMergeRequestsSchema = ListMergeRequestsSchema.omit({
+    project_id: true,
+}).extend({
+    group_id: z.coerce.string().describe("Group ID or URL-encoded path"),
+    non_archived: z.coerce
+        .boolean()
+        .optional()
+        .describe("Return merge requests from non-archived projects only. Defaults to true."),
+    source_project_id: z.coerce
+        .string()
+        .optional()
+        .describe("Return merge requests with the given source project ID"),
+});
 export const GetIssueSchema = z.object({
     project_id: z.coerce.string().describe("Project ID or URL-encoded path"),
     issue_iid: z.coerce.string().describe("The internal ID of the project issue"),

package/build/test/test-job-artifacts.js

@@ -1,4 +1,4 @@
-import { describe, test, before, after } from 'node:test';
+import { describe, test, it, before, after } from 'node:test';
 import assert from 'node:assert';
 import { spawn } from 'child_process';
 import { MockGitLabServer, findMockServerPort } from './utils/mock-gitlab-server.js';
@@ -167,15 +167,19 @@ describe('job artifacts tools', () => {
         assert.strictEqual(result[1].name, 'logs');
         assert.strictEqual(result[1].type, 'directory');
     });
-    test('list_job_artifacts returns artifact entries when mode is null', async () => {
-        const result = await callTool('list_job_artifacts', { project_id: TEST_PROJECT_ID, job_id: NULL_MODE_JOB_ID }, {
-            GITLAB_API_URL: `${mockGitLabUrl}/api/v4`,
-            GITLAB_PERSONAL_ACCESS_TOKEN: MOCK_TOKEN,
+    describe('When listing job artifacts', () => {
+        describe('with a null mode entry', () => {
+            it('should return the entries instead of failing', async () => {
+                const result = await callTool('list_job_artifacts', { project_id: TEST_PROJECT_ID, job_id: NULL_MODE_JOB_ID }, {
+                    GITLAB_API_URL: `${mockGitLabUrl}/api/v4`,
+                    GITLAB_PERSONAL_ACCESS_TOKEN: MOCK_TOKEN,
+                });
+                assert.ok(Array.isArray(result), 'Response should be an array');
+                assert.strictEqual(result.length, 2);
+                assert.strictEqual(result[0].mode, null);
+                assert.strictEqual(result[1].size, null);
+            });
         });
-        assert.ok(Array.isArray(result), 'Response should be an array');
-        assert.strictEqual(result.length, 2);
-        assert.strictEqual(result[0].mode, null);
-        assert.strictEqual(result[1].size, null);
     });
     test('download_job_artifacts saves archive to disk', async () => {
         const result = await callTool('download_job_artifacts', { project_id: TEST_PROJECT_ID, job_id: TEST_JOB_ID, local_path: tmpDir }, {

package/build/test/test-list-group-merge-requests.js

@@ -0,0 +1,165 @@
+import { describe, test, before, after, beforeEach } from "node:test";
+import assert from "node:assert";
+import { spawn } from "child_process";
+import { MockGitLabServer, findMockServerPort } from "./utils/mock-gitlab-server.js";
+const MOCK_TOKEN = "glpat-mock-token-12345";
+const TEST_GROUP_ID = "my-group/sub-group";
+const groupMergeRequests = [
+    {
+        id: 1,
+        iid: 10,
+        project_id: 123,
+        title: "Group MR 1",
+        description: "First MR of the group",
+        state: "opened",
+        created_at: "2024-01-01T00:00:00Z",
+        updated_at: "2024-01-02T00:00:00Z",
+        merged_at: null,
+        closed_at: null,
+        target_branch: "main",
+        source_branch: "feature/one",
+        web_url: "https://gitlab.mock/my-group/project-a/-/merge_requests/10",
+        merge_commit_sha: null,
+        author: {
+            id: 1,
+            username: "test-user",
+            name: "Test User",
+        },
+    },
+    {
+        id: 2,
+        iid: 4,
+        project_id: 456,
+        title: "Group MR 2",
+        description: "Second MR of the group",
+        state: "opened",
+        created_at: "2024-01-03T00:00:00Z",
+        updated_at: "2024-01-04T00:00:00Z",
+        merged_at: null,
+        closed_at: null,
+        target_branch: "main",
+        source_branch: "feature/two",
+        web_url: "https://gitlab.mock/my-group/project-b/-/merge_requests/4",
+        merge_commit_sha: null,
+        author: {
+            id: 2,
+            username: "other-user",
+            name: "Other User",
+        },
+    },
+];
+async function callListGroupMergeRequests(args, env) {
+    return new Promise((resolve, reject) => {
+        const proc = spawn("node", ["build/index.js"], {
+            stdio: ["pipe", "pipe", "pipe"],
+            env: {
+                ...process.env,
+                ...env,
+                GITLAB_READ_ONLY_MODE: "true",
+            },
+        });
+        let output = "";
+        let errorOutput = "";
+        proc.stdout?.on("data", d => (output += d));
+        proc.stderr?.on("data", d => (errorOutput += d));
+        proc.on("close", code => {
+            if (code !== 0)
+                return reject(new Error(`Process exited with code ${code}: ${errorOutput}`));
+            const line = output.split("\n").find(l => l.startsWith("{"));
+            if (!line)
+                return reject(new Error("No JSON output found"));
+            try {
+                const response = JSON.parse(line);
+                if (response.error) {
+                    reject(response.error);
+                }
+                else {
+                    const content = response.result?.content?.[0]?.text;
+                    if (content) {
+                        try {
+                            resolve(JSON.parse(content));
+                        }
+                        catch {
+                            reject(new Error(`Failed to parse tool output JSON: ${content}`));
+                        }
+                    }
+                    else {
+                        resolve(response.result);
+                    }
+                }
+            }
+            catch (e) {
+                reject(e);
+            }
+        });
+        proc.stdin?.end(JSON.stringify({
+            jsonrpc: "2.0",
+            id: 1,
+            method: "tools/call",
+            params: { name: "list_group_merge_requests", arguments: args },
+        }) + "\n");
+    });
+}
+describe("list_group_merge_requests", () => {
+    let mockGitLab;
+    let mockGitLabUrl;
+    let capturedUrl;
+    before(async () => {
+        const mockPort = await findMockServerPort();
+        mockGitLab = new MockGitLabServer({
+            port: mockPort,
+            validTokens: [MOCK_TOKEN],
+        });
+        await mockGitLab.start();
+        mockGitLabUrl = mockGitLab.getUrl();
+        mockGitLab.addMockHandler("get", `/groups/${encodeURIComponent(TEST_GROUP_ID)}/merge_requests`, (req, res) => {
+            capturedUrl = req.originalUrl;
+            res.json(groupMergeRequests);
+        });
+    });
+    beforeEach(() => {
+        capturedUrl = undefined;
+    });
+    after(async () => {
+        await mockGitLab.stop();
+    });
+    test("lists merge requests of every project in the group", async () => {
+        const mrs = await callListGroupMergeRequests({ group_id: TEST_GROUP_ID }, {
+            GITLAB_API_URL: `${mockGitLabUrl}/api/v4`,
+            GITLAB_PERSONAL_ACCESS_TOKEN: MOCK_TOKEN,
+        });
+        assert.ok(Array.isArray(mrs), "Response should be an array");
+        assert.strictEqual(mrs.length, 2, "Should return the 2 mock MRs");
+        assert.strictEqual(mrs[0].title, "Group MR 1");
+        assert.notStrictEqual(String(mrs[0].project_id), String(mrs[1].project_id), "MRs should come from different projects");
+    });
+    test("forwards group-specific and shared filters as query parameters", async () => {
+        await callListGroupMergeRequests({
+            group_id: TEST_GROUP_ID,
+            state: "opened",
+            non_archived: true,
+            source_project_id: "123",
+            labels: ["backend", "urgent"],
+            approved_by_usernames: ["alice", "bob"],
+        }, {
+            GITLAB_API_URL: `${mockGitLabUrl}/api/v4`,
+            GITLAB_PERSONAL_ACCESS_TOKEN: MOCK_TOKEN,
+        });
+        assert.ok(capturedUrl, "Mock handler should have received a request");
+        assert.match(capturedUrl, /state=opened/, "Request URL should carry state");
+        assert.match(capturedUrl, /non_archived=true/, "Request URL should carry non_archived");
+        assert.match(capturedUrl, /source_project_id=123/, "Request URL should carry source_project_id");
+        assert.match(capturedUrl, /labels=backend%2Curgent/, "Labels should be comma-joined");
+        assert.match(capturedUrl, /approved_by_usernames%5B%5D=alice/, "approved_by_usernames should use bracket-array form (URL-encoded)");
+        assert.match(capturedUrl, /approved_by_usernames%5B%5D=bob/);
+    });
+    test("drops the mutually exclusive *_id filter when a *_username is given", async () => {
+        await callListGroupMergeRequests({ group_id: TEST_GROUP_ID, author_id: "7", author_username: "alice" }, {
+            GITLAB_API_URL: `${mockGitLabUrl}/api/v4`,
+            GITLAB_PERSONAL_ACCESS_TOKEN: MOCK_TOKEN,
+        });
+        assert.ok(capturedUrl, "Mock handler should have received a request");
+        assert.match(capturedUrl, /author_username=alice/, "author_username should be forwarded");
+        assert.doesNotMatch(capturedUrl, /author_id=/, "author_id should be dropped");
+    });
+});