@uarlouski/testrail-mcp-server 1.3.0 → 1.4.0

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.3.0",
+  "version": "1.4.0",
   "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",

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,38 +0,0 @@
-# Changelog
-
-## [1.3.0] - 2026-02-18
-
-### Added
-
-- **Test run and result management tools**
-    - `add_run` - Create a new test run in TestRail
-    - `get_tests` - Get tests for a test run, optionally filtered by status
-    - `add_results` - Add one or more test results to a test run
-    - `get_statuses` - Get all available test statuses (e.g. Passed, Failed, Blocked)
-- Add `add_attachment_to_run` tool to attach files to test runs
-
-## [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,
-        },
-    },
-};

package/src/client/testrail.ts

@@ -1,227 +0,0 @@
-import { Case, Section, Priority, CaseType, CaseField, Template, Project, Run, Status, Test, Result, Attachment } from "../types/testrail.js";
-
-import * as fs from "fs";
-
-interface PaginatedCasesResponse {
-    cases: Case[];
-    _links: { next: string | null };
-}
-
-interface PaginatedTestsResponse {
-    tests: Test[];
-    _links: { next: string | null };
-}
-
-const API_INDEX = '/index.php?';
-const API_BASE_V2 = `${API_INDEX}/api/v2`;
-
-export class TestRailClient {
-    private baseUrl: string;
-    private headers: HeadersInit;
-    private auth: string;
-    private prioritiesPromise: Promise<Priority[]> | null = null;
-    private caseTypesPromise: Promise<CaseType[]> | null = null;
-    private caseFieldsPromise: Promise<CaseField[]> | null = null;
-    private statusesPromise: Promise<Status[]> | null = null;
-    private projectsPromise: Promise<Project[]> | null = null;
-    private templatesPromiseMap: Map<string, Promise<Template[]>> = new Map();
-
-    constructor(baseUrl: string, email: string, apiKey: string) {
-        this.baseUrl = baseUrl.replace(/\/$/, "");
-        const auth = Buffer.from(`${email}:${apiKey}`).toString('base64');
-        this.auth = `Basic ${auth}`;
-        this.headers = {
-            "Content-Type": "application/json",
-            "Authorization": this.auth,
-        };
-    }
-
-    async getCase(caseId: string): Promise<Case> {
-        return this.get<Case>(`${API_BASE_V2}/get_case/${caseId}`);
-    }
-
-    async getCases(projectId: string, sectionId?: string, filter?: Record<string, string>): Promise<Case[]> {
-        let url = `${API_BASE_V2}/get_cases/${projectId}`;
-
-        if (sectionId) {
-            url += `&section_id=${sectionId}`;
-        }
-
-        if (filter) {
-            for (const [key, value] of Object.entries(filter)) {
-                url += `&${key}=${encodeURIComponent(value)}`;
-            }
-        }
-
-        const allCases: Case[] = [];
-        let nextUrl: string | null = url;
-
-        while (nextUrl) {
-            const response: PaginatedCasesResponse = await this.get<PaginatedCasesResponse>(nextUrl);
-
-            allCases.push(...response.cases);
-
-            nextUrl = response._links?.next;
-            if (nextUrl) {
-                nextUrl = `${API_INDEX}${nextUrl}`;
-            }
-        }
-
-        return allCases;
-    }
-
-    async getSection(sectionId: string): Promise<Section> {
-        return this.get<Section>(`${API_BASE_V2}/get_section/${sectionId}`);
-    }
-
-    async getPriorities(): Promise<Priority[]> {
-        if (!this.prioritiesPromise) {
-            this.prioritiesPromise = this.get<Priority[]>(`${API_BASE_V2}/get_priorities`);
-        }
-        return this.prioritiesPromise;
-    }
-
-    async getCaseTypes(): Promise<CaseType[]> {
-        if (!this.caseTypesPromise) {
-            this.caseTypesPromise = this.get<CaseType[]>(`${API_BASE_V2}/get_case_types`);
-        }
-        return this.caseTypesPromise;
-    }
-
-    async getCaseFields(): Promise<CaseField[]> {
-        if (!this.caseFieldsPromise) {
-            this.caseFieldsPromise = this.get<CaseField[]>(`${API_BASE_V2}/get_case_fields`);
-        }
-        return this.caseFieldsPromise;
-    }
-
-    async getStatuses(): Promise<Status[]> {
-        if (!this.statusesPromise) {
-            this.statusesPromise = this.get<Status[]>(`${API_BASE_V2}/get_statuses`);
-        }
-        return this.statusesPromise;
-    }
-
-    async getTemplates(projectId: string): Promise<Template[]> {
-        if (!this.templatesPromiseMap.has(projectId)) {
-            this.templatesPromiseMap.set(
-                projectId,
-                this.get<Template[]>(`${API_BASE_V2}/get_templates/${projectId}`)
-            );
-        }
-        return this.templatesPromiseMap.get(projectId)!;
-    }
-
-    async updateCase(caseId: string, fields: Record<string, any>): Promise<Case> {
-        return this.post<Case>(`${API_BASE_V2}/update_case/${caseId}`, fields);
-    }
-
-    async updateCases(suiteId: number, caseIds: number[], fields: Record<string, any>): Promise<Case[]> {
-        const response = await this.post<{ updated_cases: Case[] }>(`${API_BASE_V2}/update_cases/${suiteId}`, {
-            case_ids: caseIds,
-            ...fields,
-        });
-
-        return response.updated_cases;
-    }
-
-    async createCase(sectionId: string, fields: Record<string, any>): Promise<Case> {
-        return this.post<Case>(`${API_BASE_V2}/add_case/${sectionId}`, fields);
-    }
-
-    async addRun(projectId: string, fields: Record<string, any>): Promise<Run> {
-        return this.post<Run>(`${API_BASE_V2}/add_run/${projectId}`, fields);
-    }
-
-    async getSections(projectId: string): Promise<Section[]> {
-        const response = await this.get<{ sections: Section[] }>(`${API_BASE_V2}/get_sections/${projectId}`);
-        return response.sections;
-    }
-
-    async getProjects(): Promise<Project[]> {
-        if (!this.projectsPromise) {
-            this.projectsPromise = this.get<{ projects: Project[] }>(`${API_BASE_V2}/get_projects`)
-                .then(response => response.projects);
-        }
-        return this.projectsPromise;
-    }
-
-
-    async getTests(runId: number, statusId?: number[]): Promise<Test[]> {
-        let url = `${API_BASE_V2}/get_tests/${runId}`;
-
-        if (statusId && statusId.length > 0) {
-            url += `&status_id=${statusId.join(',')}`;
-        }
-
-        const allTests: Test[] = [];
-        let nextUrl: string | null = url;
-
-        while (nextUrl) {
-            const response: PaginatedTestsResponse = await this.get<PaginatedTestsResponse>(nextUrl);
-            allTests.push(...response.tests);
-
-            nextUrl = response._links?.next;
-            if (nextUrl) {
-                nextUrl = `${API_INDEX}${nextUrl}`;
-            }
-        }
-
-        return allTests;
-    }
-
-
-    async addResults(runId: number, results: Array<Record<string, any>>): Promise<Result[]> {
-        return this.post<Result[]>(`${API_BASE_V2}/add_results/${runId}`, { results });
-    }
-
-    async addAttachmentToRun(runId: number, filePath: string, filename: string): Promise<Attachment> {
-        const fileBuffer = await fs.promises.readFile(filePath);
-        const blob = new Blob([fileBuffer]);
-        const formData = new FormData();
-        formData.append('attachment', blob, filename);
-
-        const headers: HeadersInit = {
-            'Authorization': this.auth,
-        };
-
-        return this._executeRequest<Attachment>('POST', `${API_BASE_V2}/add_attachment_to_run/${runId}`, headers, formData);
-    }
-
-    private async get<T>(endpoint: string): Promise<T> {
-        return this.executeRequest<T>('GET', endpoint);
-    }
-
-    private async post<T>(endpoint: string, data: Record<string, any>): Promise<T> {
-        return this.executeRequest<T>('POST', endpoint, data);
-    }
-
-    private async executeRequest<T>(method: 'GET' | 'POST', endpoint: string, data?: Record<string, any>): Promise<T> {
-        let jsonData = undefined;
-        if (data) {
-            jsonData = JSON.stringify(data);
-        }
-
-        return this._executeRequest<T>(method, endpoint, this.headers, jsonData);
-    }
-
-    private async _executeRequest<T>(method: 'GET' | 'POST', endpoint: string, headers: HeadersInit, body?: any): Promise<T> {
-        const url = `${this.baseUrl}${endpoint}`;
-        const params: RequestInit = {
-            method,
-            headers,
-            body,
-        };
-
-        const response = await fetch(url, params);
-
-        if (!response.ok) {
-            let errorMessage = `TestRail: ${response.status} ${response.statusText}`;
-            const errorText = await response.text();
-            errorMessage += ` - ${errorText}`;
-            throw new Error(errorMessage);
-        }
-
-        return await response.json() as T;
-    }
-}

package/src/types/custom.ts

@@ -1,19 +0,0 @@
-import { z } from "zod";
-
-export interface TestCaseResponse {
-    id: number;
-    title: string;
-    section: string;
-    type: string;
-    priority: string;
-    labels: string[];
-    references: string | null;
-    [key: string]: any;
-}
-
-export interface ToolDefinition<T extends z.ZodRawShape, Context = any> {
-    name: string;
-    description: string;
-    parameters: T;
-    handler: (args: z.infer<z.ZodObject<T>>, context: Context) => Promise<Record<string, any>>;
-}