@testkase/mcp-server 2.2.0 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/README.md +189 -187
  2. package/build/index.js +426 -236
  3. package/build/index.js.map +1 -1
  4. package/package.json +40 -40
package/README.md CHANGED
@@ -1,187 +1,189 @@
1
- <p align="center">
2
- <a href="https://testkase.com">
3
- <img src="https://testkase.com/logo.png" alt="TestKase" width="120" />
4
- </a>
5
- </p>
6
-
7
- <h3 align="center">@testkase/mcp-server</h3>
8
-
9
- <p align="center">
10
- Official MCP server for <a href="https://testkase.com">TestKase</a> — connect your AI agent to a complete test management platform.
11
- </p>
12
-
13
- <p align="center">
14
- <a href="https://www.npmjs.com/package/@testkase/mcp-server"><img src="https://img.shields.io/npm/v/@testkase/mcp-server.svg?style=flat-square" alt="npm version" /></a>
15
- <a href="https://www.npmjs.com/package/@testkase/mcp-server"><img src="https://img.shields.io/npm/dm/@testkase/mcp-server.svg?style=flat-square" alt="npm downloads" /></a>
16
- <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>
17
- </p>
18
-
19
- ---
20
-
21
- ## What is this?
22
-
23
- 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.
24
-
25
- **11 tools. Zero config beyond a token. Works out of the box.**
26
-
27
- ## Quick Start
28
-
29
- ### 1. Get a PAT token
30
-
31
- Log in to [TestKase](https://app.testkase.com) > **Settings** > **Personal Access Tokens** > **Generate New Token**
32
-
33
- ### 2. Add to your AI agent
34
-
35
- <details>
36
- <summary><strong>Claude Desktop</strong></summary>
37
-
38
- Edit your config file:
39
- - **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
40
- - **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
41
-
42
- ```json
43
- {
44
- "mcpServers": {
45
- "testkase": {
46
- "command": "npx",
47
- "args": ["-y", "@testkase/mcp-server"],
48
- "env": {
49
- "TESTKASE_API_BASE_URL": "https://api.testkase.com",
50
- "TESTKASE_PAT_TOKEN": "xyz_your_token_here"
51
- }
52
- }
53
- }
54
- }
55
- ```
56
- </details>
57
-
58
- <details>
59
- <summary><strong>GitHub Copilot (VS Code)</strong></summary>
60
-
61
- Edit your config file:
62
- - **Windows:** `%APPDATA%\Code\User\globalStorage\github.copilot\mcp.json`
63
- - **macOS:** `~/Library/Application Support/Code/User/globalStorage/github.copilot/mcp.json`
64
-
65
- ```json
66
- {
67
- "mcpServers": {
68
- "testkase": {
69
- "command": "npx",
70
- "args": ["-y", "@testkase/mcp-server"],
71
- "env": {
72
- "TESTKASE_API_BASE_URL": "https://api.testkase.com",
73
- "TESTKASE_PAT_TOKEN": "xyz_your_token_here"
74
- }
75
- }
76
- }
77
- }
78
- ```
79
- </details>
80
-
81
- <details>
82
- <summary><strong>Claude Code (CLI)</strong></summary>
83
-
84
- ```bash
85
- claude mcp add testkase -e TESTKASE_API_BASE_URL=https://api.testkase.com -e TESTKASE_PAT_TOKEN=xyz_your_token_here -- npx -y @testkase/mcp-server
86
- ```
87
- </details>
88
-
89
- <details>
90
- <summary><strong>Cursor</strong></summary>
91
-
92
- Add to `.cursor/mcp.json` in your project root:
93
-
94
- ```json
95
- {
96
- "mcpServers": {
97
- "testkase": {
98
- "command": "npx",
99
- "args": ["-y", "@testkase/mcp-server"],
100
- "env": {
101
- "TESTKASE_API_BASE_URL": "https://api.testkase.com",
102
- "TESTKASE_PAT_TOKEN": "xyz_your_token_here"
103
- }
104
- }
105
- }
106
- }
107
- ```
108
- </details>
109
-
110
- ### 3. Restart your agent and start talking
111
-
112
- ```
113
- "List my projects"
114
- "Create a login test case in PRJ-1001 with steps"
115
- "Run TEST-1 as pass in cycle TCYCLE-5"
116
- "Show me the execution summary for PRJ-1001"
117
- ```
118
-
119
- ---
120
-
121
- ## Tools
122
-
123
- | Tool | Description |
124
- |------|-------------|
125
- | `list_projects` | List all accessible projects |
126
- | `get_project_structure` | Get folders, labels, members, and field options for a project |
127
- | `search_testcases` | Search test cases with filters, sorting, and pagination |
128
- | `get_testcase` | Get full test case details including steps |
129
- | `manage_testcase` | Create, bulk create, update, or delete test cases |
130
- | `manage_folder` | Create, rename, move, or delete folders (all sections) |
131
- | `search_test_cycles` | Search test cycles with execution progress |
132
- | `manage_test_cycle` | Full cycle lifecycle — CRUD, link/unlink/assign test cases |
133
- | `execute_tests` | Record execution results (single or bulk) |
134
- | `manage_test_plan` | Full plan lifecycle — CRUD, link/unlink cycles, view test cases |
135
- | `get_report` | Pull from 40+ report types (see below) |
136
-
137
- ### Reporting
138
-
139
- `get_report` covers execution, coverage, trends, team, defect, and AI-powered report types:
140
-
141
- | Category | Report Types |
142
- |----------|-------------|
143
- | **Execution** | `execution_summary`, `execution_by_cycle`, `execution_by_tester`, `execution_by_priority`, `execution_by_environment`, `execution_by_folder`, `execution_by_automation` |
144
- | **Coverage** | `requirement_coverage`, `traceability_matrix`, `failed_requirements`, `uncovered_requirements`, `testcase_coverage`, `unlinked_testcases` |
145
- | **Trends** | `execution_trend`, `execution_burnup`, `execution_burndown`, `test_creation`, `requirement_coverage_trend`, `execution_velocity` |
146
- | **Comparison** | `cycle_comparison`, `created_vs_executed`, `scorecard_by_folder`, `scorecard_by_tester` |
147
- | **Team** | `tester_workload`, `testcase_distribution`, `tester_effectiveness` |
148
- | **Defects** | `defects_by_cycle`, `defects_by_tester`, `defects_by_folder`, `defect_hotspots` |
149
- | **AI Insights** | `predictive_failure`, `smart_prioritization`, `testcase_quality`, `stale_tests`, `flaky_tests`, `suite_optimization` |
150
- | **Risk & Release** | `release_readiness`, `risk_heatmap_folder`, `risk_heatmap_feature`, `requirement_risk_matrix`, `cycle_health`, `project_health` |
151
-
152
- ---
153
-
154
- ## Configuration
155
-
156
- | Variable | Required | Default | Description |
157
- |----------|----------|---------|-------------|
158
- | `TESTKASE_PAT_TOKEN` | Yes | — | Personal Access Token (starts with `xyz_`) |
159
- | `TESTKASE_API_BASE_URL` | No | `https://api.testkase.com` | API endpoint |
160
-
161
- ---
162
-
163
- ## Troubleshooting
164
-
165
- | Problem | Solution |
166
- |---------|----------|
167
- | "Authentication required" | Verify your token starts with `xyz_` and hasn't expired |
168
- | Tool not showing up | Restart your AI agent completely; check JSON syntax in config |
169
- | API connection errors | Verify `TESTKASE_API_BASE_URL` is reachable |
170
-
171
- ---
172
-
173
- ## Links
174
-
175
- - [TestKase](https://testkase.com) — Product website
176
- - [Documentation](https://docs.testkase.com) — Full platform docs
177
- - [MCP Protocol](https://modelcontextprotocol.io) — Model Context Protocol spec
178
-
179
- ## License
180
-
181
- MIT
182
-
183
- ---
184
-
185
- <p align="center">
186
- Built by <a href="https://testkase.com">TestKase</a>
187
- </p>
1
+ <p align="center">
2
+ <a href="https://testkase.com">
3
+ <img src="https://testkase.com/logo.png" alt="TestKase" width="120" />
4
+ </a>
5
+ </p>
6
+
7
+ <h3 align="center">@testkase/mcp-server</h3>
8
+
9
+ <p align="center">
10
+ Official MCP server for <a href="https://testkase.com">TestKase</a> — connect your AI agent to a complete test management platform.
11
+ </p>
12
+
13
+ <p align="center">
14
+ <a href="https://www.npmjs.com/package/@testkase/mcp-server"><img src="https://img.shields.io/npm/v/@testkase/mcp-server.svg?style=flat-square" alt="npm version" /></a>
15
+ <a href="https://www.npmjs.com/package/@testkase/mcp-server"><img src="https://img.shields.io/npm/dm/@testkase/mcp-server.svg?style=flat-square" alt="npm downloads" /></a>
16
+ <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>
17
+ </p>
18
+
19
+ ---
20
+
21
+ ## What is this?
22
+
23
+ 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.
24
+
25
+ **11 tools. Zero config beyond a token. Works out of the box.**
26
+
27
+ ## Quick Start
28
+
29
+ ### 1. Get a PAT token
30
+
31
+ Log in to [TestKase](https://www.testkase.com) > **API Keys** > **Generate New Token**
32
+
33
+ ### 2. Add to your AI agent
34
+
35
+ <details>
36
+ <summary><strong>Claude Desktop</strong></summary>
37
+
38
+ Edit your config file:
39
+ - **Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
40
+ - **macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
41
+
42
+ ```json
43
+ {
44
+ "mcpServers": {
45
+ "testkase": {
46
+ "command": "npx",
47
+ "args": ["-y", "@testkase/mcp-server"],
48
+ "env": {
49
+ "TESTKASE_API_BASE_URL": "https://api.testkase.com",
50
+ "TESTKASE_PAT_TOKEN": "xyz_your_token_here"
51
+ }
52
+ }
53
+ }
54
+ }
55
+ ```
56
+ </details>
57
+
58
+ <details>
59
+ <summary><strong>GitHub Copilot (VS Code)</strong></summary>
60
+
61
+ Edit your config file:
62
+ - **Windows:** `%APPDATA%\Code\User\globalStorage\github.copilot\mcp.json`
63
+ - **macOS:** `~/Library/Application Support/Code/User/globalStorage/github.copilot/mcp.json`
64
+
65
+ ```json
66
+ {
67
+ "mcpServers": {
68
+ "testkase": {
69
+ "command": "npx",
70
+ "args": ["-y", "@testkase/mcp-server"],
71
+ "env": {
72
+ "TESTKASE_API_BASE_URL": "https://api.testkase.com",
73
+ "TESTKASE_PAT_TOKEN": "xyz_your_token_here"
74
+ }
75
+ }
76
+ }
77
+ }
78
+ ```
79
+ </details>
80
+
81
+ <details>
82
+ <summary><strong>Claude Code (CLI)</strong></summary>
83
+
84
+ ```bash
85
+ claude mcp add testkase -e TESTKASE_API_BASE_URL=https://api.testkase.com -e TESTKASE_PAT_TOKEN=xyz_your_token_here -- npx -y @testkase/mcp-server
86
+ ```
87
+ </details>
88
+
89
+ <details>
90
+ <summary><strong>Cursor</strong></summary>
91
+
92
+ Add to `.cursor/mcp.json` in your project root:
93
+
94
+ ```json
95
+ {
96
+ "mcpServers": {
97
+ "testkase": {
98
+ "command": "npx",
99
+ "args": ["-y", "@testkase/mcp-server"],
100
+ "env": {
101
+ "TESTKASE_API_BASE_URL": "https://api.testkase.com",
102
+ "TESTKASE_PAT_TOKEN": "xyz_your_token_here"
103
+ }
104
+ }
105
+ }
106
+ }
107
+ ```
108
+ </details>
109
+
110
+ ### 3. Restart your agent and start talking
111
+
112
+ ```
113
+ "List my projects"
114
+ "Create a login test case in PRJ-1001 with steps"
115
+ "Run TEST-1 as pass in cycle TCYCLE-5"
116
+ "Show me the execution summary for PRJ-1001"
117
+ ```
118
+
119
+ ---
120
+
121
+ ## Tools
122
+
123
+ | Tool | Description |
124
+ |------|-------------|
125
+ | `list_projects` | List all accessible projects |
126
+ | `get_project_structure` | Get folders, labels, members, and field options for a project |
127
+ | `search_testcases` | Search test cases by text, folder, filters, sorting, and pagination |
128
+ | `get_testcase` | Get full test case details including steps |
129
+ | `manage_testcase` | Create, bulk create, update, or delete test cases; add, edit, delete or reorder test steps |
130
+ | `manage_folder` | Create, rename, move, or delete folders (all sections) |
131
+ | `search_test_cycles` | Search test cycles with execution progress |
132
+ | `manage_test_cycle` | Full cycle lifecycle — CRUD, link/unlink/assign test cases |
133
+ | `execute_tests` | Record execution results — manual (default) or as a CI/automation run |
134
+ | `manage_test_plan` | Full plan lifecycle — CRUD, link/unlink cycles, view test cases |
135
+ | `get_report` | Pull from 40+ report types (see below) |
136
+
137
+ ### Reporting
138
+
139
+ `get_report` covers execution, coverage, trends, team, defect, and insight report types (insights are computed from your data and use no AI credits):
140
+
141
+ | Category | Report Types |
142
+ |----------|-------------|
143
+ | **Execution** | `execution_summary`, `execution_by_cycle`, `execution_by_tester`, `execution_by_priority`, `execution_by_environment`, `execution_by_folder`, `execution_by_automation` |
144
+ | **Coverage** | `requirement_coverage`, `traceability_matrix`, `failed_requirements`, `uncovered_requirements`, `testcase_coverage`, `unlinked_testcases` |
145
+ | **Trends** | `execution_trend`, `execution_burnup`, `execution_burndown`, `test_creation`, `requirement_coverage_trend`, `execution_velocity` |
146
+ | **Comparison** | `cycle_comparison`, `created_vs_executed`, `scorecard_by_folder`, `scorecard_by_tester` |
147
+ | **Team** | `tester_workload`, `testcase_distribution`, `tester_effectiveness` |
148
+ | **Defects** | `defects_by_cycle`, `defects_by_tester`, `defects_by_folder`, `defect_hotspots` |
149
+ | **Insights** | `predictive_failure`, `smart_prioritization`, `testcase_quality`, `stale_tests`, `flaky_tests`, `suite_optimization` |
150
+ | **Risk & Release** | `release_readiness`, `risk_heatmap_folder`, `risk_heatmap_feature`, `requirement_risk_matrix`, `cycle_health`, `project_health` |
151
+
152
+ ---
153
+
154
+ ## Configuration
155
+
156
+ | Variable | Required | Default | Description |
157
+ |----------|----------|---------|-------------|
158
+ | `TESTKASE_PAT_TOKEN` | Yes | — | Personal Access Token (starts with `xyz_`) |
159
+ | `TESTKASE_API_BASE_URL` | No | `https://api.testkase.com` | API endpoint |
160
+ | `TESTKASE_ORGANIZATION_ID` | No | your first organization | Set this if you belong to more than one organization |
161
+ | `TESTKASE_APP_URL` | No | `https://test-management.testkase.com` | Base for the links returned with results |
162
+
163
+ ---
164
+
165
+ ## Troubleshooting
166
+
167
+ | Problem | Solution |
168
+ |---------|----------|
169
+ | "Authentication required" | Verify your token starts with `xyz_` and hasn't expired |
170
+ | Tool not showing up | Restart your AI agent completely; check JSON syntax in config |
171
+ | API connection errors | Verify `TESTKASE_API_BASE_URL` is reachable |
172
+
173
+ ---
174
+
175
+ ## Links
176
+
177
+ - [TestKase](https://testkase.com) — Product website
178
+ - [Documentation](https://docs.testkase.com) — Full platform docs
179
+ - [MCP Protocol](https://modelcontextprotocol.io) — Model Context Protocol spec
180
+
181
+ ## License
182
+
183
+ MIT
184
+
185
+ ---
186
+
187
+ <p align="center">
188
+ Built by <a href="https://testkase.com">TestKase</a>
189
+ </p>