import { z } from "zod";
import { flexibleBoolean, paginationFields, requiredId } from "../utils";
// Pipeline related schemas
export const GitLabPipelineSchema = z.object({
id: z.coerce.string(),
project_id: z.coerce.string(),
sha: z.string(),
ref: z.string(),
status: z.string(),
source: z.string().optional(),
created_at: z.string(),
updated_at: z.string(),
web_url: z.string(),
duration: z.number().nullable().optional(),
started_at: z.string().nullable().optional(),
finished_at: z.string().nullable().optional(),
coverage: z.coerce.number().nullable().optional(),
user: z
.object({
id: z.coerce.string(),
name: z.string(),
username: z.string(),
avatar_url: z.string().nullable().optional(),
})
.optional(),
detailed_status: z
.object({
icon: z.string().optional(),
text: z.string().optional(),
label: z.string().optional(),
group: z.string().optional(),
tooltip: z.string().optional(),
has_details: flexibleBoolean.optional(),
details_path: z.string().optional(),
illustration: z
.object({
image: z.string().optional(),
size: z.string().optional(),
title: z.string().optional(),
})
.nullable()
.optional(),
favicon: z.string().optional(),
})
.optional(),
});
// Pipeline job related schemas
export const GitLabPipelineJobSchema = z.object({
id: z.coerce.string(),
status: z.string(),
stage: z.string(),
name: z.string(),
ref: z.string(),
tag: flexibleBoolean,
coverage: z.coerce.number().nullable().optional(),
allow_failure: flexibleBoolean.optional(),
created_at: z.string(),
started_at: z.string().optional(),
finished_at: z.string().optional(),
duration: z.number().optional(),
queued_duration: z.number().optional(),
user: z
.object({
id: z.coerce.string(),
name: z.string(),
username: z.string(),
state: z.string(),
avatar_url: z.string().nullable().optional(),
web_url: z.string(),
})
.optional(),
commit: z
.object({
id: z.string(),
short_id: z.string(),
title: z.string(),
author_name: z.string(),
author_email: z.string(),
created_at: z.string(),
message: z.string(),
})
.optional(),
pipeline: z
.object({
id: z.coerce.string(),
project_id: z.coerce.string(),
ref: z.string(),
sha: z.string(),
status: z.string(),
})
.optional(),
web_url: z.string(),
});
// Pipeline trigger job (bridge) schema
export const GitLabPipelineTriggerJobSchema = z.object({
id: z.coerce.string(),
status: z.string(),
stage: z.string(),
name: z.string(),
ref: z.string(),
tag: flexibleBoolean,
coverage: z.coerce.number().nullable().optional(),
allow_failure: flexibleBoolean.optional(),
created_at: z.string(),
started_at: z.string().optional(),
finished_at: z.string().optional(),
duration: z.number().optional(),
queued_duration: z.number().optional(),
user: z
.object({
id: z.coerce.string(),
name: z.string(),
username: z.string(),
state: z.string(),
avatar_url: z.string().nullable().optional(),
web_url: z.string(),
})
.optional(),
commit: z
.object({
id: z.string(),
short_id: z.string(),
title: z.string(),
author_name: z.string(),
author_email: z.string(),
created_at: z.string(),
message: z.string(),
})
.optional(),
pipeline: z
.object({
id: z.coerce.string(),
project_id: z.coerce.string(),
ref: z.string(),
sha: z.string(),
status: z.string(),
})
.optional(),
web_url: z.string(),
downstream_pipeline: z
.object({
id: z.coerce.string(),
sha: z.string(),
ref: z.string(),
status: z.string(),
created_at: z.string(),
updated_at: z.string(),
web_url: z.string(),
})
.optional(),
});
// ============================================================================
// Shared enums for pipeline filtering
// ============================================================================
const PipelineScopeSchema = z
.enum(["running", "pending", "finished", "branches", "tags"])
.describe("The scope of pipelines to return");
const PipelineStatusSchema = z
.enum([
"created",
"waiting_for_resource",
"preparing",
"pending",
"running",
"success",
"failed",
"canceled",
"skipped",
"manual",
"scheduled",
])
.describe("The status of pipelines to return");
const PipelineSourceSchema = z
.enum([
"push",
"web",
"trigger",
"schedule",
"api",
"external",
"chat",
"webide",
"merge_request_event",
"external_pull_request_event",
"parent_pipeline",
"ondemand_dast_scan",
"ondemand_dast_validation",
])
.describe("The source of pipelines");
const JobScopeSchema = z
.enum(["created", "pending", "running", "failed", "success", "canceled", "skipped", "manual"])
.describe("Scope of jobs to show");
const TriggerJobScopeSchema = z
.enum([
"created",
"pending",
"running",
"failed",
"success",
"canceled",
"skipped",
"manual",
"waiting_for_resource",
"preparing",
])
.describe("Scope of trigger jobs to show");
// ============================================================================
// browse_pipelines - CQRS Query Tool (discriminated union schema)
// Actions: list, get, jobs, triggers, job, logs
// Uses z.discriminatedUnion() for type-safe action handling.
// Schema pipeline flattens to flat JSON Schema for AI clients that don't support oneOf.
// ============================================================================
// --- Shared fields ---
const projectIdField = requiredId.describe("Project ID or URL-encoded path");
// --- Action: list ---
const ListPipelinesSchema = z.object({
action: z.literal("list").describe("List pipelines with filtering"),
project_id: projectIdField,
scope: PipelineScopeSchema.optional().describe("Pipeline scope filter"),
status: PipelineStatusSchema.optional().describe("Pipeline status filter"),
source: PipelineSourceSchema.optional().describe("Pipeline source filter"),
ref: z.string().optional().describe("Filter by branch or tag ref"),
sha: z.string().optional().describe("Filter by SHA"),
yaml_errors: z.boolean().optional().describe("Filter by YAML errors"),
name: z.string().optional().describe("Filter by name of user who triggered pipeline"),
username: z.string().optional().describe("Filter by username who triggered pipeline"),
updated_after: z.string().optional().describe("ISO 8601 datetime to filter by updated_after"),
updated_before: z.string().optional().describe("ISO 8601 datetime to filter by updated_before"),
order_by: z
.enum(["id", "status", "ref", "updated_at", "user_id"])
.optional()
.describe("Order pipelines by"),
sort: z.enum(["asc", "desc"]).optional().describe("Sort order"),
...paginationFields(),
});
// --- Action: get ---
const GetPipelineSchema = z.object({
action: z.literal("get").describe("Get single pipeline details"),
project_id: projectIdField,
pipeline_id: requiredId.describe("The ID of the pipeline"),
});
// --- Action: jobs ---
const ListPipelineJobsSchema = z.object({
action: z.literal("jobs").describe("List jobs in a pipeline"),
project_id: projectIdField,
pipeline_id: requiredId.describe("The ID of the pipeline"),
job_scope: z.array(JobScopeSchema).optional().describe("Scope of jobs to show"),
include_retried: z.boolean().optional().describe("Include retried jobs in the response"),
...paginationFields(),
});
// --- Action: triggers ---
const ListPipelineTriggersSchema = z.object({
action: z.literal("triggers").describe("List bridge/trigger jobs in a pipeline"),
project_id: projectIdField,
pipeline_id: requiredId.describe("The ID of the pipeline"),
trigger_scope: z
.array(TriggerJobScopeSchema)
.optional()
.describe("Scope of trigger jobs to show"),
include_retried: z.boolean().optional().describe("Include retried jobs in the response"),
...paginationFields(),
});
// --- Action: job ---
const GetJobSchema = z.object({
action: z.literal("job").describe("Get single job details"),
project_id: projectIdField,
job_id: requiredId.describe("The ID of the job"),
});
// --- Action: logs ---
const GetJobLogsSchema = z.object({
action: z.literal("logs").describe("Get job console output/logs"),
project_id: projectIdField,
job_id: requiredId.describe("The ID of the job"),
per_page: z
.number()
.int()
.min(1)
.max(10000)
.optional()
.describe(
"Maximum number of lines to return (default: 200, max: 10000). Use with start for pagination"
),
start: z
.number()
.optional()
.describe(
"Start from specific line number (0-based). Positive from beginning, negative from end (e.g., -100 = last 100 lines). Use nextStart from previous response to paginate"
),
});
// --- Discriminated union combining all actions ---
export const BrowsePipelinesSchema = z.discriminatedUnion("action", [
ListPipelinesSchema,
GetPipelineSchema,
ListPipelineJobsSchema,
ListPipelineTriggersSchema,
GetJobSchema,
GetJobLogsSchema,
]);
// ============================================================================
// Type exports
// ============================================================================
export type BrowsePipelinesInput = z.infer<typeof BrowsePipelinesSchema>;
export type GitLabPipeline = z.infer<typeof GitLabPipelineSchema>;
export type GitLabPipelineJob = z.infer<typeof GitLabPipelineJobSchema>;
export type GitLabPipelineTriggerJob = z.infer<typeof GitLabPipelineTriggerJobSchema>;
