@uarlouski/testrail-mcp-server 1.10.0 → 2.0.0

package/dist/utils/mutate_handler.js

@@ -0,0 +1,22 @@
+/**
+ * Centralized utility to handle mutation actions (create or update) in a type-safe manner.
+ *
+ * @param payload The incoming payload containing the action discriminator
+ * @param onCreate Callback executed when action is "create"
+ * @param onUpdate Callback executed when action is "update"
+ * @returns The mutated entity wrapped in a record
+ */
+export async function handleMutate(payload, onCreate, onUpdate, schema) {
+    let result;
+    if (payload.action === "create") {
+        result = await onCreate(payload);
+    }
+    else if (payload.action === "update") {
+        result = await onUpdate(payload);
+    }
+    else {
+        const unknownAction = payload.action;
+        throw new Error(`Unsupported mutation action: ${unknownAction}`);
+    }
+    return schema ? schema.parse(result) : result;
+}

package/dist/utils/query_handler.js

@@ -0,0 +1,20 @@
+/**
+ * Centralized utility to handle query actions (one or many) in a type-safe manner.
+ *
+ * @param payload The incoming payload containing the action discriminator
+ * @param onQueryOne Callback executed when action is "one"
+ * @param onQueryMany Callback executed when action is "many"
+ * @returns The queried entity or list of entities wrapped in a record
+ */
+export async function handleQuery(payload, onQueryOne, onQueryMany) {
+    if (payload.action === "one") {
+        return onQueryOne(payload);
+    }
+    else if (payload.action === "many") {
+        return onQueryMany(payload);
+    }
+    else {
+        const unknownAction = payload.action;
+        throw new Error(`Unsupported query action: ${unknownAction}`);
+    }
+}

package/dist/utils/sanitizer.js

@@ -44,3 +44,14 @@ export function removeNullish(value) {
     }
     return value;
 }
+/**
+ * Checks if an entity is active by checking its active flag.
+ * Supports passing either the direct primitive value or the parent object containing `.is_active`.
+ */
+export function isActive(value) {
+    if (value == null) {
+        return false;
+    }
+    const activeFlag = (typeof value === 'object') ? value.is_active : value;
+    return activeFlag === 1 || activeFlag === true || activeFlag === '1' || activeFlag === 'true';
+}

package/dist/utils/validator.js

@@ -1,4 +1,5 @@
-import { SYSTEM_FIELDS, mapToFieldSchema } from "../tools/get_case_fields.js";
+import { SYSTEM_FIELDS, mapToFieldSchema } from "../tools/cases/get_case_fields.js";
+import { isActive } from "./sanitizer.js";
 /**
  * Validates that the provided fields exist in the TestRail case schema.
  * Throws an Error if any field is invalid.
@@ -11,7 +12,7 @@ export function validateCaseFields(fields, caseFields) {
     if (fieldKeys.length === 0) {
         return;
     }
-    const customFieldSchemas = caseFields.filter(field => field.is_active).map(mapToFieldSchema);
+    const customFieldSchemas = caseFields.filter(isActive).map(mapToFieldSchema);
     const validFieldNames = new Set([...SYSTEM_FIELDS, ...customFieldSchemas].map(f => f.system_name));
     validFieldNames.add('id');
     validFieldNames.add('suite_id');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uarlouski/testrail-mcp-server",
-  "version": "1.10.0",
+  "version": "2.0.0",
   "mcpName": "io.github.uarlouski/testrail-mcp-server",
   "description": "Model Context Protocol (MCP) server for TestRail integration, enabling LLMs to fetch test cases and metadata.",
   "main": "dist/index.js",

package/dist/tools/add_run.js

@@ -1,19 +0,0 @@
-import { z } from "zod";
-import { RunSchema } from "../types/testrail.js";
-const parameters = {
-    project_id: z.number().describe("The ID of the project. Use get_projects to find available projects"),
-    name: z.string().optional().describe("The name of the test run"),
-    description: z.string().optional().describe("The description of the test run"),
-    case_ids: z.array(z.number()).min(1).describe("Array of case IDs to include in the run. After creating the run, use get_tests with the returned run_id to retrieve test IDs for result submission")
-};
-export const addRunTool = {
-    name: "add_run",
-    description: "Create a new test run in TestRail",
-    parameters,
-    handler: async ({ project_id, ...fields }, client) => {
-        const caseData = await client.getCase(fields.case_ids[0]);
-        const params = { suite_id: caseData.suite_id, include_all: false, ...fields };
-        const run = await client.addRun(project_id, params);
-        return RunSchema.parse(run);
-    },
-};

package/dist/tools/get_projects.js

@@ -1,15 +0,0 @@
-import { ProjectSchema } from "../types/testrail.js";
-const parameters = {};
-export const getProjectsTool = {
-    name: "get_projects",
-    description: "Get all available projects in TestRail. Returns project IDs and names that can be used with get_sections, get_templates, get_cases, and add_run",
-    parameters,
-    handler: async (_args, client) => {
-        const projects = await client.getProjects();
-        return {
-            projects: projects
-                .filter(p => !p.is_completed)
-                .map(p => ProjectSchema.parse(p)),
-        };
-    }
-};

package/dist/tools/shared_steps/delete_shared_step.js

@@ -1,18 +0,0 @@
-import { z } from "zod";
-const parameters = {
-    shared_step_id: z.number().describe("The ID of the shared test step to delete"),
-};
-const description = `
-Deletes an existing shared step entity.
-By default, this removes the shared step entity but keeps the steps in the test cases that used them.
-`;
-export const deleteSharedStepTool = {
-    name: "delete_shared_step",
-    description: description.trim(),
-    parameters,
-    handler: async (args, client) => {
-        const { shared_step_id } = args;
-        await client.deleteSharedStep(shared_step_id);
-        return { message: `Shared step ${shared_step_id} deleted successfully.` };
-    }
-};

package/dist/types/testrail.js

@@ -1,125 +0,0 @@
-import { z } from "zod";
-export const CaseFieldConfigSchema = z.object({
-    context: z.object({
-        is_global: z.boolean(),
-        project_ids: z.array(z.number()),
-    }).optional(),
-    options: z.object({
-        default_value: z.string().optional(),
-        is_required: z.boolean().optional(),
-        items: z.string().optional(),
-    }),
-});
-export const CaseFieldSchema = z.object({
-    id: z.number(),
-    name: z.string(),
-    system_name: z.string(),
-    label: z.string(),
-    type_id: z.number(),
-    template_ids: z.array(z.number()),
-    is_active: z.boolean(),
-    description: z.string().nullable(),
-    include_all: z.boolean(),
-    configs: z.array(CaseFieldConfigSchema),
-});
-export const LabelSchema = z.object({
-    id: z.number(),
-    title: z.string(),
-});
-export const CaseSchema = z.object({
-    id: z.number(),
-    title: z.string(),
-    section_id: z.number(),
-    template_id: z.number(),
-    type_id: z.number(),
-    priority_id: z.number(),
-    milestone_id: z.number().nullable(),
-    refs: z.string().nullable(),
-    created_on: z.number(),
-    updated_on: z.number(),
-    estimate: z.string().nullable(),
-    suite_id: z.number(),
-    labels: z.array(LabelSchema),
-}).loose();
-export const SectionSchema = z.object({
-    id: z.number(),
-    name: z.string(),
-    description: z.string().nullish(),
-    parent_id: z.number().nullish(),
-    suite_id: z.number(),
-});
-export const PrioritySchema = z.object({
-    id: z.number(),
-    is_default: z.boolean(),
-    name: z.string(),
-});
-export const CaseTypeSchema = z.object({
-    id: z.number(),
-    is_default: z.boolean(),
-    name: z.string(),
-});
-export const TemplateSchema = z.object({
-    id: z.number(),
-    name: z.string(),
-    is_default: z.boolean(),
-});
-export const ProjectSchema = z.object({
-    id: z.number(),
-    name: z.string(),
-    is_completed: z.boolean(),
-    suite_mode: z.number(),
-});
-export const RunSchema = z.object({
-    id: z.number(),
-    name: z.string(),
-    description: z.string().nullable(),
-    suite_id: z.number().nullable(),
-    project_id: z.number(),
-    is_completed: z.boolean(),
-    passed_count: z.number(),
-    blocked_count: z.number(),
-    untested_count: z.number(),
-    retest_count: z.number(),
-    failed_count: z.number(),
-    url: z.string(),
-});
-export const StatusSchema = z.object({
-    id: z.number(),
-    name: z.string(),
-    label: z.string(),
-});
-export const TestSchema = z.object({
-    id: z.number(),
-    case_id: z.number(),
-    status_id: z.number(),
-    title: z.string(),
-    run_id: z.number(),
-});
-export const TestsSchema = z.array(TestSchema);
-export const ResultSchema = z.object({
-    id: z.number(),
-    test_id: z.number(),
-    status_id: z.number(),
-    comment: z.string().nullable(),
-    defects: z.string().nullable(),
-});
-export const AttachmentSchema = z.object({
-    attachment_id: z.number(),
-});
-export const SharedStepContentSchema = z.object({
-    content: z.string(),
-    expected: z.string().nullable().optional(),
-});
-export const SharedStepSchema = z.object({
-    id: z.number(),
-    title: z.string(),
-    project_id: z.number().optional(),
-    custom_steps_separated: z.array(SharedStepContentSchema).optional(),
-    case_ids: z.array(z.number()).optional(),
-});
-export const SharedStepHistorySchema = z.object({
-    id: z.number(),
-    title: z.string(),
-    timestamp: z.number().optional(),
-    custom_steps_separated: z.array(SharedStepContentSchema).optional(),
-});