squally-mcp 0.2.0 → 0.2.1
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/dist/openapi/v1.json +15 -64
- package/dist/tools.js +7 -5
- package/package.json +1 -1
package/dist/openapi/v1.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"jsonSchemaDialect": "https://json-schema.org/draft/2020-12/schema",
|
|
4
4
|
"info": {
|
|
5
5
|
"title": "Squally Read API",
|
|
6
|
-
"version": "1.0.0-beta.
|
|
6
|
+
"version": "1.0.0-beta.3",
|
|
7
7
|
"description": "Read access to a Squally organization's test results, for scripts, CI jobs and AI agents.\n\n**Authentication.** Every request carries an organization read key as `Authorization: Bearer sqly_ro_…`. A read key is organization-wide (every project), created by an organization admin in Settings → API keys, and expires after 30, 60, 90, 180 days as chosen at creation. There is no renewal: create a new key and revoke the old one. Project ingest keys (`sqly_…`) are refused with `wrong_key_type`.\n\n**Expiry warning.** From 7 days before a key expires, every authenticated response carries `Squally-Key-Expires-At` with the expiry instant (ISO-8601).\n\n**Rate limit.** Currently 60 requests per 60 seconds per key, counted per `Authorization` header - a read key has its own budget, shared with nothing else. Over the limit the edge answers 429 without a JSON body.\n\n**Retries.** 429: wait 60 seconds, then retry. The edge counts requests per key in 60-second windows and sends no Retry-After header. 5xx: retry with exponential backoff, starting at 1 second and capped at 30 seconds. 400, 401, 403, 404: never retry - the same request gets the same answer.\n\n**Plans.** The read API is part of the Standard and Pro plans. A key of an organization on Free is answered 403 `tier_too_low`; keys are not revoked on a downgrade and work again after an upgrade.\n\n**Errors.** Every error is `{\"error\": \"<sentence>\", \"code\": \"<slug>\"}`. The sentence may be reworded; the slug may not. An id that does not exist and an id that belongs to another organization get the same 404, byte for byte.\n\n**Test names in paths.** Test names are Playwright title paths and often contain `/`: URL-encode them, including `/` as `%2F`.\n\n**Sharded runs** are returned as one logical run: /runs lists one row per logical run, and the run routes answer for all shards whichever shard's id you pass.\n\n**Stability.** v1, beta. The API may change until the beta ends; every change is listed in the changelog (docs/openapi/CHANGELOG.md)."
|
|
8
8
|
},
|
|
9
9
|
"servers": [
|
|
@@ -1145,7 +1145,7 @@
|
|
|
1145
1145
|
}
|
|
1146
1146
|
}
|
|
1147
1147
|
],
|
|
1148
|
-
"copyPrompt": "You have the repository open. Find the test below, explain the failure and propose a fix.\n\nFailing test: chromium > checkout.spec.ts > Checkout > applies a coupon code\nFile: tests/checkout.spec.ts\nBrowser: chromium\nRun branch: main\nAttempt: first try\nOutcome: a later retry of this test passed
|
|
1148
|
+
"copyPrompt": "You have the repository open. Find the test below, explain the failure and propose a fix.\n\nFailing test: chromium > checkout.spec.ts > Checkout > applies a coupon code\nFile: tests/checkout.spec.ts\nBrowser: chromium\nRun branch: main\nAttempt: first try\nOutcome: a later retry of this test passed - a flaky run.\n\nError message:\nError: expect(locator).toHaveText(expected) failed\n\nLocator: getByTestId('order-total')\nExpected: \"€ 45.00\"\nReceived: \"€ 50.00\"\nTimeout: 5000ms\nStack (top frames):\nat /home/runner/work/storefront-web/tests/checkout.spec.ts:48:52\nAttempt duration: 6210 ms\nFailure category: Assertion\nLast 14 days on CI: flaky rate 50% (4/8), failure rate 0% (0/8)",
|
|
1149
1149
|
"shard": {
|
|
1150
1150
|
"index": 1,
|
|
1151
1151
|
"runId": "b1e0c6d2-7a43-4f19-8d5e-0c3a9e6f2b71"
|
|
@@ -1933,12 +1933,12 @@
|
|
|
1933
1933
|
"testName": "chromium > auth.spec.ts > Login > remembers the device",
|
|
1934
1934
|
"filePath": "tests/auth.spec.ts",
|
|
1935
1935
|
"browser": "chromium",
|
|
1936
|
-
"runs":
|
|
1937
|
-
"stableRuns":
|
|
1936
|
+
"runs": 7,
|
|
1937
|
+
"stableRuns": 6,
|
|
1938
1938
|
"flakyRuns": 1,
|
|
1939
1939
|
"failedRuns": 0,
|
|
1940
|
-
"stability": 0.
|
|
1941
|
-
"flakyRate": 0.
|
|
1940
|
+
"stability": 0.8571428571428571,
|
|
1941
|
+
"flakyRate": 0.14285714285714285,
|
|
1942
1942
|
"failureRate": 0,
|
|
1943
1943
|
"timeLostMs": 3071,
|
|
1944
1944
|
"recentResults": [
|
|
@@ -1968,7 +1968,7 @@
|
|
|
1968
1968
|
"runNumber": 1270,
|
|
1969
1969
|
"startedAt": "2026-09-17T07:29:58.000Z",
|
|
1970
1970
|
"branch": "main",
|
|
1971
|
-
"result": "
|
|
1971
|
+
"result": "skipped"
|
|
1972
1972
|
},
|
|
1973
1973
|
{
|
|
1974
1974
|
"runId": "6b1f8d23-9e4a-4c07-b5d2-3a8e0f6c1d74",
|
|
@@ -4269,57 +4269,6 @@
|
|
|
4269
4269
|
}
|
|
4270
4270
|
}
|
|
4271
4271
|
}
|
|
4272
|
-
},
|
|
4273
|
-
"/projects/{projectId}/flaky": {
|
|
4274
|
-
"get": {
|
|
4275
|
-
"operationId": "listFlakyTests",
|
|
4276
|
-
"summary": "List flaky tests (deprecated)",
|
|
4277
|
-
"description": "Deprecated in 1.0.0-beta.2 and removed in the next release: call GET /projects/{projectId}/tests. Answers 301 Moved Permanently to it, carrying the query over - sort=rate becomes sort=flakyRate, sort=timeLost stays, sort=impact and status are dropped, everything else passes through unchanged. The redirect checks no key; the list it points to does.",
|
|
4278
|
-
"tags": [
|
|
4279
|
-
"Tests"
|
|
4280
|
-
],
|
|
4281
|
-
"deprecated": true,
|
|
4282
|
-
"parameters": [
|
|
4283
|
-
{
|
|
4284
|
-
"name": "projectId",
|
|
4285
|
-
"in": "path",
|
|
4286
|
-
"required": true,
|
|
4287
|
-
"description": "A project id from GET /projects.",
|
|
4288
|
-
"schema": {
|
|
4289
|
-
"type": "string"
|
|
4290
|
-
}
|
|
4291
|
-
}
|
|
4292
|
-
],
|
|
4293
|
-
"responses": {
|
|
4294
|
-
"301": {
|
|
4295
|
-
"description": "Moved permanently to /projects/{projectId}/tests. No body.",
|
|
4296
|
-
"headers": {
|
|
4297
|
-
"Location": {
|
|
4298
|
-
"description": "The absolute URL of /projects/{projectId}/tests, with the query carried over.",
|
|
4299
|
-
"schema": {
|
|
4300
|
-
"type": "string",
|
|
4301
|
-
"format": "uri"
|
|
4302
|
-
}
|
|
4303
|
-
},
|
|
4304
|
-
"Deprecation": {
|
|
4305
|
-
"description": "When the deprecation took effect, as @ and a Unix time (RFC 9745).",
|
|
4306
|
-
"schema": {
|
|
4307
|
-
"type": "string"
|
|
4308
|
-
}
|
|
4309
|
-
},
|
|
4310
|
-
"Link": {
|
|
4311
|
-
"description": "/projects/{projectId}/tests as rel=\"successor-version\".",
|
|
4312
|
-
"schema": {
|
|
4313
|
-
"type": "string"
|
|
4314
|
-
}
|
|
4315
|
-
}
|
|
4316
|
-
}
|
|
4317
|
-
},
|
|
4318
|
-
"429": {
|
|
4319
|
-
"description": "Rate limited by the edge firewall, no JSON body. 429: wait 60 seconds, then retry. The edge counts requests per key in 60-second windows and sends no Retry-After header."
|
|
4320
|
-
}
|
|
4321
|
-
}
|
|
4322
|
-
}
|
|
4323
4272
|
}
|
|
4324
4273
|
},
|
|
4325
4274
|
"components": {
|
|
@@ -5448,9 +5397,10 @@
|
|
|
5448
5397
|
"enum": [
|
|
5449
5398
|
"stable",
|
|
5450
5399
|
"flaky",
|
|
5451
|
-
"failed"
|
|
5400
|
+
"failed",
|
|
5401
|
+
"skipped"
|
|
5452
5402
|
],
|
|
5453
|
-
"description": "The run's final attempt: stable (passed on the first try), flaky (passed after at least one retry) or
|
|
5403
|
+
"description": "The run's final attempt: stable (passed on the first try), flaky (passed after at least one retry), failed, or skipped. A skipped run appears only here: it is not a run of the test, so it counts in neither runs nor any rate."
|
|
5454
5404
|
}
|
|
5455
5405
|
},
|
|
5456
5406
|
"required": [
|
|
@@ -5461,7 +5411,7 @@
|
|
|
5461
5411
|
"result"
|
|
5462
5412
|
]
|
|
5463
5413
|
},
|
|
5464
|
-
"description": "The test's last 20 runs in the period, oldest first. Empty when it has none."
|
|
5414
|
+
"description": "The test's last 20 runs in the period, oldest first, including runs whose final attempt skipped (result skipped). Empty when it has none."
|
|
5465
5415
|
},
|
|
5466
5416
|
"branches": {
|
|
5467
5417
|
"type": "array",
|
|
@@ -5708,9 +5658,10 @@
|
|
|
5708
5658
|
"enum": [
|
|
5709
5659
|
"stable",
|
|
5710
5660
|
"flaky",
|
|
5711
|
-
"failed"
|
|
5661
|
+
"failed",
|
|
5662
|
+
"skipped"
|
|
5712
5663
|
],
|
|
5713
|
-
"description": "The run's final attempt: stable (passed on the first try), flaky (passed after at least one retry) or
|
|
5664
|
+
"description": "The run's final attempt: stable (passed on the first try), flaky (passed after at least one retry), failed, or skipped. A skipped run appears only here: it is not a run of the test, so it counts in neither runs nor any rate."
|
|
5714
5665
|
}
|
|
5715
5666
|
},
|
|
5716
5667
|
"required": [
|
|
@@ -5721,7 +5672,7 @@
|
|
|
5721
5672
|
"result"
|
|
5722
5673
|
]
|
|
5723
5674
|
},
|
|
5724
|
-
"description": "The test's last 20 runs in the period, oldest first. Empty when it has none."
|
|
5675
|
+
"description": "The test's last 20 runs in the period, oldest first, including runs whose final attempt skipped (result skipped). Empty when it has none."
|
|
5725
5676
|
},
|
|
5726
5677
|
"branches": {
|
|
5727
5678
|
"type": "array",
|
package/dist/tools.js
CHANGED
|
@@ -54,11 +54,13 @@ export const TOOLS = [
|
|
|
54
54
|
operationId: "getTestMetrics",
|
|
55
55
|
description: "One test's numbers over a period: runs, stability (runs that passed on the first try " +
|
|
56
56
|
"/ runs), flakyRate (runs that passed only after a retry / runs), failureRate (failed " +
|
|
57
|
-
"runs / runs), time lost to retries and failures, its last 20 runs
|
|
58
|
-
"
|
|
59
|
-
"
|
|
60
|
-
"
|
|
61
|
-
"
|
|
57
|
+
"runs / runs), time lost to retries and failures, its last 20 runs (runs it skipped " +
|
|
58
|
+
"included, as result \"skipped\" - shown, never counted in runs or any rate) and the " +
|
|
59
|
+
"branches it ran on. Counts completed CI runs of the period, without runs where most " +
|
|
60
|
+
"of the suite failed at once; local runs never count. There is no verdict - the tool " +
|
|
61
|
+
"returns the numbers and you judge them. runs = 0 with null rates is a valid answer: " +
|
|
62
|
+
"no completed CI run of this test in the period. Cheap; for one test use this, not " +
|
|
63
|
+
"squally-list-tests.",
|
|
62
64
|
answers: "One test's stability, flaky rate and failure rate over a period.",
|
|
63
65
|
cost: "cheap",
|
|
64
66
|
},
|