@uarlouski/testrail-mcp-server 1.2.0 → 1.3.1

package/{src/tools/get_sections.ts → dist/tools/get_sections.js}

@@ -1,23 +1,16 @@
 import { z } from "zod";
-import { TestRailClient } from "../client/testrail.js";
-import { ToolDefinition } from "../types/custom.js";
 import { SectionSchema } from "../types/testrail.js";
-
 const parameters = {
-    project_id: z.string().describe("The ID of the project"),
+    project_id: z.string().describe("The ID of the project. Use get_projects to find available projects"),
 };
-
-export const getSectionsTool: ToolDefinition<typeof parameters, TestRailClient> = {
+export const getSectionsTool = {
     name: "get_sections",
-    description: "Get all sections for a project. Returns section IDs and names. Use this to find the section_id needed for create_case.",
+    description: "Get all sections for a project. Returns section IDs and names that can be used with create_case",
     parameters,
     handler: async ({ project_id }, client) => {
         const sections = await client.getSections(project_id);
-
-        const response = {
+        return {
             sections: sections.map(s => SectionSchema.parse(s)),
         };
-
-        return response;
     }
 };

package/dist/tools/get_statuses.js

@@ -0,0 +1,13 @@
+import { StatusSchema } from "../types/testrail.js";
+const parameters = {};
+export const getStatusesTool = {
+    name: "get_statuses",
+    description: "Get all available test statuses (e.g. Passed, Failed, Blocked). Returns status IDs and names that can be used with add_result and get_tests",
+    parameters,
+    handler: async (args, client) => {
+        const statuses = await client.getStatuses();
+        return {
+            statuses: statuses.map(s => StatusSchema.parse(s)),
+        };
+    },
+};

package/dist/tools/get_templates.js

@@ -0,0 +1,16 @@
+import { z } from "zod";
+import { TemplateSchema } from "../types/testrail.js";
+const parameters = {
+    project_id: z.string().describe("The ID of the project. Use get_projects to find available projects"),
+};
+export const getTemplatesTool = {
+    name: "get_templates",
+    description: "Get available test case templates for a project. Template IDs determine which fields are available when creating or updating test cases",
+    parameters,
+    handler: async ({ project_id }, client) => {
+        const templates = await client.getTemplates(project_id);
+        return {
+            templates: templates.map(t => TemplateSchema.parse(t)),
+        };
+    }
+};

package/dist/tools/get_tests.js

@@ -0,0 +1,17 @@
+import { z } from "zod";
+import { TestSchema } from "../types/testrail.js";
+const parameters = {
+    run_id: z.number().describe("The ID of the test run"),
+    status_id: z.array(z.number()).optional().describe("Optional array of status IDs to filter by. Use get_statuses to retrieve available status IDs"),
+};
+export const getTestsTool = {
+    name: "get_tests",
+    description: "Get tests for a test run, optionally filtered by status",
+    parameters,
+    handler: async ({ run_id, status_id }, client) => {
+        const tests = await client.getTests(run_id, status_id);
+        return {
+            tests: tests.map(test => TestSchema.parse(test)),
+        };
+    },
+};

package/{src/tools/update_case.ts → dist/tools/update_case.js}

@@ -1,21 +1,15 @@
 import { z } from "zod";
-import { TestRailClient } from "../client/testrail.js";
-import { ToolDefinition } from "../types/custom.js";
-
 const parameters = {
     case_id: z.string().describe("The ID of the test case to update (e.g. '123' or 'C123')"),
     fields: z.record(z.string(), z.any()).describe("Object containing fields to update. Use get_case_fields to see available fields. Example: {\"title\": \"New title\", \"priority_id\": 2, \"custom_automation_priority\": 1}"),
 };
-
-export const updateCaseTool: ToolDefinition<typeof parameters, TestRailClient> = {
+export const updateCaseTool = {
     name: "update_case",
-    description: "Update a test case in TestRail. Supports partial updates - only specify the fields you want to change. Use get_case_fields to see available fields and their types.",
+    description: "Update a test case in TestRail. Supports partial updates - only specify the fields you want to change",
     parameters,
     handler: async ({ case_id, fields }, client) => {
         const id = case_id.toUpperCase().startsWith("C") ? case_id.substring(1) : case_id;
-
         const updatedCase = await client.updateCase(id, fields);
-
         return {
             success: true,
             case_id: updatedCase.id,

package/{src/tools/update_cases.ts → dist/tools/update_cases.js}

@@ -1,19 +1,15 @@
 import { z } from "zod";
-import { TestRailClient } from "../client/testrail.js";
-import { ToolDefinition } from "../types/custom.js";
-
 const parameters = {
     case_ids: z.array(z.number()).describe("Array of case IDs to update (e.g. [123, 456, 789])"),
     fields: z.record(z.string(), z.any()).describe("Object containing fields to update for ALL specified cases. Use get_case_fields to see available fields. Example: {\"priority_id\": 2, \"type_id\": 1}"),
 };
-
-export const updateCasesTool: ToolDefinition<typeof parameters, TestRailClient> = {
+export const updateCasesTool = {
     name: "update_cases",
-    description: "Bulk update multiple test cases with the same field values. More efficient than calling update_case multiple times. All cases will receive the same field values.",
+    description: "Bulk update multiple test cases with the same field values. More efficient than calling update_case multiple times",
     parameters,
     handler: async ({ case_ids, fields }, client) => {
-        const updatedCases = await client.updateCases(case_ids, fields);
-
+        const caseData = await client.getCase(String(case_ids[0]));
+        const updatedCases = await client.updateCases(caseData.suite_id, case_ids, fields);
         return {
             success: true,
             updated_count: updatedCases.length,

package/dist/types/custom.js

@@ -0,0 +1 @@
+export {};

package/{src/types/testrail.ts → dist/types/testrail.js}

@@ -1,5 +1,4 @@
 import { z } from "zod";
-
 export const CaseFieldConfigSchema = z.object({
     options: z.object({
         default_value: z.string().optional(),
@@ -7,9 +6,6 @@ export const CaseFieldConfigSchema = z.object({
         items: z.string().optional(),
     }),
 });
-
-export type CaseFieldConfig = z.infer<typeof CaseFieldConfigSchema>;
-
 export const CaseFieldSchema = z.object({
     id: z.number(),
     name: z.string(),
@@ -22,9 +18,6 @@ export const CaseFieldSchema = z.object({
     include_all: z.boolean(),
     configs: z.array(CaseFieldConfigSchema),
 });
-
-export type CaseField = z.infer<typeof CaseFieldSchema>;
-
 export const CaseSchema = z.object({
     id: z.number(),
     title: z.string(),
@@ -40,9 +33,6 @@ export const CaseSchema = z.object({
     suite_id: z.number(),
     labels: z.array(z.any()),
 }).loose();
-
-export type Case = z.infer<typeof CaseSchema>;
-
 export const SectionSchema = z.object({
     id: z.number(),
     name: z.string(),
@@ -50,38 +40,61 @@ export const SectionSchema = z.object({
     parent_id: z.number().nullish(),
     suite_id: z.number(),
 });
-
-export type Section = z.infer<typeof SectionSchema>;
-
 export const PrioritySchema = z.object({
     id: z.number(),
     is_default: z.boolean(),
     name: z.string(),
 });
-
-export type Priority = z.infer<typeof PrioritySchema>;
-
 export const CaseTypeSchema = z.object({
     id: z.number(),
     is_default: z.boolean(),
     name: z.string(),
 });
-
-export type CaseType = z.infer<typeof CaseTypeSchema>;
-
 export const TemplateSchema = z.object({
     id: z.number(),
     name: z.string(),
     is_default: z.boolean(),
 });
-
-export type Template = z.infer<typeof TemplateSchema>;
-
 export const ProjectSchema = z.object({
     id: z.number(),
     name: z.string(),
     is_completed: z.boolean(),
     suite_mode: z.number(),
 });
-
-export type Project = z.infer<typeof ProjectSchema>;
+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(),
+});

package/{src/utils/mapper.ts → dist/utils/mapper.js}

@@ -1,73 +1,55 @@
-import { Case, CaseField } from "../types/testrail.js";
 import { sanitizeValue } from "./sanitizer.js";
-
 /**
  * Processes custom fields from a test case, converting system names to human-readable labels
  * and mapping dropdown values to their display text.
  */
-export function processCustomFields(
-    testCase: Case,
-    caseFields: CaseField[]
-): Record<string, any> {
+export function processCustomFields(testCase, caseFields) {
     if (!testCase) {
         throw new Error("Test case is undefined or null");
     }
-
     const templateId = testCase.template_id;
-    const result: Record<string, any> = {};
-
-    const applicableFields = caseFields.filter(field =>
-        field.include_all || field.template_ids.includes(templateId)
-    );
-
-    const fieldNameMap = new Map<string, string>();
-    const dropdownOptionsMap = new Map<string, Map<string, string>>();
-
+    const result = {};
+    const applicableFields = caseFields.filter(field => field.include_all || field.template_ids.includes(templateId));
+    const fieldNameMap = new Map();
+    const dropdownOptionsMap = new Map();
     for (const field of applicableFields) {
         fieldNameMap.set(field.system_name, toSnakeCase(field.label));
-
         const optionsMap = parseDropdownOptions(field);
         if (optionsMap.size > 0) {
             dropdownOptionsMap.set(field.system_name, optionsMap);
         }
     }
-
     for (const [key, value] of Object.entries(testCase)) {
-        if (!key.startsWith("custom_")) continue;
-        if (value === null || value === undefined) continue;
-
+        if (!key.startsWith("custom_"))
+            continue;
+        if (value === null || value === undefined)
+            continue;
         if (!fieldNameMap.has(key)) {
             console.error(`No field mapping found for: ${key}`);
             result[key] = value;
             continue;
         }
-
-        const outputKey = fieldNameMap.get(key)!;
+        const outputKey = fieldNameMap.get(key);
         let finalValue = value;
-
         if (dropdownOptionsMap.has(key)) {
-            const options = dropdownOptionsMap.get(key)!;
+            const options = dropdownOptionsMap.get(key);
             const optionKey = String(value);
             finalValue = options.get(optionKey) || value;
         }
-
         result[outputKey] = sanitizeValue(finalValue);
     }
-
     return result;
 }
-
 /**
  * Parse dropdown options from field configs.
  * Format: "1, First\n2, Second\n3, Third"
  */
-export function parseDropdownOptions(field: CaseField): Map<string, string> {
-    const options = new Map<string, string>();
-
+export function parseDropdownOptions(field) {
+    const options = new Map();
     for (const config of field.configs) {
         const items = config.options?.items;
-        if (!items) continue;
-
+        if (!items)
+            continue;
         const lines = items.split('\n');
         for (const line of lines) {
             const commaIndex = line.indexOf(',');
@@ -78,11 +60,9 @@ export function parseDropdownOptions(field: CaseField): Map<string, string> {
             }
         }
     }
-
     return options;
 }
-
-function toSnakeCase(str: string): string {
+function toSnakeCase(str) {
     return str
         .toLowerCase()
         .replace(/[^a-z0-9]+/g, '_')

package/{src/utils/sanitizer.ts → dist/utils/sanitizer.js}

@@ -3,7 +3,7 @@
  * in an object or array. Useful for cleaning up TestRail markdown content before sending
  * to LLMs.
  */
-export function sanitizeValue(value: any): any {
+export function sanitizeValue(value) {
     if (typeof value === 'string') {
         return value.replace(/\s*style\s*=\s*["'][^"']*["']/gi, '');
     }
@@ -11,7 +11,7 @@ export function sanitizeValue(value: any): any {
         return value.map(sanitizeValue);
     }
     if (value !== null && typeof value === 'object') {
-        const result: Record<string, any> = {};
+        const result = {};
         for (const [key, val] of Object.entries(value)) {
             result[key] = sanitizeValue(val);
         }
@@ -19,24 +19,21 @@ export function sanitizeValue(value: any): any {
     }
     return value;
 }
-
 /**
  * Recursively removes null and undefined values from objects and arrays.
  * For arrays, filters nested object items as well.
  */
-export function removeNullish(value: any): any {
+export function removeNullish(value) {
     if (value == null) {
         return value;
     }
-
     if (Array.isArray(value)) {
         return value
             .map(item => removeNullish(item))
             .filter(item => item != null);
     }
-
     if (typeof value === 'object') {
-        const result: Record<string, any> = {};
+        const result = {};
         for (const [key, val] of Object.entries(value)) {
             const cleanedVal = removeNullish(val);
             if (cleanedVal != null) {
@@ -45,6 +42,5 @@ export function removeNullish(value: any): any {
         }
         return result;
     }
-
     return value;
 }

package/package.json

@@ -1,8 +1,14 @@
 {
   "name": "@uarlouski/testrail-mcp-server",
-  "version": "1.2.0",
+  "version": "1.3.1",
   "description": "Model Context Protocol (MCP) server for TestRail integration, enabling LLMs to fetch test cases and metadata.",
-  "main": "index.js",
+  "main": "dist/index.js",
+  "bin": {
+    "testrail-mcp-server": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
   "type": "module",
   "scripts": {
     "build": "rimraf dist && tsc",
@@ -34,10 +40,12 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.25.3",
+    "archiver": "^7.0.1",
     "dotenv": "^17.2.3",
     "zod": "^4.3.5"
   },
   "devDependencies": {
+    "@types/archiver": "^7.0.0",
     "@types/jest": "^30.0.0",
     "@types/node": "^25.0.9",
     "jest": "^30.2.0",

package/.env.example

@@ -1,3 +0,0 @@
-TESTRAIL_INSTANCE_URL=https://mock.testrail.io
-TESTRAIL_USERNAME=mock@example.com
-TESTRAIL_API_KEY=mock_api_key

package/.github/workflows/ci.yml

@@ -1,46 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches: ["main"]
-  pull_request:
-    branches: ["main"]
-
-jobs:
-  build-and-test:
-    name: Build and Test (Node ${{ matrix.node-version }})
-    runs-on: ubuntu-latest
-
-    strategy:
-      matrix:
-        node-version: [18.x, 20.x, 22.x]
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: "npm"
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run tests
-        run: npm test
-
-      - name: Run tests with coverage
-        run: npm run test:coverage
-
-      - name: Build project
-        run: npm run build
-
-      - name: Upload coverage reports
-        uses: actions/upload-artifact@v4
-        if: matrix.node-version == '20.x'
-        with:
-          name: coverage-report
-          path: coverage/
-          retention-days: 7

package/.github/workflows/publish.yml

@@ -1,35 +0,0 @@
-name: Publish to NPM
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  publish:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      id-token: write
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: "20.x"
-          registry-url: "https://registry.npmjs.org"
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Run tests
-        run: npm test
-
-      - name: Build package
-        run: npm run build
-
-      - name: Publish to NPM
-        run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/CHANGELOG.md

@@ -1,27 +0,0 @@
-# Changelog
-
-## [1.2.0] - 2026-02-14
-
-### Changed
-
-- Optimize MCP call responses by removing non-essential fields and nullish values
-- Migrated from `axios` to native `fetch` API for reduced dependency footprint
-
-## [1.1.0] - 2026-02-09
-
-### Added
-
-- **Configuration via environment variables**
-    - `TESTRAIL_INSTANCE_URL` - Your TestRail instance URL
-    - `TESTRAIL_USERNAME` - Your TestRail username
-    - `TESTRAIL_API_KEY` - [How to get your API key](https://support.testrail.com/hc/en-us/articles/7077039051412-Accessing-the-TestRail-API)
-
-- **Test case management tools**
-    - `get_projects` - Discover available projects in your TestRail instance
-    - `get_case` - Fetch detailed test case info including custom fields
-    - `get_cases` - Query cases with filtering and pagination support
-    - `get_case_fields` - Explore available fields and dropdown options
-    - `get_templates` - List project templates to understand case structures
-    - `get_sections` - Navigate the test case hierarchy
-    - `create_case` - Create new test cases with full custom field support
-    - `update_case` / `update_cases` - Modify single or bulk update cases

package/jest.config.js

@@ -1,24 +0,0 @@
-export default {
-    preset: 'ts-jest/presets/default-esm',
-    testEnvironment: 'node',
-    extensionsToTreatAsEsm: ['.ts'],
-    moduleNameMapper: {
-        '^(\\.{1,2}/.*)\\.js$': '$1',
-    },
-    transform: {
-        '^.+\\.tsx?$': [
-            'ts-jest',
-            {
-                useESM: true,
-            },
-        ],
-    },
-    coverageThreshold: {
-        global: {
-            branches: 95,
-            functions: 95,
-            lines: 95,
-            statements: 95,
-        },
-    },
-};