All files / src/entities/workitems schema.ts

100% Statements 5/5
100% Branches 0/0
100% Functions 0/0
100% Lines 5/5

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 683x 3x                                                               3x                           3x                       3x                
import { z } from "zod";
import {
  WorkItemIdSchema,
  WorkItemTypeEnumSchema,
  WorkItemStateEventSchema,
} from "./schema-readonly";
 
/**
 * CRITICAL: GitLab Work Items Hierarchy Rules for MCP Agents
 *
 * Work items in GitLab have STRICT level restrictions that CANNOT be violated:
 *
 * GROUP LEVEL ONLY (use group path in namespace):
 * - Epic work items - ONLY exist at group level, NEVER at project level
 * - Use namespace like "my-group" or "parent-group/sub-group"
 *
 * PROJECT LEVEL ONLY (use project path in namespace):
 * - Issue work items - ONLY exist at project level, NEVER at group level
 * - Task work items - ONLY exist at project level, NEVER at group level
 * - Bug work items - ONLY exist at project level, NEVER at group level
 * - Use namespace like "group/project" or "group/subgroup/project"
 *
 * FORBIDDEN PATTERNS (will always fail):
 * - Creating Epic with project namespace
 * - Creating Issue/Task/Bug with group namespace
 *
 * EXAMPLES:
 * Epic: namespace="my-group", workItemType="EPIC"
 * Issue: namespace="my-group/my-project", workItemType="ISSUE"
 * Task: namespace="my-group/my-project", workItemType="TASK"
 * Epic: namespace="my-group/my-project" (WRONG - will fail)
 * Issue: namespace="my-group" (WRONG - will fail)
 */
export const CreateWorkItemSchema = z.object({
  namespace: z
    .string()
    .describe(
      'CRITICAL: Namespace path (group OR project). For Epics use GROUP path (e.g. "my-group"). For Issues/Tasks use PROJECT path (e.g. "my-group/my-project"). Wrong level will cause creation to fail.'
    ),
  title: z.string().describe("Title of the work item"),
  workItemType: WorkItemTypeEnumSchema,
  description: z.string().optional().describe("Description of the work item"),
  assigneeIds: z.array(z.string()).optional().describe("Array of assignee user IDs"),
  labelIds: z.array(z.string()).optional().describe("Array of label IDs"),
  milestoneId: z.string().optional().describe("Milestone ID"),
});
 
export const UpdateWorkItemSchema = z.object({
  id: WorkItemIdSchema,
  title: z.string().optional().describe("New title for the work item"),
  description: z.string().optional().describe("New description for the work item"),
  state: WorkItemStateEventSchema.optional().describe(
    "State event for the work item (CLOSE, REOPEN)"
  ),
  assigneeIds: z.array(z.string()).optional().describe("Array of assignee user IDs"),
  labelIds: z.array(z.string()).optional().describe("Array of label IDs"),
  milestoneId: z.string().optional().describe("Milestone ID"),
});
 
export const DeleteWorkItemSchema = z.object({
  id: WorkItemIdSchema,
});
 
// Type exports
export type CreateWorkItemOptions = z.infer<typeof CreateWorkItemSchema>;
export type UpdateWorkItemOptions = z.infer<typeof UpdateWorkItemSchema>;
export type DeleteWorkItemOptions = z.infer<typeof DeleteWorkItemSchema>;