@askqa/mcp 1.0.1 → 1.0.3
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 +75 -0
- package/package.json +4 -3
package/README.md
ADDED
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
# @askqa/mcp
|
|
2
|
+
|
|
3
|
+
MCP server for [AskQA](https://askqa.ai) — monitor websites with automated tests by chatting with AI.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
Add to your MCP client config (e.g. Claude Code, Claude Desktop, Cursor):
|
|
8
|
+
|
|
9
|
+
```json
|
|
10
|
+
{
|
|
11
|
+
"mcpServers": {
|
|
12
|
+
"askqa": {
|
|
13
|
+
"command": "npx",
|
|
14
|
+
"args": ["-y", "@askqa/mcp"],
|
|
15
|
+
"env": {
|
|
16
|
+
"AUTOQA_API_URL": "https://api.askqa.ai",
|
|
17
|
+
"AUTOQA_API_KEY": "aq_..."
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
}
|
|
21
|
+
}
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Get your API key from [askqa.ai](https://askqa.ai) after signing in.
|
|
25
|
+
|
|
26
|
+
## Environment Variables
|
|
27
|
+
|
|
28
|
+
| Variable | Required | Description |
|
|
29
|
+
| ---------------- | -------- | ------------------------------------------ |
|
|
30
|
+
| `AUTOQA_API_KEY` | Yes | Your AskQA API key |
|
|
31
|
+
| `AUTOQA_API_URL` | No | API URL (default: `http://localhost:8081`) |
|
|
32
|
+
|
|
33
|
+
## Tools
|
|
34
|
+
|
|
35
|
+
| Tool | Description |
|
|
36
|
+
| ----------------------------- | ------------------------------------------------------- |
|
|
37
|
+
| `list_tests` | List all saved tests |
|
|
38
|
+
| `get_test` | Get full details of a test |
|
|
39
|
+
| `create_test` | Create a test from a template or custom Playwright code |
|
|
40
|
+
| `update_test` | Update an existing test |
|
|
41
|
+
| `delete_test` | Delete a test (with confirmation) |
|
|
42
|
+
| `run_test` | Run a test and wait for results |
|
|
43
|
+
| `get_test_results` | Get recent test run results with step details |
|
|
44
|
+
| `get_test_screenshots` | Get screenshots from a test run |
|
|
45
|
+
| `list_templates` | List available test templates |
|
|
46
|
+
| `screenshot_url` | Screenshot a URL and extract page structure |
|
|
47
|
+
| `validate_test` | Dry-run custom test code before saving |
|
|
48
|
+
| `schedule_test` | Create a recurring schedule for a test |
|
|
49
|
+
| `list_schedules` | List all test schedules |
|
|
50
|
+
| `update_schedule` | Pause or resume a schedule |
|
|
51
|
+
| `delete_schedule` | Delete a schedule |
|
|
52
|
+
| `add_notification_channel` | Add a Telegram notification channel |
|
|
53
|
+
| `list_notification_channels` | List notification channels |
|
|
54
|
+
| `remove_notification_channel` | Remove a notification channel |
|
|
55
|
+
| `test_notification_channel` | Send a test notification |
|
|
56
|
+
|
|
57
|
+
## Example Conversations
|
|
58
|
+
|
|
59
|
+
**Check if something is working:**
|
|
60
|
+
|
|
61
|
+
> "Is checkout working on my site?"
|
|
62
|
+
|
|
63
|
+
The AI will call `list_tests` to find a matching test, then `get_test_results` to check the latest run.
|
|
64
|
+
|
|
65
|
+
**Create a new monitor:**
|
|
66
|
+
|
|
67
|
+
> "Monitor https://example.com — check that the homepage loads and has a sign-in button"
|
|
68
|
+
|
|
69
|
+
The AI will use `screenshot_url` to inspect the page, write custom Playwright code, `validate_test` to verify it works, then `create_test` and `schedule_test`.
|
|
70
|
+
|
|
71
|
+
**Debug a failing test:**
|
|
72
|
+
|
|
73
|
+
> "Why is my checkout test failing?"
|
|
74
|
+
|
|
75
|
+
The AI will call `get_test_results` and `get_test_screenshots` to analyze the failure.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@askqa/mcp",
|
|
3
|
-
"version": "1.0.
|
|
4
|
-
"description": "MCP server for AskQA — monitor websites with automated tests
|
|
3
|
+
"version": "1.0.3",
|
|
4
|
+
"description": "MCP server for AskQA — monitor websites with automated tests by chatting with AI",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
7
7
|
"keywords": [
|
|
@@ -20,7 +20,8 @@
|
|
|
20
20
|
"askqa-mcp": "./server.js"
|
|
21
21
|
},
|
|
22
22
|
"files": [
|
|
23
|
-
"server.js"
|
|
23
|
+
"server.js",
|
|
24
|
+
"README.md"
|
|
24
25
|
],
|
|
25
26
|
"dependencies": {
|
|
26
27
|
"@modelcontextprotocol/sdk": "^1.0.0",
|