@testkase/test-management-mcp 0.0.0-stage → 2.4.0

package/README.md

@@ -1,3 +1,189 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<p align="center">
+  <a href="https://testkase.com">
+    <img src="https://testkase.com/logo.png" alt="TestKase" width="120" />
+  </a>
+</p>
+
+<h3 align="center">@testkase/test-management-mcp</h3>
+
+<p align="center">
+  Official MCP server for <a href="https://testkase.com">TestKase</a> Test Management — connect your AI agent to a complete test management platform.<br/>Formerly <code>@testkase/mcp-server</code>. For real phones and browsers, see <code>@testkase/device-farm-mcp</code>.
+</p>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/@testkase/test-management-mcp"><img src="https://img.shields.io/npm/v/@testkase/test-management-mcp.svg?style=flat-square" alt="npm version" /></a>
+  <a href="https://www.npmjs.com/package/@testkase/test-management-mcp"><img src="https://img.shields.io/npm/dm/@testkase/test-management-mcp.svg?style=flat-square" alt="npm downloads" /></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT License" /></a>
+</p>
+
+---
+
+## What is this?
+
+This package gives AI agents — Claude Desktop, GitHub Copilot, Cursor, or any [MCP](https://modelcontextprotocol.io)-compatible client — full access to your TestKase projects. Your agent can create test cases, run test cycles, record execution results, and pull reports, all through natural language.
+
+**11 tools. Zero config beyond a token. Works out of the box.**
+
+## Quick Start
+
+### 1. Get a PAT token
+
+Log in to [TestKase](https://www.testkase.com) > **API Keys** > **Generate New Token**
+
+### 2. Add to your AI agent
+
+<details>
+<summary><strong>Claude Desktop</strong></summary>
+
+Edit your config file:
+- **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
+- **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
+
+```json
+{
+  "mcpServers": {
+    "testkase": {
+      "command": "npx",
+      "args": ["-y", "@testkase/test-management-mcp"],
+      "env": {
+        "TESTKASE_API_BASE_URL": "https://api.testkase.com",
+        "TESTKASE_PAT_TOKEN": "xyz_your_token_here"
+      }
+    }
+  }
+}
+```
+</details>
+
+<details>
+<summary><strong>GitHub Copilot (VS Code)</strong></summary>
+
+Edit your config file:
+- **Windows:** `%APPDATA%\Code\User\globalStorage\github.copilot\mcp.json`
+- **macOS:** `~/Library/Application Support/Code/User/globalStorage/github.copilot/mcp.json`
+
+```json
+{
+  "mcpServers": {
+    "testkase": {
+      "command": "npx",
+      "args": ["-y", "@testkase/test-management-mcp"],
+      "env": {
+        "TESTKASE_API_BASE_URL": "https://api.testkase.com",
+        "TESTKASE_PAT_TOKEN": "xyz_your_token_here"
+      }
+    }
+  }
+}
+```
+</details>
+
+<details>
+<summary><strong>Claude Code (CLI)</strong></summary>
+
+```bash
+claude mcp add testkase -e TESTKASE_API_BASE_URL=https://api.testkase.com -e TESTKASE_PAT_TOKEN=xyz_your_token_here -- npx -y @testkase/test-management-mcp
+```
+</details>
+
+<details>
+<summary><strong>Cursor</strong></summary>
+
+Add to `.cursor/mcp.json` in your project root:
+
+```json
+{
+  "mcpServers": {
+    "testkase": {
+      "command": "npx",
+      "args": ["-y", "@testkase/test-management-mcp"],
+      "env": {
+        "TESTKASE_API_BASE_URL": "https://api.testkase.com",
+        "TESTKASE_PAT_TOKEN": "xyz_your_token_here"
+      }
+    }
+  }
+}
+```
+</details>
+
+### 3. Restart your agent and start talking
+
+```
+"List my projects"
+"Create a login test case in PRJ-1001 with steps"
+"Run TEST-1 as pass in cycle TCYCLE-5"
+"Show me the execution summary for PRJ-1001"
+```
+
+---
+
+## Tools
+
+| Tool | Description |
+|------|-------------|
+| `list_projects` | List all accessible projects |
+| `get_project_structure` | Get folders, labels, members, and field options for a project |
+| `search_testcases` | Search test cases by text, folder, filters, sorting, and pagination |
+| `get_testcase` | Get full test case details including steps |
+| `manage_testcase` | Create, bulk create, update, or delete test cases; add, edit, delete or reorder test steps |
+| `manage_folder` | Create, rename, move, or delete folders (all sections) |
+| `search_test_cycles` | Search test cycles with execution progress |
+| `manage_test_cycle` | Full cycle lifecycle — CRUD, link/unlink/assign test cases |
+| `execute_tests` | Record execution results — manual (default) or as a CI/automation run |
+| `manage_test_plan` | Full plan lifecycle — CRUD, link/unlink cycles, view test cases |
+| `get_report` | Pull from 40+ report types (see below) |
+
+### Reporting
+
+`get_report` covers execution, coverage, trends, team, defect, and insight report types (insights are computed from your data and use no AI credits):
+
+| Category | Report Types |
+|----------|-------------|
+| **Execution** | `execution_summary`, `execution_by_cycle`, `execution_by_tester`, `execution_by_priority`, `execution_by_environment`, `execution_by_folder`, `execution_by_automation` |
+| **Coverage** | `requirement_coverage`, `traceability_matrix`, `failed_requirements`, `uncovered_requirements`, `testcase_coverage`, `unlinked_testcases` |
+| **Trends** | `execution_trend`, `execution_burnup`, `execution_burndown`, `test_creation`, `requirement_coverage_trend`, `execution_velocity` |
+| **Comparison** | `cycle_comparison`, `created_vs_executed`, `scorecard_by_folder`, `scorecard_by_tester` |
+| **Team** | `tester_workload`, `testcase_distribution`, `tester_effectiveness` |
+| **Defects** | `defects_by_cycle`, `defects_by_tester`, `defects_by_folder`, `defect_hotspots` |
+| **Insights** | `predictive_failure`, `smart_prioritization`, `testcase_quality`, `stale_tests`, `flaky_tests`, `suite_optimization` |
+| **Risk & Release** | `release_readiness`, `risk_heatmap_folder`, `risk_heatmap_feature`, `requirement_risk_matrix`, `cycle_health`, `project_health` |
+
+---
+
+## Configuration
+
+| Variable | Required | Default | Description |
+|----------|----------|---------|-------------|
+| `TESTKASE_PAT_TOKEN` | Yes | — | Personal Access Token (starts with `xyz_`) |
+| `TESTKASE_API_BASE_URL` | No | `https://api.testkase.com` | API endpoint |
+| `TESTKASE_ORGANIZATION_ID` | No | your first organization | Set this if you belong to more than one organization |
+| `TESTKASE_APP_URL` | No | `https://test-management.testkase.com` | Base for the links returned with results |
+
+---
+
+## Troubleshooting
+
+| Problem | Solution |
+|---------|----------|
+| "Authentication required" | Verify your token starts with `xyz_` and hasn't expired |
+| Tool not showing up | Restart your AI agent completely; check JSON syntax in config |
+| API connection errors | Verify `TESTKASE_API_BASE_URL` is reachable |
+
+---
+
+## Links
+
+- [TestKase](https://testkase.com) — Product website
+- [Documentation](https://docs.testkase.com) — Full platform docs
+- [MCP Protocol](https://modelcontextprotocol.io) — Model Context Protocol spec
+
+## License
+
+MIT
+
+---
+
+<p align="center">
+  Built by <a href="https://testkase.com">TestKase</a>
+</p>

package/build/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/build/index.d.ts.map

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