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

package/README.md

@@ -1,3 +1,88 @@
-# Temporary Holding Version
+<p align="center">
+  <a href="https://testkase.com">
+    <img src="https://testkase.com/logo.png" alt="TestKase" width="120" />
+  </a>
+</p>
 
-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.
+<h3 align="center">@testkase/test-management-mcp</h3>
+
+<p align="center">
+  Official MCP server for <a href="https://testkase.com">TestKase Test Management</a>: let your AI assistant manage test cases, cycles, plans and reports.
+</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://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square" alt="MIT License" /></a>
+</p>
+
+---
+
+Works with Claude, GitHub Copilot, Cursor and any [MCP](https://modelcontextprotocol.io) client. Pairs with [`@testkase/device-farm-mcp`](https://www.npmjs.com/package/@testkase/device-farm-mcp) for real phones and browsers.
+
+> **Formerly `@testkase/mcp-server`.** Same tools and key: change the package name in your config to `@testkase/test-management-mcp`.
+
+## Quick start
+
+1. **Get an access key:** TestKase > **API Keys** > **Create API Key** (starts with `xyz_`).
+2. **Add it to your assistant** (Claude Desktop, Copilot, Cursor: same block in their MCP config file):
+
+```json
+{
+  "mcpServers": {
+    "testkase": {
+      "command": "npx",
+      "args": ["-y", "@testkase/test-management-mcp"],
+      "env": { "TESTKASE_PAT_TOKEN": "xyz_your_token_here" }
+    }
+  }
+}
+```
+
+Claude Code:
+
+```bash
+claude mcp add testkase -e TESTKASE_PAT_TOKEN=xyz_your_token_here -- npx -y @testkase/test-management-mcp
+```
+
+3. **Restart your assistant and ask:** "List my projects", "Create a login test case in PRJ-1001 with steps", "Mark TEST-1 passed in cycle TCYCLE-5", "Show the execution summary".
+
+## Tools
+
+| Tool | What it does |
+|------|--------------|
+| `list_projects` / `get_project_structure` | Your projects, and their folders, labels, members and fields. |
+| `search_testcases` / `get_testcase` | Find test cases; read one with its steps. |
+| `manage_testcase` | Create, bulk-create, update or delete test cases and their steps. |
+| `manage_folder` | Create, rename, move or delete folders. |
+| `search_test_cycles` / `manage_test_cycle` | Find and manage test cycles; link and assign test cases. |
+| `execute_tests` | Record results, manual or as a CI run. |
+| `manage_test_plan` | Manage test plans and their cycles. |
+| `get_report` | 40+ reports: execution, coverage, trends, team, defects, insights, risk and release. |
+
+## Your key and privacy
+
+- The key stays on your machine and goes only to TestKase.
+- It acts as you, with your project permissions.
+- Test data you ask about is passed to your AI assistant.
+
+## Settings
+
+| Variable | Required | Default |
+|----------|----------|---------|
+| `TESTKASE_PAT_TOKEN` | Yes | |
+| `TESTKASE_API_BASE_URL` | No | `https://api.testkase.com` |
+| `TESTKASE_ORGANIZATION_ID` | No | your first organization (set it if you belong to several) |
+
+## Troubleshooting
+
+| Problem | Fix |
+|---------|-----|
+| "Authentication required" | Check the key starts with `xyz_` and hasn't expired. |
+| Tools don't show up | Restart the assistant fully; check the JSON in your config. |
+| Connection errors | Check `TESTKASE_API_BASE_URL` is reachable. |
+
+## Links
+
+[TestKase](https://testkase.com) · [Docs](https://docs.testkase.com) · [`@testkase/device-farm-mcp`](https://www.npmjs.com/package/@testkase/device-farm-mcp)
+
+MIT License

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":""}