zephyr-scale-mcp-server 0.0.3 → 0.0.5

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 (2) hide show
  1. package/README.md +25 -53
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -4,35 +4,23 @@ Model Context Protocol server for Zephyr Scale test management. Create, read, an
4
4
 
5
5
  ## Quick Start
6
6
 
7
- ### Option 1: Install from npm
8
- ```bash
9
- npm install -g zephyr-scale-mcp-server
10
- ```
7
+ ### Option 1: Using npx (Recommended - No installation required)
8
+ Just configure your MCP client with the npx command below.
11
9
 
12
- ### Option 2: Build locally
10
+ ### Option 2: Install from npm
13
11
  ```bash
14
- # Clone and build
15
- git clone <repository-url>
16
- cd zephyr-scale-mcp-server
17
- npm install
18
- npm run build
19
-
20
- # Configure environment
21
- export ZEPHYR_API_KEY="your-api-token"
22
- export ZEPHYR_BASE_URL="https://your-company.atlassian.net"
23
-
24
- # Test the server
25
- node build/index.js
12
+ npm install -g zephyr-scale-mcp-server
26
13
  ```
27
14
 
28
15
  ## MCP Configuration
29
16
 
30
- ### For npm installation:
17
+ ### Option 1: Using npx (Recommended - No installation required)
31
18
  ```json
32
19
  {
33
20
  "mcpServers": {
34
21
  "zephyr-server": {
35
- "command": "zephyr-scale-mcp",
22
+ "command": "npx",
23
+ "args": ["zephyr-scale-mcp-server@latest"],
36
24
  "env": {
37
25
  "ZEPHYR_API_KEY": "your-api-token",
38
26
  "ZEPHYR_BASE_URL": "https://your-company.atlassian.net"
@@ -42,13 +30,18 @@ node build/index.js
42
30
  }
43
31
  ```
44
32
 
45
- ### For local build:
33
+ ### Option 2: Using global npm installation
34
+ First install the package globally:
35
+ ```bash
36
+ npm install -g zephyr-scale-mcp-server
37
+ ```
38
+
39
+ Then configure:
46
40
  ```json
47
41
  {
48
42
  "mcpServers": {
49
43
  "zephyr-server": {
50
- "command": "node",
51
- "args": ["/path/to/zephyr-scale-mcp-server/build/index.js"],
44
+ "command": "zephyr-scale-mcp",
52
45
  "env": {
53
46
  "ZEPHYR_API_KEY": "your-api-token",
54
47
  "ZEPHYR_BASE_URL": "https://your-company.atlassian.net"
@@ -60,12 +53,13 @@ node build/index.js
60
53
 
61
54
  ## Available Tools
62
55
 
63
- - `create_test_case` - Create STEP_BY_STEP or PLAIN_TEXT test cases
64
- - `create_test_case_with_bdd` - Create BDD/Gherkin test cases
65
- - `get_test_case` - Get test case details
66
- - `update_test_case_bdd` - Update BDD test cases
67
- - `create_folder` - Create test case folders
68
- - `get_test_run_cases` - Get test cases from test runs
56
+ - `get_test_case` - Get detailed information about a specific test case
57
+ - `create_test_case` - Create a new test case with STEP_BY_STEP or PLAIN_TEXT content
58
+ - `create_test_case_with_bdd` - Create a new test case with BDD content
59
+ - `update_test_case_bdd` - Update an existing test case with BDD content
60
+ - `delete_test_case` - Delete a specific test case
61
+ - `create_folder` - Create a new folder in Zephyr Scale
62
+ - `get_test_run_cases` - Get test case keys from a test run
69
63
 
70
64
  ## Examples
71
65
 
@@ -102,36 +96,14 @@ node build/index.js
102
96
  }
103
97
  ```
104
98
 
105
- ## Verification
106
-
107
- After installation, verify the package works:
108
-
109
- ```bash
110
- # Check installation
111
- which zephyr-scale-mcp
112
- # Should show: /opt/homebrew/bin/zephyr-scale-mcp (or similar path)
113
-
114
- # Test with environment variables
115
- export ZEPHYR_API_KEY="your-api-token"
116
- export ZEPHYR_BASE_URL="https://your-company.atlassian.net"
117
- zephyr-scale-mcp
118
- # Should start the MCP server (Ctrl+C to exit)
119
- ```
120
-
121
- ### MCP Integration Test
122
-
123
- Once configured in your MCP client, test with:
124
-
99
+ ### Delete Test Case
125
100
  ```json
126
101
  {
127
- "tool": "get_test_case",
128
- "arguments": {
129
- "test_case_key": "PROJ-T123"
130
- }
102
+ "test_case_key": "PROJ-T123"
131
103
  }
132
104
  ```
133
105
 
134
- Expected response includes test case details, BDD scripts, and metadata.
106
+
135
107
 
136
108
  ## Authentication
137
109
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zephyr-scale-mcp-server",
3
- "version": "0.0.3",
3
+ "version": "0.0.5",
4
4
  "description": "Model Context Protocol (MCP) server for Zephyr Scale test case management with comprehensive STEP_BY_STEP, PLAIN_TEXT, and BDD support",
5
5
  "type": "module",
6
6
  "main": "./build/index.js",