@uarlouski/testrail-mcp-server 1.9.0 → 1.10.0

package/README.md

@@ -15,6 +15,7 @@
   <a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="License"></a>
   <a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-5.9-blue.svg" alt="TypeScript"></a>
   <a href="https://github.com/uarlouski/testrail-mcp-server"><img src="https://img.shields.io/github/stars/uarlouski/testrail-mcp-server.svg?style=social&label=Star" alt="GitHub stars"></a>
+  <a href="https://glama.ai/mcp/servers/uarlouski/testrail-mcp-server"><img src="https://glama.ai/mcp/servers/uarlouski/testrail-mcp-server/badges/score.svg" alt="Score Badge"></a>
 </p>
 
 <p align="center">
@@ -152,6 +153,9 @@ Once configured, turbo-charge your QA workflow by asking your AI assistant:
 
 The TestRail MCP Server provides heavily typed, descriptive tools designed specifically for LLM interaction:
 
+> **💡 Pro Tip: Handling Large Data Sets**
+> For list-based tools like `get_cases` and `get_sections`, you can supply the `output_file` parameter with an absolute file path. The server will bypass the LLM context window by writing the raw JSON directly to disk and returning a concise summary, allowing you to run external scripts against the export!
+
 ### 🔭 Discovery & Navigation
 | Tool | Functionality |
 |------|-------------|

package/dist/index.js

@@ -42,7 +42,7 @@ if (!parseResult.success) {
 const { TESTRAIL_INSTANCE_URL, TESTRAIL_USERNAME, TESTRAIL_API_KEY, TESTRAIL_ENABLE_SHARED_STEPS } = parseResult.data;
 const server = new McpServer({
     name: "TestRail MCP Server",
-    version: "1.9.0",
+    version: "1.10.0",
 });
 const client = new TestRailClient(TESTRAIL_INSTANCE_URL, TESTRAIL_USERNAME, TESTRAIL_API_KEY);
 const tools = [

package/dist/tools/get_cases.js

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import fs from "fs";
 import { validateCaseFields } from "../utils/validator.js";
 const parameters = {
     project_id: z.number().describe("The ID of the project. Use get_projects to find available projects"),
@@ -10,12 +11,13 @@ const parameters = {
     filter: z.record(z.string(), z.string()).optional().describe("Optional API-side filters (more efficient for large datasets). Supported: priority_id, type_id, created_by, updated_by, milestone_id, refs, created_after, created_before, updated_after, updated_before. Use comma-separated values for IDs. Example: {\"priority_id\": \"1,2\", \"type_id\": \"3\"}"),
     where: z.record(z.string(), z.any()).optional().describe("Optional client-side filter for any field including custom fields (filters after fetching all cases). Supports exact value matching. Example: {\"custom_automation_status\": 1, \"priority_id\": 2}"),
     fields: z.array(z.string()).optional().describe("Additional fields to include in response beyond id, title, and suite_id. Use get_case_fields to see available fields. Example: [\"priority_id\", \"type_id\", \"custom_automation_status\"]"),
+    output_file: z.string().optional().describe("Absolute file path to save the JSON response to. Use this for large datasets to avoid blowing up context limits."),
 };
 export const getCasesTool = {
     name: "get_cases",
     description: "Get all test cases for a project. Filter by section, API params (priority, type), or any field including custom fields via 'where'. Returns case IDs, titles, and any additional requested fields.",
     parameters,
-    handler: async ({ project_id, section, filter, where, fields }, client) => {
+    handler: async ({ project_id, section, filter, where, fields, output_file }, client) => {
         const caseFields = await client.getCaseFields();
         if (fields) {
             validateCaseFields(fields, caseFields);
@@ -59,6 +61,14 @@ export const getCasesTool = {
                 return result;
             }),
         };
+        if (output_file) {
+            await fs.promises.writeFile(output_file, JSON.stringify(response), "utf-8");
+            return {
+                success: true,
+                message: `Successfully exported ${response.cases.length} cases to ${output_file}`,
+                file: output_file
+            };
+        }
         return response;
     }
 };

package/dist/tools/get_sections.js

@@ -1,16 +1,27 @@
 import { z } from "zod";
+import fs from "fs";
 import { SectionSchema } from "../types/testrail.js";
 const parameters = {
     project_id: z.number().describe("The ID of the project. Use get_projects to find available projects"),
+    output_file: z.string().optional().describe("Absolute file path to save the JSON response to. Use this for large datasets to avoid blowing up context limits."),
 };
 export const getSectionsTool = {
     name: "get_sections",
     description: "Get all sections for a project. Returns section IDs and names that can be used with add_case",
     parameters,
-    handler: async ({ project_id }, client) => {
+    handler: async ({ project_id, output_file }, client) => {
         const sections = await client.getSections(project_id);
-        return {
+        const response = {
             sections: sections.map(s => SectionSchema.parse(s)),
         };
+        if (output_file) {
+            await fs.promises.writeFile(output_file, JSON.stringify(response), "utf-8");
+            return {
+                success: true,
+                message: `Successfully exported ${response.sections.length} sections to ${output_file}`,
+                file: output_file
+            };
+        }
+        return response;
     }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uarlouski/testrail-mcp-server",
-  "version": "1.9.0",
+  "version": "1.10.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",
@@ -11,13 +11,6 @@
     "dist"
   ],
   "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",
@@ -40,10 +33,10 @@
   "homepage": "https://github.com/uarlouski/testrail-mcp-server#readme",
   "license": "Apache-2.0",
   "dependencies": {
-    "@modelcontextprotocol/sdk": "^1.27.1",
+    "@modelcontextprotocol/sdk": "^1.29.0",
     "archiver": "^7.0.1",
-    "dotenv": "^17.3.1",
-    "zod": "^4.3.6"
+    "dotenv": "^17.4.2",
+    "zod": "^4.4.3"
   },
   "devDependencies": {
     "@types/archiver": "^7.0.0",
@@ -53,6 +46,21 @@
     "rimraf": "^6.1.3",
     "ts-jest": "^29.4.6",
     "ts-node": "^10.9.2",
-    "typescript": "^5.9.3"
+    "typescript": "^5.9.3",
+    "@jest/globals": "^29.7.0"
+  },
+  "devEngines": {
+    "packageManager": {
+      "name": "pnpm",
+      "version": "11.1.2",
+      "onFail": "error"
+    }
+  },
+  "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"
   }
 }