@alternative-path/qa-path-mcp 1.0.0

package/TOOLS_DOCUMENTATION.md

@@ -0,0 +1,675 @@
+# QA-Path Tools Documentation
+
+This document lists all MCP tools and prompts exposed by the QA-Path MCP server, with parameters, sample prompts to trigger each tool, and sample human-readable outputs.
+
+For each tool you will find:
+- **Sample prompt(s)** — Example natural-language prompts you can give (e.g. in chat) to trigger the tool.
+- **Sample human-readable output** — What the user typically sees when the tool runs.
+
+---
+
+## 0. Prompts (Agents)
+
+### qa-path-test-planner
+
+| Field | Value |
+|-------|--------|
+| **Prompt name** | `qa-path-test-planner` |
+| **Title** | qa-path-test-planner |
+| **Description** | Standard test plan agent. Uses embedded test-planning context to produce consistent, repeatable test plans, test cases, and automation workflows without manual context files. |
+| **Arguments** | `project_summary` (optional) – Short description of the project/feature to plan tests for<br>`links` (optional) – BDD, TDD, JIRA, or Confluence links<br>`scope` (optional) – Test scope (in/out of scope, platforms, focus areas) |
+
+**How to use**
+- In Cursor: use the prompts list (e.g. slash command or prompt picker) and select **qa-path-test-planner**. Optionally fill in project summary, links, and scope.
+- The agent receives the full test-planning context (structure, best practices, checklists) from the server; you do not need to attach or paste a context file.
+
+**Sample usage**
+- "Use the qa-path-test-planner prompt to create a test plan for the new Document Upload feature. Here's the BDD link: …"
+- Invoke **qa-path-test-planner** with `project_summary`: "Transaction management migration", `links`: "Confluence page URL", `scope`: "In scope: UI and API; out of scope: legacy reports."
+
+---
+
+## 1. Auth Tools
+
+### check_auth_status
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `check_auth_status` |
+| **Description** | Check if the MCP server is currently authenticated with the API. When authenticated, returns the logged-in user (id, username, user_email). |
+| **Mandatory parameters** | None |
+| **Optional parameters** | None |
+
+**Sample prompt(s)**
+- "Am I logged in? Check my auth status."
+- "Who is currently authenticated?"
+- "Verify that the MCP server is connected to QA-Path."
+
+**Sample human-readable output**
+- **Authenticated:** MCP server is authenticated. Current user: **Anirvan Goswami** (anirvan@alternative-path.com).
+- **Not authenticated:** MCP server is not authenticated. Set `QA_PATH_API_KEY` in your MCP config and restart the server.
+
+---
+
+## 2. Project Context Tools
+
+### set_active_project
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `set_active_project` |
+| **Description** | Set the active project for subsequent operations. Once set, all tools that require a project will use this project automatically — you won't need to pass `projectId` to every tool. |
+| **Mandatory parameters** | `projectId` (string) – Project ID (UUID). Get this from `list_projects`. |
+| **Optional parameters** | None |
+
+**Sample prompt(s)**
+- "Set my active project to 977dfeb2-e572-44da-8fe6-5c88f61609e4."
+- "Use the QA Path Demo project for all operations."
+- "Switch active project to d0951cf8-0622-4710-878a-fcc5536100e2."
+
+**Sample human-readable output**
+- **Success:** Active project set to **QA Path Demo** (ID: 977dfeb2-…). All subsequent operations will use this project.
+- **Failure:** Project ID not found or invalid UUID.
+
+---
+
+### get_active_project
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `get_active_project` |
+| **Description** | Get the currently active project. Returns the project ID, name, and prefix if one is set. |
+| **Mandatory parameters** | None |
+| **Optional parameters** | None |
+
+**Sample prompt(s)**
+- "What project am I currently working in?"
+- "Show me the active project."
+- "Which project is set as active?"
+
+**Sample human-readable output**
+- **Set:** Active project: **QA Path Demo** (prefix: QPD, ID: 977dfeb2-…).
+- **Not set:** No active project set. Use `set_active_project` or pass `projectId` to each tool.
+
+---
+
+## 3. Project Tools
+
+### list_projects
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `list_projects` |
+| **Description** | List projects accessible to the authenticated user with filtering and sorting. Returns projects with their details including test case counts and module counts. |
+| **Mandatory parameters** | `page` (number, min: 1) – Page number<br>`pageSize` (number, min: 1, max: 10000) – Number of results per page |
+| **Optional parameters** | `query` (string) – Filter query in canonical format (e.g. `name = 'MyProject'`). Leave empty to get all.<br>`sortField` (string) – Field to sort by: `name`, `description`, `created_at`, `createdByUser`<br>`sortOrder` (string) – `ASC` or `DESC` |
+
+**Sample prompt(s)**
+- "List all my projects."
+- "Show me the projects I have access to, sorted by name."
+- "Find projects with 'demo' in the name."
+
+**Sample human-readable output**
+- **Success:** Found **2** project(s).
+  - **QA Path Demo** (prefix: QPD) — 12 test cases, 4 modules. ID: 977dfeb2-…
+  - **Harpal's Second Project** (prefix: HSS) — 5 test cases, 3 modules. ID: d0951cf8-…
+- **Empty:** No projects found.
+
+---
+
+### suggest_project_prefix
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `suggest_project_prefix` |
+| **Description** | Generate a unique project prefix suggestion based on the project name. Checks existing prefixes in the organisation and suggests an available one. |
+| **Mandatory parameters** | `projectName` (string) – Project name to generate prefix from |
+| **Optional parameters** | None |
+
+**Sample prompt(s)**
+- "Suggest a prefix for a project called 'Payment Gateway'."
+- "What prefix should I use for 'Regression Suite'?"
+
+**Sample human-readable output**
+- **Success:** Suggested prefix for "Payment Gateway": **PAG**. This prefix is available.
+
+---
+
+### create_project
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `create_project` |
+| **Description** | Create a new project in the organisation. The project name and prefix must be unique within the organisation. |
+| **Mandatory parameters** | `name` (string) – Project name<br>`prefix` (string) – Project key prefix (2–4 characters, must be unique) |
+| **Optional parameters** | `description` (string) – Project description<br>`context` (string) – Project context |
+
+**Sample prompt(s)**
+- "Create a project called 'Payment Gateway' with prefix PAG."
+- "Add a new project named 'Regression Suite', prefix RS, description 'Nightly regression tests'."
+
+**Sample human-readable output**
+- **Success:** Project **Payment Gateway** (PAG) created successfully. ID: uuid-here.
+- **Failure:** Creation failed. Name or prefix may already be in use.
+
+---
+
+### update_project
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `update_project` |
+| **Description** | Update an existing project. Only projects in the authenticated user's organisation can be updated. |
+| **Mandatory parameters** | `projectId` (string) – Project ID (UUID) to update<br>`name` (string) – Updated project name |
+| **Optional parameters** | `description` (string) – Updated project description<br>`context` (string) – Updated project context |
+
+**Sample prompt(s)**
+- "Rename project 977dfeb2-… to 'QA Path Production'."
+- "Update the description of project d0951cf8-… to 'Main regression project'."
+
+**Sample human-readable output**
+- **Success:** Project updated successfully. Name is now **QA Path Production**.
+- **Failure:** Update failed. Check that the project ID is valid and you have permission.
+
+---
+
+## 4. Module Tools
+
+### list_modules
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `list_modules` |
+| **Description** | List all modules, components, and subcomponents in the project. Returns a hierarchical tree structure with parent-child relationships. Supports searching by module name. |
+| **Mandatory parameters** | None |
+| **Optional parameters** | `search` (string) – Filter modules by name (case-insensitive)<br>`projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "List all modules in the project."
+- "Show me the module tree for this project."
+- "Find modules with 'login' in the name."
+
+**Sample human-readable output**
+- **Success:** Module tree for the project:
+  - **Module Edit** (level 1)
+    - **Component Edit** (level 2)
+  - **Module MCP** (level 1)
+- **Empty:** No modules in this project yet.
+
+---
+
+### create_module
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `create_module` |
+| **Description** | Create a new module (level 1), component (level 2), or subcomponent (level 3). The level is determined by the `parentId`. |
+| **Mandatory parameters** | `name` (string) – Name of the module/component/subcomponent |
+| **Optional parameters** | `parentId` (string) – Parent module ID. If provided, creates a child; if not, creates a top-level module<br>`context` (string) – Optional context/description<br>`projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Create a new module named 'Checkout Flow'."
+- "Add a component called 'Login Flow' under module a627e125-…."
+- "Create a subcomponent under component X with name 'Password Reset'."
+
+**Sample human-readable output**
+- **Success:** Module **Checkout Flow** created successfully (level 1). ID: uuid-here.
+- **Failure:** Module creation failed. Check that the name is valid and you have permission.
+
+---
+
+### update_module
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `update_module` |
+| **Description** | Update an existing module, component, or subcomponent. You can change its name and/or context. |
+| **Mandatory parameters** | `moduleId` (string) – ID of the module to update |
+| **Optional parameters** | `name` (string) – New name<br>`context` (string) – New context/description<br>`projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Rename module a627e125-… to 'Component Edit v2'."
+- "Update the module's description to 'Login and logout flows'."
+
+**Sample human-readable output**
+- **Success:** Module updated successfully. Name is now **Component Edit v2**.
+- **Failure:** Update failed. Ensure the module ID exists and you have permission.
+
+---
+
+### get_module
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `get_module` |
+| **Description** | Get detailed information about a specific module, including its children and path in the hierarchy. |
+| **Mandatory parameters** | `moduleId` (string) – ID of the module to retrieve |
+| **Optional parameters** | None |
+
+**Sample prompt(s)**
+- "Get details for module a627e125-…."
+- "Show me the component Edit and its children."
+- "What is the hierarchy path for this module?"
+
+**Sample human-readable output**
+- **Success:** **Component Edit** (level 2). Parent ID: … . Children: none.
+- **Failure:** Module not found for the given ID.
+
+---
+
+## 5. Test Case Tools
+
+### list_test_cases
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `list_test_cases` |
+| **Description** | List test cases with filtering and sorting. Supports canonical format queries (e.g. `status = 'New' AND priority = 'High'`). Use `get_query_schema` with entity `testcase` to discover all filterable fields and valid values. |
+| **Mandatory parameters** | None |
+| **Optional parameters** | `query` (string, max 5000 chars) – Filter query in canonical format. Leave empty to get all.<br>`page` (number, default: 1) – Page number<br>`pageSize` (number, default: 25, max: 10000) – Results per page<br>`moduleId` (string) – Filter by module ID<br>`sortField` (string) – Sort by: `key`, `title`, `type`, `priority`, `status`, `created_at`, `updated_at`, etc.<br>`sortOrder` (string) – `asc` or `desc`<br>`timezone` (string) – Timezone for date parsing (e.g. `America/New_York`)<br>`projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "List all test cases in the project."
+- "Show test cases in module a627e125-…."
+- "Find test cases where status = 'New' AND priority = 'High'."
+- "List test cases sorted by created_at desc, page 2."
+
+**Sample human-readable output**
+- **Success:** Found **10** test case(s) (page 1 of 1).
+  - **QPD-4** — Login Flow Test (status: New, priority: High, type: Functional Test).
+  - **QPD-5** — API Auth Test (status: Active, type: API test).
+- **Empty:** No test cases match the filters.
+
+---
+
+### get_test_case
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `get_test_case` |
+| **Description** | Get detailed information about a specific test case by ID. |
+| **Mandatory parameters** | `testCaseId` (string) – ID (UUID) of the test case to retrieve |
+| **Optional parameters** | `projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Get details for test case 1cf10d9c-…."
+- "Show me test case QPD-4."
+- "What is the full info for this test case including automation status?"
+
+**Sample human-readable output**
+- **Success:** **QPD-4** — Login Flow Test. Type: Functional Test. Status: New. Module: Component Edit.
+- **Failure:** Test case not found for the given ID.
+
+---
+
+### get_execution_history
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `get_execution_history` |
+| **Description** | Get execution history for a test case (runs, results, dates). |
+| **Mandatory parameters** | `testCaseId` (string) – ID (UUID) of the test case |
+| **Optional parameters** | `projectId` (string) – Project ID (UUID). If not provided, uses active project.<br>`page` (number, default: 1) – Page number<br>`pageSize` (number, default: 25) – Results per page |
+
+**Sample prompt(s)**
+- "Show execution history for test case 1cf10d9c-…."
+- "When was QPD-4 last run and what was the result?"
+- "List past runs for this test case."
+
+**Sample human-readable output**
+- **Success:** 3 run(s) found. Run on 2025-01-28 — Passed; Run on 2025-01-27 — Failed.
+- **Empty:** No execution history for this test case yet.
+
+---
+
+### get_execution_plan
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `get_execution_plan` |
+| **Description** | Get the exact details of the automated test steps (execution plan) for a test case. Returns the saved plan including steps, tool calls, assertions, and metadata. |
+| **Mandatory parameters** | `testCaseId` (string) – ID (UUID) of the test case |
+| **Optional parameters** | `projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Get the execution plan for test case 1cf10d9c-…."
+- "Show me the saved automation script for QPD-4."
+- "What are the exact automation steps for this NLP test?"
+
+**Sample human-readable output**
+- **Success:** Execution plan for **QPD-4**: **14** steps. Steps include browser_navigate, browser_click, assertions, etc.
+- **No plan:** No automation plan saved for this test case. Use `generate_nlp_script` to create one.
+
+---
+
+### create_test_case
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `create_test_case` |
+| **Description** | Create a new test case in a specified module, component, or subcomponent. |
+| **Mandatory parameters** | `title` (string) – Title/summary of the test case<br>`moduleId` (string) – ID of the module/component/subcomponent |
+| **Optional parameters** | `description` (string) – Detailed description<br>`type` (string) – e.g. `Functional Test`, `Regression Test`, `Smoke Test`, `API test`<br>`status` (string) – e.g. `New`, `In Progress`, `Completed`<br>`priority` (string) – e.g. `Low`, `Normal`, `High`, `Critical`<br>`estimatedDuration` (number) – Estimated duration in minutes<br>`testData` (string) – Test data as JSON string<br>`labels` (array of strings) – Label names<br>`projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Create a test case titled 'Validate Login' in module a627e125-…."
+- "Add a new API test called 'Checkout Flow' in the given module, status Active, priority High."
+
+**Sample human-readable output**
+- **Success:** Test case created. **QPD-5** — Validate Login. ID: uuid-here.
+- **Failure:** Creation failed. Check that the module ID is valid and required fields (title, moduleId) are provided.
+
+---
+
+### update_test_case
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `update_test_case` |
+| **Description** | Update an existing test case. You can update any field. |
+| **Mandatory parameters** | `testCaseId` (string) – ID of the test case to update |
+| **Optional parameters** | `title` (string)<br>`description` (string)<br>`type` (string)<br>`status` (string)<br>`priority` (string)<br>`estimatedDuration` (number) – Minutes<br>`testData` (string) – JSON string<br>`labels` (array of strings)<br>`projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Update test case 1cf10d9c-…: set priority to High and status to Active."
+- "Change QPD-4 title to 'Updated Login Test' and estimated duration to 60 minutes."
+
+**Sample human-readable output**
+- **Success:** Test case updated. Priority: High; Status: Active.
+- **Failure:** Update failed. Ensure the test case ID exists and you have permission.
+
+---
+
+## 6. Export / Import Tools
+
+### get_export_structure
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `get_export_structure` |
+| **Description** | Get the module structure and test case fields needed for export. Returns JSON with module hierarchy and available test case fields. Can be used to generate Excel templates. |
+| **Mandatory parameters** | None |
+| **Optional parameters** | `projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Get the export structure for this project."
+- "What modules and test case fields are available for export?"
+
+**Sample human-readable output**
+- **Success:** Export structure retrieved. **Modules:** Module Edit (id: …), Component Edit (id: …). **Test case fields:** title, description, type, status, priority, estimatedDuration, testData, labels, …
+- **Empty:** No modules in project; testCaseFields list is still available.
+
+---
+
+## 7. Automation Tools
+
+### generate_nlp_script
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `generate_nlp_script` |
+| **Description** | Generate an automation script from NLP instructions using the Script Creator flow. Runs the AI agent to interpret and execute the instructions, then saves the generated script to the specified test case. Returns execution logs and test steps. Use `list_llm_models` to get available model IDs first. |
+| **Mandatory parameters** | `nlpInstructions` (string) – NLP instructions (one per line). Example: `open https://example.com\nClick Login\nEnter username and password`<br>`modelId` (string) – ID of the AI model to use. Get from `list_llm_models`.<br>`testCaseId` (string) – UUID of the test case where the script will be saved |
+| **Optional parameters** | `projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "First list the available LLM models, then generate an NLP script for test case 1cf10d9c-… with instructions: Navigate to https://www.saucedemo.com, enter username standard_user, enter password secret_sauce, verify logged in."
+- "Generate automation from these steps and save to QPD-4: open login page, type username, type password, click Login, check welcome message."
+
+**Sample human-readable output**
+- **Success:** NLP script generated and saved to **QPD-4**. Status: Completed. Steps executed: 9. Execution time: ~45s.
+- **Failure:** Check that `modelId` is valid (use `list_llm_models`) and `testCaseId` exists.
+
+---
+
+## 8. Test Group & Test Launch Tools
+
+### list_testgroups
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `list_testgroups` |
+| **Description** | List test groups in a project with filtering and sorting. |
+| **Mandatory parameters** | `page` (number, min: 1) – Page number<br>`pageSize` (number, min: 1, max: 10000) – Results per page |
+| **Optional parameters** | `query` (string, max 5000 chars) – Filter query in canonical format<br>`sortField` (string) – Sort by: `name`, `description`, `key`, `group_type`, `created_at`, `updated_at`, `next_scheduled_run`, `createdByUser`<br>`sortOrder` (string) – `ASC` or `DESC`<br>`projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "List all test groups in this project."
+- "Show test groups sorted by created_at descending."
+
+**Sample human-readable output**
+- **Success:** Found **3** test group(s). TG-910 — Smoke Suite; TG-915 — Nightly Regression; TG-920 — API Tests.
+- **Empty:** No test groups found.
+
+---
+
+### get_testgroup
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `get_testgroup` |
+| **Description** | Get detailed information about a specific test group by ID, including associated test cases. |
+| **Mandatory parameters** | `testGroupId` (string) – UUID of the test group |
+| **Optional parameters** | `projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Get details for test group c967fb57-…."
+- "Show me what test cases are in TG-915."
+
+**Sample human-readable output**
+- **Success:** **TG-915** — Nightly Regression. Type: Static. Contains 5 test case(s): QPD-4, QPD-5, …
+- **Failure:** Test group not found for the given ID.
+
+---
+
+### create_testgroup
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `create_testgroup` |
+| **Description** | Create a new test group in a project. Test groups are used to organise test cases for execution (test launches). |
+| **Mandatory parameters** | `name` (string) – Name of the test group |
+| **Optional parameters** | `description` (string) – Optional description<br>`projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Create a test group named 'Nightly Regression'."
+- "Add a new test group called 'Smoke Suite' with description 'Pre-release smoke tests'."
+
+**Sample human-readable output**
+- **Success:** Test group **Nightly Regression** created. Key: **TG-916**. ID: uuid-here.
+- **Failure:** Test group creation failed. Check name and permissions.
+
+---
+
+### update_tests_in_testgroup
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `update_tests_in_testgroup` |
+| **Description** | Add and/or remove test cases from an existing test group. At least one of `addTestCaseIds` or `removeTestCaseIds` must be provided. |
+| **Mandatory parameters** | `testGroupId` (string) – UUID of the test group |
+| **Optional parameters** | `addTestCaseIds` (array of strings) – Test case UUIDs to add<br>`removeTestCaseIds` (array of strings) – Test case UUIDs to remove<br>`projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Add test case 1cf10d9c-… to test group c967fb57-…."
+- "Update TG-915: add QPD-4 and QPD-5, remove QPD-3."
+
+**Sample human-readable output**
+- **Success:** Test group updated. Added: 2. Removed: 1.
+- **Failure:** Provide at least one non-empty list (addTestCaseIds or removeTestCaseIds).
+
+---
+
+### list_environments
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `list_environments` |
+| **Description** | List environments available for the project. Use this to get `environmentId` for `create_test_launch`. |
+| **Mandatory parameters** | None |
+| **Optional parameters** | `projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "List environments for this project."
+- "What environments are available for test launches?"
+
+**Sample human-readable output**
+- **Success:** Found **2** environment(s). **Staging** (id: uuid-1); **Production** (id: uuid-2).
+- **Empty:** No environments configured for this project.
+
+---
+
+### list_llm_models
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `list_llm_models` |
+| **Description** | List LLM (automation) models available for test launches and NLP script generation. Use this to get `modelId` for `generate_nlp_script` or `llmModelId` for `create_test_launch`. |
+| **Mandatory parameters** | None |
+| **Optional parameters** | `projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "List available LLM models."
+- "What AI models can I use for automation?"
+
+**Sample human-readable output**
+- **Success:** Found **2** model(s). **gpt-4o-mini** (id: uuid-1); **5.1 model** (id: uuid-2).
+
+---
+
+### create_test_launch
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `create_test_launch` |
+| **Description** | Create a new test launch in an existing test group. A test launch runs the test cases associated with the group. Use `list_environments` and `list_llm_models` to get the required IDs. |
+| **Mandatory parameters** | `testGroupId` (string) – UUID of the test group to launch<br>`environmentId` (string) – Environment UUID. Get from `list_environments`.<br>`llmModelId` (string) – LLM model UUID. Get from `list_llm_models`. |
+| **Optional parameters** | `name` (string, max 100 chars) – Optional name for the launch<br>`projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "List environments and models, then create a test launch for test group c967fb57-… named 'Nightly Run'."
+- "Launch TG-915 using the Staging environment and gpt-4o-mini model."
+
+**Sample human-readable output**
+- **Success:** Test launch created. **TL-491** — Nightly Run. Status: in_progress. ID: uuid-here.
+- **Failure:** Launch failed. Ensure environmentId and llmModelId are valid UUIDs from their respective list tools.
+
+---
+
+### list_test_launches
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `list_test_launches` |
+| **Description** | List test launches for a specific test group. Supports searching by name/key and filtering by status. |
+| **Mandatory parameters** | `testGroupId` (string) – UUID of the test group |
+| **Optional parameters** | `search` (string, max 255 chars) – Filter launches by name or key<br>`status` (string) – Filter by status: `all`, `new`, `in_progress`, `completed`, `aborted`, `paused` (default: `all`)<br>`page` (number, default: 1) – Page number<br>`pageSize` (number, default: 25, max: 100) – Results per page<br>`projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "List all launches for test group c967fb57-…."
+- "Show in_progress launches for TG-915."
+- "Find a launch named 'Nightly Run' in this test group."
+
+**Sample human-readable output**
+- **Success:** Found **3** launch(es). TL-489 — Completed; TL-490 — Aborted; TL-491 — In Progress.
+- **Empty:** No launches found matching the filters.
+
+---
+
+### get_test_launch
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `get_test_launch` |
+| **Description** | Get detailed information about a specific test launch by ID, including status and execution statistics. |
+| **Mandatory parameters** | `launchId` (string) – UUID of the test launch |
+| **Optional parameters** | `projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Get details for test launch ce259325-…."
+- "Show me the status and stats for TL-491."
+
+**Sample human-readable output**
+- **Success:** **TL-491** — Nightly Run. Status: in_progress. Test cases: 5 total, 3 passed, 1 failed, 1 pending.
+- **Failure:** Test launch not found for the given ID.
+
+---
+
+### update_test_launch
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `update_test_launch` |
+| **Description** | Update an existing test launch status to `completed` or `aborted`. |
+| **Mandatory parameters** | `launchId` (string) – UUID of the test launch<br>`status` (string) – New status: `completed` or `aborted` |
+| **Optional parameters** | `projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Mark test launch ce259325-… as completed."
+- "Abort the running test launch TL-491."
+
+**Sample human-readable output**
+- **Success:** Test launch status updated to **completed**. Launch ID: ce259325-….
+- **Failure:** Only `completed` and `aborted` are supported. Ensure the launch ID exists.
+
+---
+
+## 9. Query Tools
+
+### get_query_schema
+
+| Field | Value |
+|-------|--------|
+| **Tool name** | `get_query_schema` |
+| **Description** | Get the query schema for any entity (`testcase`, `testgroup`, or `project`). Returns all filterable fields, their supported operators, and valid values (including IDs for user/module fields). Use this before constructing a `query` parameter for `list_test_cases`, `list_testgroups`, or `list_projects`. |
+| **Mandatory parameters** | `entity` (string) – Entity type: `testcase`, `testgroup`, or `project` |
+| **Optional parameters** | `projectId` (string) – Project ID (UUID). If not provided, uses active project. |
+
+**Sample prompt(s)**
+- "Get the query schema for test cases."
+- "What fields can I filter test groups by?"
+- "Show me all filterable fields for projects."
+
+**Sample human-readable output**
+- **Success:** Query schema for **testcase**: Fields: `status` (operators: `=`, `!=`; values: `New`, `Active`, …), `priority` (operators: `=`, `!=`; values: `Low`, `Normal`, `High`, `Critical`), `moduleId` (operators: `=`; values: [list of module IDs and names]), …
+
+---
+
+## Summary Table
+
+| Category | Tool name | Mandatory parameters | Optional parameters |
+|----------|-----------|----------------------|---------------------|
+| Auth | check_auth_status | — | — |
+| Project context | set_active_project | projectId | — |
+| Project context | get_active_project | — | — |
+| Project | list_projects | page, pageSize | query, sortField, sortOrder |
+| Project | suggest_project_prefix | projectName | — |
+| Project | create_project | name, prefix | description, context |
+| Project | update_project | projectId, name | description, context |
+| Module | list_modules | — | search, projectId |
+| Module | create_module | name | parentId, context, projectId |
+| Module | update_module | moduleId | name, context, projectId |
+| Module | get_module | moduleId | — |
+| Test case | list_test_cases | — | query, page, pageSize, moduleId, sortField, sortOrder, timezone, projectId |
+| Test case | get_test_case | testCaseId | projectId |
+| Test case | get_execution_history | testCaseId | projectId, page, pageSize |
+| Test case | get_execution_plan | testCaseId | projectId |
+| Test case | create_test_case | title, moduleId | description, type, status, priority, estimatedDuration, testData, labels, projectId |
+| Test case | update_test_case | testCaseId | title, description, type, status, priority, estimatedDuration, testData, labels, projectId |
+| Export | get_export_structure | — | projectId |
+| Automation | generate_nlp_script | nlpInstructions, modelId, testCaseId | projectId |
+| Test group | list_testgroups | page, pageSize | query, sortField, sortOrder, projectId |
+| Test group | get_testgroup | testGroupId | projectId |
+| Test group | create_testgroup | name | description, projectId |
+| Test group | update_tests_in_testgroup | testGroupId | addTestCaseIds, removeTestCaseIds, projectId |
+| Test launch | list_environments | — | projectId |
+| Test launch | list_llm_models | — | projectId |
+| Test launch | create_test_launch | testGroupId, environmentId, llmModelId | name, projectId |
+| Test launch | list_test_launches | testGroupId | search, status, page, pageSize, projectId |
+| Test launch | get_test_launch | launchId | projectId |
+| Test launch | update_test_launch | launchId, status | projectId |
+| Query | get_query_schema | entity | projectId |
+
+---
+
+*Set `QA_PATH_API_KEY` in your MCP config for authentication. Use `set_active_project` once per session to avoid passing `projectId` to every tool call.*

package/dist/__tests__/tools/module-tools.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=module-tools.test.d.ts.map

package/dist/__tests__/tools/module-tools.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"module-tools.test.d.ts","sourceRoot":"","sources":["../../../src/__tests__/tools/module-tools.test.ts"],"names":[],"mappings":""}