@uarlouski/testrail-mcp-server 1.1.0

package/.env.example

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

package/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+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

@@ -0,0 +1,35 @@
+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

@@ -0,0 +1,20 @@
+# Changelog
+
+## [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/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,41 @@
+# TestRail MCP Server
+
+A Model Context Protocol (MCP) server for integrating LLMs with TestRail test case management.
+
+## Usage
+
+```json
+{
+  "mcpServers": {
+    "testrail": {
+      "command": "npx",
+      "args": [
+        "@uarlouski/testrail-mcp-server@latest"
+      ],
+      "env": {
+        "TESTRAIL_INSTANCE_URL": "https://your-instance.testrail.io",
+        "TESTRAIL_USERNAME": "your@email.com",
+        "TESTRAIL_API_KEY": "your-api-key"
+      }
+    }
+  }
+}
+```
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+| `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` | Modify a single test case |
+| `update_cases` | Bulk update multiple cases at once |
+
+## License
+
+Apache 2.0

package/jest.config.js

@@ -0,0 +1,24 @@
+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/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@uarlouski/testrail-mcp-server",
+  "version": "1.1.0",
+  "description": "Model Context Protocol (MCP) server for TestRail integration, enabling LLMs to fetch test cases and metadata.",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "build": "rimraf dist && tsc",
+    "start": "node dist/index.js",
+    "dev": "ts-node src/index.ts",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js",
+    "test:coverage": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage"
+  },
+  "keywords": [
+    "mcp",
+    "model-context-protocol",
+    "testrail",
+    "server",
+    "typescript",
+    "llm",
+    "ai",
+    "testing",
+    "automation"
+  ],
+  "author": "Uladzislau Arlouski",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/uarlouski/testrail-mcp-server.git"
+  },
+  "bugs": {
+    "url": "https://github.com/uarlouski/testrail-mcp-server/issues"
+  },
+  "homepage": "https://github.com/uarlouski/testrail-mcp-server#readme",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.25.3",
+    "axios": "^1.13.2",
+    "dotenv": "^17.2.3",
+    "zod": "^4.3.5"
+  },
+  "devDependencies": {
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.0.9",
+    "jest": "^30.2.0",
+    "rimraf": "^6.1.2",
+    "ts-jest": "^29.4.6",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  }
+}

package/src/client/testrail.ts

@@ -0,0 +1,172 @@
+import axios, { AxiosInstance, AxiosError } from "axios";
+import { Case, Section, Priority, CaseType, CaseField, Template, Project } from "../types/testrail.js";
+
+interface PaginatedCasesResponse {
+    cases: Case[];
+    _links: { next: string | null };
+}
+
+const API_INDEX = '/index.php?';
+const API_BASE_V2 = `${API_INDEX}/api/v2`;
+
+export class TestRailClient {
+    private client: AxiosInstance;
+    private prioritiesPromise: Promise<Priority[]> | null = null;
+    private caseTypesPromise: Promise<CaseType[]> | null = null;
+    private caseFieldsPromise: Promise<CaseField[]> | null = null;
+    private projectsPromise: Promise<Project[]> | null = null;
+    private templatesPromiseMap: Map<string, Promise<Template[]>> = new Map();
+
+    constructor(baseUrl: string, email: string, apiKey: string) {
+        const cleanedBaseUrl = baseUrl.replace(/\/$/, "");
+
+        this.client = axios.create({
+            baseURL: cleanedBaseUrl,
+            headers: {
+                "Content-Type": "application/json",
+            },
+            auth: {
+                username: email,
+                password: apiKey,
+            },
+            validateStatus: (status: number) => {
+                return status >= 200 && status < 300;
+            }
+        });
+    }
+
+    async getCase(caseId: string): Promise<Case> {
+        return this.makeRequest<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.makeRequest<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.makeRequest<Section>(`${API_BASE_V2}/get_section/${sectionId}`);
+    }
+
+    async getPriorities(): Promise<Priority[]> {
+        if (!this.prioritiesPromise) {
+            this.prioritiesPromise = this.makeRequest<Priority[]>(`${API_BASE_V2}/get_priorities`);
+        }
+        return this.prioritiesPromise;
+    }
+
+    async getCaseTypes(): Promise<CaseType[]> {
+        if (!this.caseTypesPromise) {
+            this.caseTypesPromise = this.makeRequest<CaseType[]>(`${API_BASE_V2}/get_case_types`);
+        }
+        return this.caseTypesPromise;
+    }
+
+    async getCaseFields(): Promise<CaseField[]> {
+        if (!this.caseFieldsPromise) {
+            this.caseFieldsPromise = this.makeRequest<CaseField[]>(`${API_BASE_V2}/get_case_fields`);
+        }
+        return this.caseFieldsPromise;
+    }
+
+    async getTemplates(projectId: string): Promise<Template[]> {
+        if (!this.templatesPromiseMap.has(projectId)) {
+            this.templatesPromiseMap.set(
+                projectId,
+                this.makeRequest<Template[]>(`${API_BASE_V2}/get_templates/${projectId}`)
+            );
+        }
+        return this.templatesPromiseMap.get(projectId)!;
+    }
+
+    async updateCase(caseId: string, fields: Record<string, any>): Promise<Case> {
+        return this.postRequest<Case>(`${API_BASE_V2}/update_case/${caseId}`, fields);
+    }
+
+    async updateCases(caseIds: number[], fields: Record<string, any>): Promise<Case[]> {
+        // Assume the project is operating in single suite mode, get suite_id from the first case
+        const caseData = await this.getCase(String(caseIds[0]));
+
+        const response = await this.postRequest<{ updated_cases: Case[] }>(`${API_BASE_V2}/update_cases/${caseData.suite_id}`, {
+            case_ids: caseIds,
+            ...fields,
+        });
+
+        return response.updated_cases;
+    }
+
+    async createCase(sectionId: string, fields: Record<string, any>): Promise<Case> {
+        return this.postRequest<Case>(`${API_BASE_V2}/add_case/${sectionId}`, fields);
+    }
+
+    async getSections(projectId: string): Promise<Section[]> {
+        const response = await this.makeRequest<{ sections: Section[] }>(`${API_BASE_V2}/get_sections/${projectId}`);
+        return response.sections;
+    }
+
+    async getProjects(): Promise<Project[]> {
+        if (!this.projectsPromise) {
+            this.projectsPromise = this.makeRequest<{ projects: Project[] }>(`${API_BASE_V2}/get_projects`)
+                .then(response => response.projects);
+        }
+        return this.projectsPromise;
+    }
+
+    private async makeRequest<T>(url: string): Promise<T> {
+        try {
+            const response = await this.client.get<T>(url);
+            return response.data;
+        } catch (error: any) {
+            throw this.handleError(error);
+        }
+    }
+
+    private async postRequest<T>(url: string, data: Record<string, any>): Promise<T> {
+        try {
+            const response = await this.client.post<T>(url, data);
+            return response.data;
+        } catch (error: any) {
+            throw this.handleError(error);
+        }
+    }
+
+    private handleError(error: any): Error {
+        let errorMessage = `TestRail API error: ${error.message}`;
+
+        if (axios.isAxiosError(error)) {
+            const axiosError = error as AxiosError;
+            if (axiosError.response) {
+                errorMessage = `TestRail API error: ${axiosError.response.status} ${axiosError.response.statusText} - ${JSON.stringify(axiosError.response.data)}`;
+            } else if (axiosError.request) {
+                errorMessage = `TestRail API error: No response received. ${axiosError.message}`;
+            }
+        }
+
+        return new Error(errorMessage);
+    }
+}

package/src/index.ts

@@ -0,0 +1,55 @@
+import "dotenv/config";
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import { TestRailClient } from "./client/testrail.js";
+import { getCaseTool } from "./tools/get_case.js";
+import { getCasesTool } from "./tools/get_cases.js";
+import { getCaseFieldsTool } from "./tools/get_case_fields.js";
+import { getTemplatesTool } from "./tools/get_templates.js";
+import { updateCaseTool } from "./tools/update_case.js";
+import { updateCasesTool } from "./tools/update_cases.js";
+import { createCaseTool } from "./tools/create_case.js";
+import { getSectionsTool } from "./tools/get_sections.js";
+import { getProjectsTool } from "./tools/get_projects.js";
+
+const TESTRAIL_INSTANCE_URL = process.env.TESTRAIL_INSTANCE_URL;
+const TESTRAIL_USERNAME = process.env.TESTRAIL_USERNAME;
+const TESTRAIL_API_KEY = process.env.TESTRAIL_API_KEY;
+
+if (!TESTRAIL_INSTANCE_URL || !TESTRAIL_USERNAME || !TESTRAIL_API_KEY) {
+    console.error("Error: TESTRAIL_INSTANCE_URL, TESTRAIL_USERNAME, and TESTRAIL_API_KEY environment variables are required.");
+    process.exit(1);
+}
+
+const server = new McpServer({
+    name: "TestRail MCP Server",
+    version: "1.1.0",
+});
+
+const client = new TestRailClient(TESTRAIL_INSTANCE_URL, TESTRAIL_USERNAME, TESTRAIL_API_KEY);
+
+const tools = [
+    getProjectsTool,
+    getCaseTool,
+    getCasesTool,
+    getCaseFieldsTool,
+    getTemplatesTool,
+    getSectionsTool,
+    updateCaseTool,
+    updateCasesTool,
+    createCaseTool,
+]
+
+for (const tool of tools) {
+    server.registerTool(
+        tool.name,
+        {
+            description: tool.description,
+            inputSchema: tool.parameters,
+        },
+        (args: any) => tool.handler(args, client)
+    );
+}
+
+const transport = new StdioServerTransport();
+await server.connect(transport);