@bun913/mcp-testrail 0.11.14 → 0.12.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.
- package/README.md +9 -51
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ The TestRail MCP server provides the following tools:
|
|
|
8
8
|
|
|
9
9
|
| Category | Tools |
|
|
10
10
|
|----------|-------|
|
|
11
|
-
| **Projects** | `getProjects`, `getProject
|
|
11
|
+
| **Projects** | `getProjects`, `getProject` |
|
|
12
12
|
| **Suites** | `getSuites`, `getSuite`, `addSuite`, `updateSuite` |
|
|
13
13
|
| **Cases** | `getCase`, `getCases`, `addCase`, `updateCase`, `deleteCase`, `getCaseTypes`, `getCaseFields`, `copyToSection`, `moveToSection`, `getCaseHistory`, `updateCases` |
|
|
14
14
|
| **Sections** | `getSection`, `getSections`, `addSection`, `moveSection`, `updateSection`, `deleteSection` |
|
|
@@ -21,67 +21,25 @@ The TestRail MCP server provides the following tools:
|
|
|
21
21
|
|
|
22
22
|
## Usage
|
|
23
23
|
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
To use the TestRail MCP server in Cursor with Claude:
|
|
27
|
-
|
|
28
|
-
1. Start the server locally with `npm run start`
|
|
29
|
-
- Please run `npm install` and `npm run build`, before you execute the command
|
|
30
|
-
- Please set up your .env based on the .env.example file as a reference.
|
|
31
|
-
2. The server will run on `http://localhost:8080/sse`
|
|
32
|
-
3. In Cursor, navigate to the MCP Servers section and add the TestRail server
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
4. Configure with the following details:
|
|
37
|
-
- **Name**: TestRail
|
|
38
|
-
- **Server Link**: http://localhost:8080/sse
|
|
39
|
-
- **Connection Type**: SSE
|
|
40
|
-
|
|
41
|
-
Once connected, you'll see all the available tools as shown in the image above.
|
|
42
|
-
|
|
43
|
-
Or, you can connect this MCP server by setting like the below.
|
|
24
|
+
You can connect this MCP server by setting like the below. This method uses `npx` to automatically download and run the latest version of the package, eliminating the need for local installation.
|
|
44
25
|
|
|
45
26
|
```json
|
|
46
|
-
// Example
|
|
27
|
+
// Example configuration using npx
|
|
47
28
|
{
|
|
48
29
|
"mcpServers": {
|
|
49
|
-
"
|
|
50
|
-
"
|
|
51
|
-
"
|
|
52
|
-
"args": ["${YOUR_PROJECT_PATH}/mcp-testrail/dist/stdio.js"],
|
|
30
|
+
"testrail": {
|
|
31
|
+
"command": "npx",
|
|
32
|
+
"args": ["@bun913/mcp-testrail@latest"],
|
|
53
33
|
"env": {
|
|
54
|
-
"TESTRAIL_URL": "https://
|
|
55
|
-
"TESTRAIL_USERNAME": "
|
|
56
|
-
"TESTRAIL_API_KEY": "YOUR_API_KEY"
|
|
34
|
+
"TESTRAIL_URL": "https://your-instance.testrail.io", // Replace with your TestRail URL
|
|
35
|
+
"TESTRAIL_USERNAME": "your-email@example.com", // Replace with your TestRail username
|
|
36
|
+
"TESTRAIL_API_KEY": "YOUR_API_KEY" // Replace with your TestRail API key
|
|
57
37
|
}
|
|
58
38
|
}
|
|
59
39
|
}
|
|
60
40
|
}
|
|
61
41
|
```
|
|
62
42
|
|
|
63
|
-
### Calling Tools from MCP Clients
|
|
64
|
-
|
|
65
|
-
When using an MCP-supported client like Claude in Cursor, you can call the TestRail MCP tools directly during your conversation. For each tool, you'll need to provide the appropriate parameters as defined in the TestRail API.
|
|
66
|
-
|
|
67
|
-
From Cursor:
|
|
68
|
-
|
|
69
|
-
```json
|
|
70
|
-
// You can set ~/.cursor/mcp.json as below
|
|
71
|
-
{
|
|
72
|
-
"mcpServers": {
|
|
73
|
-
"testrail": {
|
|
74
|
-
"type": "sse",
|
|
75
|
-
"url": "http://localhost:8080/sse"
|
|
76
|
-
}
|
|
77
|
-
}
|
|
78
|
-
}
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
From Claude Desktop:
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
43
|
## Troubleshooting
|
|
86
44
|
|
|
87
45
|
- **`spawn node ENOENT` errors**: Ensure that Node.js is properly installed and in your PATH.
|