@uarlouski/testrail-mcp-server 2.10.0 → 3.0.0

package/README.md

@@ -1,10 +1,10 @@
 <div align="center">
   <h1>🚀 TestRail MCP Server</h1>
   <p>
-    <strong>An open-source Model Context Protocol (MCP) server that connects Claude, Cursor, Windsurf, and other AI assistants directly to TestRail.</strong>
+    <strong>Connect Claude, Cursor, Windsurf, and VS Code to TestRail — an open-source Model Context Protocol (MCP) server for AI-assisted test management.</strong>
   </p>
   <p>
-    Manage TestRail projects, search and create test cases, kick off test runs, record results, and attach files — all through natural-language conversation with your AI assistant. Built for QA engineers and AI-assisted test automation.
+    Manage TestRail projects, search and create test cases, kick off test runs, record results, and attach files through natural-language conversation with your AI assistant — or from CI/CD with the bundled <code>testrail-cli</code>. Built for QA engineers and AI-assisted test automation.
   </p>
 </div>
 
@@ -27,18 +27,38 @@
   <img src="https://img.shields.io/badge/VS%20Code-007ACC?logo=visualstudiocode&logoColor=white" alt="VS Code">
 </p>
 
+<p align="center">
+  <a href="https://uarlouski.github.io/testrail-mcp-server/"><strong>📚 Documentation</strong></a> ·
+  <a href="https://uarlouski.github.io/testrail-mcp-server/guide/getting-started"><strong>Getting Started</strong></a> ·
+  <a href="https://uarlouski.github.io/testrail-mcp-server/reference/"><strong>Tool Reference</strong></a> ·
+  <a href="https://uarlouski.github.io/testrail-mcp-server/guide/faq"><strong>FAQ</strong></a>
+</p>
+
 <!-- TODO: insert demo.gif — short screencast of asking "create a test case" in Claude or Cursor and seeing the case appear in TestRail -->
 
 ---
 
-## 🌟 Why Choose TestRail MCP Server?
+## What is the TestRail MCP Server?
 
-Managing test cases manually is tedious and error-prone. With the **TestRail MCP Server**, your AI assistant (whether it’s **Claude, Cursor, Windsurf**, or any MCP-compliant client) interacts directly with your TestRail instance. Instruct it to find test cases, draft new ones, kick off test runs, and record test results—all through natural conversation.
+The **TestRail MCP Server** is a free, open-source [Model Context Protocol](https://modelcontextprotocol.io) server that gives AI assistants direct, structured access to a [TestRail](https://www.testrail.com/) instance through the TestRail API v2. Once configured, an assistant such as **Claude Desktop, Cursor, Windsurf, or GitHub Copilot in VS Code** can search test cases, draft new ones, start test runs, record results, and upload attachments on your behalf — without you leaving the chat window.
+
+It exposes **34 tools**, runs locally on **Node.js 18+** over the MCP stdio transport, and is licensed under **Apache 2.0**. There is nothing to host or deploy: your MCP client launches it on demand with `npx`.
 
 **No context switching. No tedious copy-pasting. Just ask your AI.**
 
 > [!NOTE]
-> **Compatibility Baseline**: The primary baseline version this MCP server is tested and validated against is **TestRail 10.6.2** (API v2). Older TestRail instances (including pre-7.x pagination) are also supported via built-in backward compatibility.
+> **Compatibility baseline**: tested and validated against **TestRail 10.6.2** (API v2). Older TestRail instances (including pre-7.x pagination) are also supported via built-in backward compatibility. TestRail Cloud and self-hosted TestRail Server both work.
+
+## Table of contents
+
+- [Key features](#-key-features--capabilities)
+- [Quick start](#-quick-start-guide)
+- [Command line interface & CI/CD](#️-command-line-interface-cli--cicd-automation)
+- [Environment variables](#️-environment-variables--security-controls)
+- [Available tools](#-available-tools)
+- [FAQ](#-frequently-asked-questions)
+- [Documentation](#-documentation--complete-tool-reference)
+- [Contributing](#-contributing)
 
 ## ✨ Key Features & Capabilities
 
@@ -48,16 +68,18 @@ Managing test cases manually is tedious and error-prone. With the **TestRail MCP
 | **📋 Full Case Management** | Fetch, create, update, and bulk-edit test cases with comprehensive custom field support. |
 | **▶️ Actionable Execution** | Create test runs, update results by `test_id` or `case_id`, attach files, and track statuses. |
 | **🧠 Context-Aware AI** | Dynamically exposes templates, fields, priorities, and statuses so LLMs generate valid, structured data. |
+| **🖥️ CLI & CI/CD Native** | Run every tool from bash, GitHub Actions, GitLab CI, or Jenkins with zero LLM overhead. |
+| **🔐 Least-Privilege Controls** | Per-mode permissions plus per-tool allowlisting; destructive deletes are off by default. |
 
 ## 🚀 Quick Start Guide
 
-### 1. Obtain Your TestRail API Key
+### 1. Obtain your TestRail API key
 
-Navigate to **My Settings → API Keys** in your TestRail platform and generate a new key for authentication.
+Navigate to **My Settings → API Keys** in TestRail and generate a new key. Copy it immediately — TestRail shows it only once. The API must also be enabled instance-wide under **Administration → Site Settings → API**.
 
-### 2. Configure Your MCP Client
+### 2. Configure your MCP client
 
-Add the server to your chosen MCP client configuration. The Claude Desktop example is shown below; Cursor, Windsurf, and other clients use the same pattern (see the collapsible sections further down).
+Add the server to your MCP client configuration. The Claude Desktop example is shown below; Cursor, Windsurf, and VS Code use the same pattern (see the collapsible sections).
 
 #### 🤖 Claude Desktop
 
@@ -83,7 +105,7 @@ Add this to your `claude_desktop_config.json`:
 <details>
 <summary><strong>⌨️ Cursor</strong></summary>
 
-Open **Settings → Features → MCP** and add a new configuration:
+Open **Settings → MCP → Add new MCP server**, or edit `.cursor/mcp.json` in your project (`~/.cursor/mcp.json` for all projects):
 
 ```json
 {
@@ -105,7 +127,7 @@ Open **Settings → Features → MCP** and add a new configuration:
 <details>
 <summary><strong>🌊 Windsurf</strong></summary>
 
-Update your Windsurf MCP configuration file:
+Edit `~/.codeium/windsurf/mcp_config.json`:
 
 ```json
 {
@@ -124,21 +146,55 @@ Update your Windsurf MCP configuration file:
 ```
 </details>
 
+<details>
+<summary><strong>💻 VS Code</strong></summary>
+
+Add to `.vscode/mcp.json`. The `inputs` block keeps your API key out of the file:
+
+```json
+{
+  "inputs": [
+    {
+      "id": "testrail-api-key",
+      "type": "promptString",
+      "description": "TestRail API key",
+      "password": true
+    }
+  ],
+  "servers": {
+    "testrail": {
+      "command": "npx",
+      "args": ["-y", "@uarlouski/testrail-mcp-server@latest"],
+      "env": {
+        "TESTRAIL_INSTANCE_URL": "https://your-instance.testrail.io",
+        "TESTRAIL_USERNAME": "your@email.com",
+        "TESTRAIL_API_KEY": "${input:testrail-api-key}"
+      }
+    }
+  }
+}
+```
+</details>
+
 <details>
 <summary><strong>🌐 Other MCP Clients</strong></summary>
 
-Any MCP-compliant client can utilize this server. The pattern is universal—point your client at the `npx` command with the required environment variables.
+Any MCP-compliant client can use this server, because it speaks the standard MCP **stdio** transport. Point your client at the `npx` command with the required environment variables — no port, URL, or transport configuration needed.
 </details>
 
-### 3. See It in Action
+### 3. See it in action
 
-Once configured, turbo-charge your QA workflow by asking your AI assistant:
+Restart your client completely, then turbo-charge your QA workflow by asking your AI assistant:
 
 - *"List all projects in TestRail to find the latest active project."*
 - *"Show me all active users in the project to find the right assignee."*
 - *"Show me all test cases in section 5 of project 3."*
 - *"Create a comprehensive test case for 'Login Validation' with detailed steps."*
 - *"Start a new test run containing cases from section 5."*
+- *"Mark test case C1042 as passed with the comment 'verified on staging'."*
+
+Full per-client setup instructions, including troubleshooting, are in the [Getting Started guide](https://uarlouski.github.io/testrail-mcp-server/guide/getting-started).
+
 ---
 
 ## 🖥️ Command Line Interface (CLI) & CI/CD Automation
@@ -149,7 +205,7 @@ In addition to interacting via AI assistants, you can invoke any TestRail tool d
 - **Pipeline-Native Output**: Emits clean JSON to `stdout` for piping into tools like `jq`, while diagnostics and errors go to `stderr`.
 - **Zero Duplication**: Reuses the exact same API client, retry logic, and validation schemas as the MCP server.
 
-### Invocation Methods
+### Invocation methods
 
 ```bash
 # Method 1: Direct npx subcommand (Recommended)
@@ -164,7 +220,7 @@ npx -p @uarlouski/testrail-mcp-server testrail-cli <command> [flags]
 
 ### Examples
 
-#### Query Projects (`query_project`)
+#### Query projects (`query_project`)
 ```bash
 # List all active projects
 npx @uarlouski/testrail-mcp-server cli query_project --action many
@@ -173,7 +229,15 @@ npx @uarlouski/testrail-mcp-server cli query_project --action many
 npx @uarlouski/testrail-mcp-server cli query_project --action one --project_id 1
 ```
 
-#### Export Cases for Knowledge Base / RAG (`export_cases_for_rag`)
+#### Report automated test results (`add_results_for_cases`)
+```bash
+# Submit results by case_id — what your test framework already knows
+npx @uarlouski/testrail-mcp-server cli add_results_for_cases \
+  --run_id 88 \
+  --results '[{"case_id":1042,"status_id":1,"comment":"Passed in CI"}]'
+```
+
+#### Export cases for knowledge base / RAG (`export_cases_for_rag`)
 ```bash
 # Export all cases for a project into Markdown & metadata sidecars
 npx @uarlouski/testrail-mcp-server cli export_cases_for_rag \
@@ -186,16 +250,17 @@ npx @uarlouski/testrail-mcp-server cli export_cases_for_rag \
   --output_dir ./rag_exports
 ```
 
-#### Command Discovery & Flag Documentation
+#### Command discovery & flag documentation
 ```bash
 # List all available commands
 npx @uarlouski/testrail-mcp-server cli --help
 
 # Show parameter options for a specific tool
 npx @uarlouski/testrail-mcp-server cli query_project --help
-npx @uarlouski/testrail-mcp-server cli export_cases_for_rag --help
 ```
 
+See the [CLI & CI/CD guide](https://uarlouski.github.io/testrail-mcp-server/guide/cli) for complete GitHub Actions, GitLab CI, and Jenkins workflows.
+
 ---
 
 ## ⚙️ Environment Variables & Security Controls
@@ -211,43 +276,102 @@ npx @uarlouski/testrail-mcp-server cli export_cases_for_rag --help
 | `TESTRAIL_ALLOW_WRITE_OPERATIONS` | Allow write operations (e.g. adding/updating test cases, test runs, sections) | | `true` |
 | `TESTRAIL_ALLOW_READ_OPERATIONS` | Allow read operations (e.g. retrieving projects, test cases, templates) | | `true` |
 | `TESTRAIL_ALLOW_DELETE_OPERATIONS` | Allow delete operations (e.g. deleting cases or shared steps). Enabled strictly via `true`. | | `false` |
-| `TESTRAIL_ENABLE_DEPRECATED_TOOLS` | Enable deprecated tools for backward compatibility. Set to `false` to reduce context token overhead. | | `true` |
+| `TESTRAIL_ENABLE_DEPRECATED_TOOLS` | Preserved for backward compatibility with existing host configurations. | | `true` |
 | `TESTRAIL_DISABLED_TOOLS` | Comma-separated list of specific tool names to disable (e.g., `mutate_suite,delete_entity`). Fails if invalid tool names are specified. | | - |
 
-### ⚠️ Deprecation Lifecycle & Features Scheduled for Removal
+With only the three required credentials, **26 of the 34 tools** are registered. Ready-made read-only and least-privilege configurations are in the [Configuration guide](https://uarlouski.github.io/testrail-mcp-server/guide/configuration).
+
+---
+
+## 🧰 Available Tools
 
-To ensure smooth transitions, deprecated tools remain available by default (`TESTRAIL_ENABLE_DEPRECATED_TOOLS=true`) and will be removed in future major releases:
+All 34 tools, grouped by area. Each declares a `read`, `write`, or `delete` mode, which the server surfaces to clients as MCP annotations (`readOnlyHint`, `destructiveHint`, `idempotentHint`).
 
-| Deprecated Tool | Replacement | Status |
-|-----------------|-------------|--------|
-| `add_attachment_to_run` | `add_attachment` (`entity_type: "case" \| "run" \| "result"`) | Deprecated in `2.3.0`, scheduled for removal in `3.0.0` |
-| `get_sections` | `query_section` (`action: "many"`) | Deprecated in `2.8.0`, scheduled for removal in `3.0.0` |
+| Area | Tools | Reference |
+|------|-------|-----------|
+| **Discovery & Navigation** | `query_project`, `query_suite`, `mutate_suite`, `query_section`, `mutate_section`, `get_users` | [Docs](https://uarlouski.github.io/testrail-mcp-server/reference/discovery) |
+| **Test Case Management** | `get_case`, `get_cases`, `add_case`, `update_case`, `update_cases`, `get_case_fields`, `resolve_case_field`, `get_case_history`, `export_cases_for_rag` | [Docs](https://uarlouski.github.io/testrail-mcp-server/reference/cases) |
+| **Execution & Tracking** | `query_run`, `mutate_run`, `get_tests`, `get_results`, `add_results`, `add_results_for_cases` | [Docs](https://uarlouski.github.io/testrail-mcp-server/reference/execution) |
+| **Attachments & Media** | `add_attachment`, `query_attachment` | [Docs](https://uarlouski.github.io/testrail-mcp-server/reference/attachments) |
+| **Shared Steps** | `get_shared_step`, `get_shared_steps`, `get_shared_step_history`, `add_shared_step`, `update_shared_step` | [Docs](https://uarlouski.github.io/testrail-mcp-server/reference/shared-steps) |
+| **System Metadata** | `get_statuses`, `get_priorities`, `get_case_fields`, `get_templates`, `get_labels`, `get_configurations` | [Docs](https://uarlouski.github.io/testrail-mcp-server/reference/metadata) |
+| **Deletion** | `delete_entity` | [Docs](https://uarlouski.github.io/testrail-mcp-server/reference/deletion) |
 
-> **💡 Token Tip**: If you are not using legacy tools, set `TESTRAIL_ENABLE_DEPRECATED_TOOLS=false` in your environment to eliminate deprecated tool definitions from the LLM prompt and save tokens!
+---
+
+## ❓ Frequently Asked Questions
+
+<details>
+<summary><strong>Which AI assistants and MCP clients are supported?</strong></summary>
+
+Any MCP-compliant client, because the server uses the standard MCP stdio transport. Setup is verified with Claude Desktop, Cursor, Windsurf, and VS Code. Other clients follow the same pattern: run `npx -y @uarlouski/testrail-mcp-server@latest` with three environment variables.
+</details>
+
+<details>
+<summary><strong>Which TestRail versions are supported?</strong></summary>
+
+The server targets TestRail API v2 and is tested against **TestRail 10.6.2**. Older instances work too — the client detects whether an endpoint returns a modern paginated response or a legacy bare array, so pre-7.x instances need no configuration. Both TestRail Cloud and self-hosted TestRail Server are supported.
+</details>
+
+<details>
+<summary><strong>Is it safe to give an AI assistant write access to TestRail?</strong></summary>
+
+Access is layered rather than all-or-nothing. Every tool declares a `read`, `write`, or `delete` mode; deletes are disabled unless you explicitly set `TESTRAIL_ALLOW_DELETE_OPERATIONS=true`. You can disable all writes with `TESTRAIL_ALLOW_WRITE_OPERATIONS=false`, or block individual tools by name with `TESTRAIL_DISABLED_TOOLS`. The server runs locally and talks only to your TestRail instance — there is no telemetry and no third-party service in the middle.
+</details>
+
+<details>
+<summary><strong>Is it free?</strong></summary>
+
+Yes — Apache 2.0 licensed, with no paid tier, licence key, or usage limit. You need your own TestRail subscription, and whatever your AI assistant costs. The CLI has no LLM cost at all.
+</details>
+
+<details>
+<summary><strong>Can I use it in CI/CD without an AI assistant?</strong></summary>
+
+Yes. The package ships a `testrail-cli` binary exposing every tool as a subcommand, reusing the same API client, retry logic, and validation schemas. JSON on stdout, diagnostics on stderr, exit code `0` or `1` — see the [CLI guide](https://uarlouski.github.io/testrail-mcp-server/guide/cli).
+</details>
+
+<details>
+<summary><strong>How do I stop the AI from inventing custom fields that don't exist?</strong></summary>
+
+It can't. Before `add_case` or `update_case` sends anything, the server validates every field key against your instance's real schema (fetched via `get_case_fields`) and rejects unknown keys. Templates, priorities, statuses, and configurations are all exposed as tools too, so the model looks up correct IDs instead of guessing them.
+</details>
+
+<details>
+<summary><strong>How do I handle thousands of test cases without blowing the context window?</strong></summary>
+
+Pass `output_file` to `get_cases` (or `output_dir` to `export_cases_for_rag`). The server paginates the full result set, writes raw JSON to disk, and returns only a short summary to the model.
+</details>
+
+More answers in the [full FAQ](https://uarlouski.github.io/testrail-mcp-server/guide/faq).
 
 ---
 
 ## 📚 Documentation & Complete Tool Reference
 
-For a comprehensive guide, detailed configuration options, and a complete breakdown of all available tools, please visit our official documentation site:
+For a comprehensive guide, detailed configuration options, and a complete breakdown of all available tools, visit the official documentation site:
 
 **👉 [TestRail MCP Server Documentation](https://uarlouski.github.io/testrail-mcp-server/)**
 
-The documentation includes detailed explanations for:
-- 🔭 **Discovery & Navigation**: Exploring projects, suites, and sections.
-- 📋 **Test Case Management**: Fetching, creating, and bulk-updating test cases.
-- ▶️ **Execution & Tracking**: Managing test runs and submitting test results.
-- 📎 **Attachments**: Automatically zipping and uploading files or directories.
-- 🔗 **Shared Steps**: Managing reusable step definitions.
-
+- 🚀 **[Getting Started](https://uarlouski.github.io/testrail-mcp-server/guide/getting-started)**: Per-client setup for Claude, Cursor, Windsurf, and VS Code.
+- ⚙️ **[Configuration](https://uarlouski.github.io/testrail-mcp-server/guide/configuration)**: Every environment variable, permission, and feature flag.
+- 🧰 **[All Tools](https://uarlouski.github.io/testrail-mcp-server/reference/)**: All 34 tools with modes and feature flags in one table.
+- 🔭 **[Discovery & Navigation](https://uarlouski.github.io/testrail-mcp-server/reference/discovery)**: Exploring projects, suites, and sections.
+- 📋 **[Test Case Management](https://uarlouski.github.io/testrail-mcp-server/reference/cases)**: Fetching, creating, and bulk-updating test cases.
+- ▶️ **[Execution & Tracking](https://uarlouski.github.io/testrail-mcp-server/reference/execution)**: Managing test runs and submitting test results.
+- 📎 **[Attachments](https://uarlouski.github.io/testrail-mcp-server/reference/attachments)**: Automatically zipping and uploading files or directories.
+- 🔗 **[Shared Steps](https://uarlouski.github.io/testrail-mcp-server/reference/shared-steps)**: Managing reusable step definitions.
+- 🖥️ **[CLI & CI/CD](https://uarlouski.github.io/testrail-mcp-server/guide/cli)**: Pipeline automation without an LLM.
 
 ---
 
 ## 🤝 Contributing
+
 Open-source contributions are actively welcomed! Please feel free to open an [issue](https://github.com/uarlouski/testrail-mcp-server/issues) for feature requests or submit a pull request for improvements.
 
 ## 📜 License
-This project is securely licensed under the [Apache License 2.0](LICENSE).
+
+This project is licensed under the [Apache License 2.0](LICENSE).
 
 ---
 

package/dist/tools/cases/add_case.js

@@ -2,7 +2,7 @@ import { z } from "zod";
 import { validateCaseFields } from "../../utils/validator.js";
 import { CASE_FIELDS_PARAM_DESCRIPTION } from "./get_case_fields.js";
 const parameters = {
-    section_id: z.number().describe("The ID of the section where the case should be created. Use get_sections to find available sections"),
+    section_id: z.number().describe("The ID of the section where the case should be created. Use query_section (action: \"many\") to find available sections"),
     title: z.string().describe("The title of the test case"),
     fields: z.record(z.string(), z.any()).optional().describe(CASE_FIELDS_PARAM_DESCRIPTION),
 };

package/dist/tools/cases/get_cases.js

@@ -2,13 +2,13 @@ import { z } from "zod";
 import fs from "fs";
 import { validateCaseFields, validateSuiteId } from "../../utils/validator.js";
 const parameters = {
-    project_id: z.number().describe("The ID of the project. Use get_projects to find available projects"),
-    suite_id: z.number().optional().describe("The ID of the test suite (required for multi-suite projects, i.e. suite_mode=3). Use get_suites to find available suites"),
+    project_id: z.number().describe("The ID of the project. Use query_project to find available projects"),
+    suite_id: z.number().optional().describe("The ID of the test suite (required for multi-suite projects, i.e. suite_mode=3). Use query_suite to find available suites"),
     section: z.object({
         id: z.number(),
         recursive: z.boolean().optional().default(false).describe("If true, fetches cases from the section and all its child sections"),
         excludes: z.array(z.string()).optional().describe("List of section names to exclude from the recursive search"),
-    }).optional().describe("Section filter configuration. Use get_sections to find available sections"),
+    }).optional().describe("Section filter configuration. Use query_section to find available sections"),
     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\"]"),

package/dist/tools/commons/get_templates.js

@@ -1,7 +1,7 @@
 import { z } from "zod";
 import { TemplateSchema } from "./types.js";
 const parameters = {
-    project_id: z.number().describe("The ID of the project. Use get_projects to find available projects"),
+    project_id: z.number().describe("The ID of the project. Use query_project to find available projects"),
 };
 export const getTemplatesTool = {
     name: "get_templates",

package/dist/tools/runs/index.js

@@ -1,8 +1,6 @@
-import { addAttachmentToRunTool } from "./add_attachment_to_run.js";
 import { mutateRunTool } from "./mutate_run.js";
 import { queryRunTool } from "./query_run.js";
 export const runsTools = [
     mutateRunTool,
     queryRunTool,
-    addAttachmentToRunTool,
 ];

package/dist/tools/sections/index.js

@@ -1,9 +1,7 @@
-import { getSectionsTool } from "./get_sections.js";
 import { querySectionTool } from "./query_section.js";
 import { mutateSectionTool } from "./mutate_section.js";
 export const sectionsTools = [
     querySectionTool,
-    getSectionsTool,
     mutateSectionTool,
 ];
-export { getSectionsTool, querySectionTool, mutateSectionTool };
+export { querySectionTool, mutateSectionTool };

package/dist/tools/sections/types.js

@@ -13,7 +13,7 @@ export const BaseSectionFields = z.object({
 export const CreateSectionSchema = BaseSectionFields.extend({
     action: z.literal("create").describe("The operation to perform: create a new section"),
     project_id: z.number().describe("The ID of the project the section should be added to"),
-    suite_id: z.number().optional().describe("The ID of the test suite (required for multi-suite projects, i.e. suite_mode=2 or 3). Use get_suites to find available suites"),
+    suite_id: z.number().optional().describe("The ID of the test suite (required for multi-suite projects, i.e. suite_mode=2 or 3). Use query_suite to find available suites"),
     parent_id: z.number().optional().describe("The ID of the parent section (to build section hierarchies)"),
 });
 export const UpdateSectionSchema = BaseSectionFields.partial().extend({

package/dist/utils/validator.js

@@ -12,7 +12,7 @@ export async function validateSuiteId(client, projectId, suiteId) {
     const project = await client.getProject(projectId);
     if (project.suite_mode === SUITE_MODE_MULTI || project.suite_mode === SUITE_MODE_SINGLE_WITH_BASELINES) {
         throw new Error(`Project "${project.name}" (id: ${project.id}) uses multiple test suites/baselines (suite_mode=${project.suite_mode}). ` +
-            `The suite_id parameter is required. Use get_suites to find available suites for this project.`);
+            `The suite_id parameter is required. Use query_suite to find available suites for this project.`);
     }
 }
 /**

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = "2.10.0";
+export const VERSION = "3.0.0";

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@uarlouski/testrail-mcp-server",
-  "version": "2.10.0",
+  "version": "3.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.",
+  "description": "Model Context Protocol (MCP) server for TestRail: let Claude, Cursor, and Windsurf manage test cases, runs, results, and attachments.",
   "main": "dist/index.js",
   "bin": {
     "testrail-mcp-server": "./dist/index.js",
@@ -17,19 +17,33 @@
     "model-context-protocol",
     "mcp-server",
     "testrail",
-    "server",
-    "typescript",
-    "llm",
-    "ai",
-    "ai-agents",
+    "testrail-api",
+    "testrail-mcp",
+    "testrail-integration",
+    "test-management",
+    "test-case-management",
+    "test-cases",
+    "test-runs",
+    "test-results",
     "testing",
-    "automation",
+    "qa",
+    "quality-assurance",
     "qa-automation",
     "qa-tools",
-    "test-management",
+    "test-automation",
+    "automation",
+    "ci-cd",
+    "ai",
+    "ai-agents",
+    "llm",
     "claude",
     "cursor",
-    "windsurf"
+    "windsurf",
+    "vscode",
+    "copilot",
+    "rag",
+    "typescript",
+    "cli"
   ],
   "author": "Uladzislau Arlouski",
   "repository": {

package/dist/tools/runs/add_attachment_to_run.js

@@ -1,23 +0,0 @@
-import { z } from "zod";
-import { AttachmentSchema } from "../attachments/types.js";
-import { prepareUploadFile } from "../../utils/attachment_helper.js";
-const parameters = {
-    run_id: z.number().describe("The ID of the test run to attach the file to"),
-    file_path: z.string().describe("The path to the file or directory to attach. Directories will be automatically zipped."),
-};
-/**
- * @deprecated Use `add_attachment` tool from the attachments domain instead.
- */
-export const addAttachmentToRunTool = {
-    name: "add_attachment_to_run",
-    mode: "write",
-    deprecated: true,
-    description: "Add an attachment to a test run in TestRail. (Deprecated: Prefer add_attachment tool). Maximum upload size is 256MB.",
-    parameters,
-    handler: async ({ run_id, file_path }, client) => {
-        return prepareUploadFile(file_path, async (uploadPath, filename) => {
-            const result = await client.addAttachment('run', run_id, uploadPath, filename);
-            return AttachmentSchema.parse(result);
-        });
-    },
-};

package/dist/tools/sections/get_sections.js

@@ -1,35 +0,0 @@
-import { z } from "zod";
-import fs from "fs";
-import { SectionSchema } from "./types.js";
-import { validateSuiteId } from "../../utils/validator.js";
-const parameters = {
-    project_id: z.number().describe("The ID of the project. Use get_projects to find available projects"),
-    suite_id: z.number().optional().describe("The ID of the test suite (required for multi-suite projects, i.e. suite_mode=3). Use get_suites to find available suites"),
-    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."),
-};
-/**
- * @deprecated Use `query_section` with payload.action = 'many' instead.
- */
-export const getSectionsTool = {
-    name: "get_sections",
-    mode: "read",
-    deprecated: true,
-    description: "Get all sections for a project. (Deprecated: Prefer query_section tool). Returns section IDs and names that can be used with add_case",
-    parameters,
-    handler: async ({ project_id, suite_id, output_file }, client) => {
-        await validateSuiteId(client, project_id, suite_id);
-        const sections = await client.getSections(project_id, suite_id);
-        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;
-    }
-};