squally-mcp 0.2.1 → 0.2.2

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/dist/openapi/v1.json +241 -13
  2. package/package.json +1 -1
@@ -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.3",
6
+ "version": "1.0.0-beta.4",
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": [
@@ -382,7 +382,7 @@
382
382
  "name": "sha",
383
383
  "in": "query",
384
384
  "required": false,
385
- "description": "A commit SHA or a prefix of one (4-40 hex characters). Matches the run's commit or its tested revision (a pull request's head behind a merge commit).",
385
+ "description": "A commit SHA or a prefix of one (4-40 hex characters). Matches the run's commitSha - the commit the run is reported under: the pushed commit, or for a pull request its head - or its testedRevision, the application revision the run was told it tested (opt-in, usually null).",
386
386
  "schema": {
387
387
  "type": "string",
388
388
  "pattern": "^[0-9a-fA-F]{4,40}$"
@@ -392,7 +392,7 @@
392
392
  "name": "status",
393
393
  "in": "query",
394
394
  "required": false,
395
- "description": "Only runs with this outcome.",
395
+ "description": "Only runs with this outcome. A cancelled run matches neither value - only the unfiltered list has it.",
396
396
  "schema": {
397
397
  "type": "string",
398
398
  "enum": [
@@ -474,6 +474,8 @@
474
474
  "testedRevision": null,
475
475
  "pullRequestNumber": null,
476
476
  "status": "passed",
477
+ "cancelled": false,
478
+ "cancellation": null,
477
479
  "startedAt": "2026-09-24T07:31:12.000Z",
478
480
  "finishedAt": "2026-09-24T07:39:47.000Z",
479
481
  "durationMs": 515000,
@@ -497,6 +499,8 @@
497
499
  "testedRevision": "c4f7a1e9b3d5c8e2f0a6b4d9e1c7f3a5b8d2e0f6",
498
500
  "pullRequestNumber": 318,
499
501
  "status": "failed",
502
+ "cancelled": false,
503
+ "cancellation": null,
500
504
  "startedAt": "2026-09-23T16:05:40.000Z",
501
505
  "finishedAt": "2026-09-23T16:12:02.000Z",
502
506
  "durationMs": 382000,
@@ -508,6 +512,32 @@
508
512
  "flaky": 0
509
513
  },
510
514
  "shards": null
515
+ },
516
+ {
517
+ "id": "e4a9c2f7-1b6d-4e83-9f05-7c3b8d1a2e69",
518
+ "runNumber": 1282,
519
+ "branch": "feature/saved-carts",
520
+ "commitSha": "5f1d9b3e7a2c6e0f8b4d2a9c7e1f5b3d8a6c0e4f",
521
+ "testedRevision": null,
522
+ "pullRequestNumber": 318,
523
+ "status": "failed",
524
+ "cancelled": true,
525
+ "cancellation": {
526
+ "source": "reporter",
527
+ "at": "2026-09-23T15:58:31.000Z",
528
+ "byUserId": null
529
+ },
530
+ "startedAt": "2026-09-23T15:55:02.000Z",
531
+ "finishedAt": "2026-09-23T15:58:31.000Z",
532
+ "durationMs": 209000,
533
+ "counts": {
534
+ "total": 164,
535
+ "passed": 157,
536
+ "failed": 1,
537
+ "skipped": 6,
538
+ "flaky": 0
539
+ },
540
+ "shards": null
511
541
  }
512
542
  ],
513
543
  "total": 57,
@@ -801,6 +831,8 @@
801
831
  "pullRequestTitle": null,
802
832
  "ciProvider": "github-actions",
803
833
  "status": "passed",
834
+ "cancelled": false,
835
+ "cancellation": null,
804
836
  "startedAt": "2026-09-24T07:31:12.000Z",
805
837
  "finishedAt": "2026-09-24T07:39:47.000Z",
806
838
  "durationMs": 515000,
@@ -839,6 +871,8 @@
839
871
  "errorMessage": null,
840
872
  "fingerprint": null,
841
873
  "browserName": "chromium",
874
+ "timedOut": false,
875
+ "timeoutMs": 30000,
842
876
  "shard": {
843
877
  "index": 1,
844
878
  "runId": "b1e0c6d2-7a43-4f19-8d5e-0c3a9e6f2b71"
@@ -853,6 +887,8 @@
853
887
  "errorMessage": null,
854
888
  "fingerprint": null,
855
889
  "browserName": "chromium",
890
+ "timedOut": false,
891
+ "timeoutMs": 30000,
856
892
  "shard": {
857
893
  "index": 2,
858
894
  "runId": "e4a9d3f0-2b6c-4178-a5d1-9f0e3c7b8a26"
@@ -1132,6 +1168,8 @@
1132
1168
  "label": "first try",
1133
1169
  "status": "failed",
1134
1170
  "durationMs": 6210,
1171
+ "timedOut": false,
1172
+ "timeoutMs": 30000,
1135
1173
  "browserName": "chromium",
1136
1174
  "errors": [
1137
1175
  {
@@ -1156,6 +1194,8 @@
1156
1194
  "label": "retry #1",
1157
1195
  "status": "passed",
1158
1196
  "durationMs": 1840,
1197
+ "timedOut": false,
1198
+ "timeoutMs": 30000,
1159
1199
  "browserName": "chromium",
1160
1200
  "errors": [],
1161
1201
  "copyPrompt": null,
@@ -2740,6 +2780,8 @@
2740
2780
  "startedAt": "2026-09-24T07:31:12.000Z",
2741
2781
  "status": "passed",
2742
2782
  "durationMs": 1840,
2783
+ "timedOut": false,
2784
+ "timeoutMs": 30000,
2743
2785
  "attempts": 2,
2744
2786
  "wastedMs": 6210
2745
2787
  },
@@ -2751,6 +2793,8 @@
2751
2793
  "startedAt": "2026-09-23T16:05:40.000Z",
2752
2794
  "status": "passed",
2753
2795
  "durationMs": 1795,
2796
+ "timedOut": null,
2797
+ "timeoutMs": null,
2754
2798
  "attempts": 1,
2755
2799
  "wastedMs": 0
2756
2800
  }
@@ -4396,7 +4440,8 @@
4396
4440
  {
4397
4441
  "type": "null"
4398
4442
  }
4399
- ]
4443
+ ],
4444
+ "description": "The commit the run is reported under: the pushed commit, or for a pull request its head commit. The commit the GitHub check and the commit links use."
4400
4445
  },
4401
4446
  "testedRevision": {
4402
4447
  "anyOf": [
@@ -4406,7 +4451,8 @@
4406
4451
  {
4407
4452
  "type": "null"
4408
4453
  }
4409
- ]
4454
+ ],
4455
+ "description": "The application revision the run was told it tested - opt-in, null unless the CI job sets it: TESTED_REVISION=<revision>, or SAME_REPO_AS_APP=true for the commit CI built (on a pull request, the merge commit). Never the pull request's head - that is commitSha."
4410
4456
  },
4411
4457
  "pullRequestNumber": {
4412
4458
  "anyOf": [
@@ -4426,7 +4472,57 @@
4426
4472
  {
4427
4473
  "type": "null"
4428
4474
  }
4429
- ]
4475
+ ],
4476
+ "description": "passed | failed | running | incomplete - for a sharded run, the whole group's. Never \"cancelled\": a cancelled run keeps the outcome of what it reported, and says so in cancelled."
4477
+ },
4478
+ "cancelled": {
4479
+ "type": "boolean",
4480
+ "description": "True when the run was cancelled - for a sharded run, when any shard recorded a cancel. A cancelled run keeps its status (the outcome of what it reported before the stop) and never matches ?status=passed or ?status=failed."
4481
+ },
4482
+ "cancellation": {
4483
+ "anyOf": [
4484
+ {
4485
+ "type": "object",
4486
+ "properties": {
4487
+ "source": {
4488
+ "anyOf": [
4489
+ {
4490
+ "type": "string"
4491
+ },
4492
+ {
4493
+ "type": "null"
4494
+ }
4495
+ ],
4496
+ "description": "Where the cancel came from: \"reporter\" (Playwright was interrupted - a cancelled CI job, a Ctrl-C - and the reporter said so), \"cli\" or \"user\" (the dashboard). A plain string, not a closed set: new sources may be added. null only for a cancel recorded without a source, which Squally never writes."
4497
+ },
4498
+ "at": {
4499
+ "type": "string",
4500
+ "format": "date-time",
4501
+ "description": "When the run was cancelled. For a sharded run, the first shard to record it."
4502
+ },
4503
+ "byUserId": {
4504
+ "anyOf": [
4505
+ {
4506
+ "type": "string"
4507
+ },
4508
+ {
4509
+ "type": "null"
4510
+ }
4511
+ ],
4512
+ "description": "The user who cancelled the run, when source is \"user\"; null otherwise."
4513
+ }
4514
+ },
4515
+ "required": [
4516
+ "source",
4517
+ "at",
4518
+ "byUserId"
4519
+ ]
4520
+ },
4521
+ {
4522
+ "type": "null"
4523
+ }
4524
+ ],
4525
+ "description": "How and when the run was cancelled; null when it was not."
4430
4526
  },
4431
4527
  "startedAt": {
4432
4528
  "type": "string",
@@ -4441,7 +4537,8 @@
4441
4537
  {
4442
4538
  "type": "null"
4443
4539
  }
4444
- ]
4540
+ ],
4541
+ "description": "When the run finished - for a sharded run, its latest shard. null while it is still running. A cancelled run has finished: it ends at the latest shard that reported, even when a shard stopped by the same cancel never did."
4445
4542
  },
4446
4543
  "durationMs": {
4447
4544
  "anyOf": [
@@ -4519,6 +4616,8 @@
4519
4616
  "testedRevision",
4520
4617
  "pullRequestNumber",
4521
4618
  "status",
4619
+ "cancelled",
4620
+ "cancellation",
4522
4621
  "startedAt",
4523
4622
  "finishedAt",
4524
4623
  "durationMs",
@@ -4608,7 +4707,8 @@
4608
4707
  {
4609
4708
  "type": "null"
4610
4709
  }
4611
- ]
4710
+ ],
4711
+ "description": "The commit the run is reported under: the pushed commit, or for a pull request its head commit. The commit the GitHub check and the commit links use."
4612
4712
  },
4613
4713
  "commitMessage": {
4614
4714
  "anyOf": [
@@ -4638,7 +4738,8 @@
4638
4738
  {
4639
4739
  "type": "null"
4640
4740
  }
4641
- ]
4741
+ ],
4742
+ "description": "The application revision the run was told it tested - opt-in, null unless the CI job sets it: TESTED_REVISION=<revision>, or SAME_REPO_AS_APP=true for the commit CI built (on a pull request, the merge commit). Never the pull request's head - that is commitSha."
4642
4743
  },
4643
4744
  "pullRequestNumber": {
4644
4745
  "anyOf": [
@@ -4671,7 +4772,57 @@
4671
4772
  ]
4672
4773
  },
4673
4774
  "status": {
4674
- "type": "string"
4775
+ "type": "string",
4776
+ "description": "passed | failed | running | incomplete - the whole group's. Never \"cancelled\": a cancelled run keeps the outcome of what it reported, and says so in cancelled."
4777
+ },
4778
+ "cancelled": {
4779
+ "type": "boolean",
4780
+ "description": "True when the run was cancelled - for a sharded run, when any shard recorded a cancel. A cancelled run keeps its status (the outcome of what it reported before the stop) and never matches ?status=passed or ?status=failed."
4781
+ },
4782
+ "cancellation": {
4783
+ "anyOf": [
4784
+ {
4785
+ "type": "object",
4786
+ "properties": {
4787
+ "source": {
4788
+ "anyOf": [
4789
+ {
4790
+ "type": "string"
4791
+ },
4792
+ {
4793
+ "type": "null"
4794
+ }
4795
+ ],
4796
+ "description": "Where the cancel came from: \"reporter\" (Playwright was interrupted - a cancelled CI job, a Ctrl-C - and the reporter said so), \"cli\" or \"user\" (the dashboard). A plain string, not a closed set: new sources may be added. null only for a cancel recorded without a source, which Squally never writes."
4797
+ },
4798
+ "at": {
4799
+ "type": "string",
4800
+ "format": "date-time",
4801
+ "description": "When the run was cancelled. For a sharded run, the first shard to record it."
4802
+ },
4803
+ "byUserId": {
4804
+ "anyOf": [
4805
+ {
4806
+ "type": "string"
4807
+ },
4808
+ {
4809
+ "type": "null"
4810
+ }
4811
+ ],
4812
+ "description": "The user who cancelled the run, when source is \"user\"; null otherwise."
4813
+ }
4814
+ },
4815
+ "required": [
4816
+ "source",
4817
+ "at",
4818
+ "byUserId"
4819
+ ]
4820
+ },
4821
+ {
4822
+ "type": "null"
4823
+ }
4824
+ ],
4825
+ "description": "How and when the run was cancelled; null when it was not."
4675
4826
  },
4676
4827
  "startedAt": {
4677
4828
  "type": "string",
@@ -4686,7 +4837,8 @@
4686
4837
  {
4687
4838
  "type": "null"
4688
4839
  }
4689
- ]
4840
+ ],
4841
+ "description": "When the run finished - for a sharded run, its latest shard. null while it is still running. A cancelled run has finished: it ends at the latest shard that reported, even when a shard stopped by the same cancel never did."
4690
4842
  },
4691
4843
  "durationMs": {
4692
4844
  "anyOf": [
@@ -4777,6 +4929,8 @@
4777
4929
  "pullRequestTitle",
4778
4930
  "ciProvider",
4779
4931
  "status",
4932
+ "cancelled",
4933
+ "cancellation",
4780
4934
  "startedAt",
4781
4935
  "finishedAt",
4782
4936
  "durationMs",
@@ -4875,6 +5029,28 @@
4875
5029
  }
4876
5030
  ]
4877
5031
  },
5032
+ "timedOut": {
5033
+ "anyOf": [
5034
+ {
5035
+ "type": "boolean"
5036
+ },
5037
+ {
5038
+ "type": "null"
5039
+ }
5040
+ ],
5041
+ "description": "The final attempt's. Whether the attempt ended by running into its time limit (Playwright's timedOut). null when the reporter did not say - every result from a reporter before 0.10.0."
5042
+ },
5043
+ "timeoutMs": {
5044
+ "anyOf": [
5045
+ {
5046
+ "type": "integer"
5047
+ },
5048
+ {
5049
+ "type": "null"
5050
+ }
5051
+ ],
5052
+ "description": "The final attempt's. The time limit Playwright applied to the attempt, in milliseconds; 0 means no limit. null when the reporter did not say."
5053
+ },
4878
5054
  "shard": {
4879
5055
  "anyOf": [
4880
5056
  {
@@ -4914,6 +5090,8 @@
4914
5090
  "errorMessage",
4915
5091
  "fingerprint",
4916
5092
  "browserName",
5093
+ "timedOut",
5094
+ "timeoutMs",
4917
5095
  "shard"
4918
5096
  ]
4919
5097
  }
@@ -5016,6 +5194,28 @@
5016
5194
  }
5017
5195
  ]
5018
5196
  },
5197
+ "timedOut": {
5198
+ "anyOf": [
5199
+ {
5200
+ "type": "boolean"
5201
+ },
5202
+ {
5203
+ "type": "null"
5204
+ }
5205
+ ],
5206
+ "description": "Whether the attempt ended by running into its time limit (Playwright's timedOut). null when the reporter did not say - every result from a reporter before 0.10.0."
5207
+ },
5208
+ "timeoutMs": {
5209
+ "anyOf": [
5210
+ {
5211
+ "type": "integer"
5212
+ },
5213
+ {
5214
+ "type": "null"
5215
+ }
5216
+ ],
5217
+ "description": "The time limit Playwright applied to the attempt, in milliseconds; 0 means no limit. null when the reporter did not say."
5218
+ },
5019
5219
  "browserName": {
5020
5220
  "anyOf": [
5021
5221
  {
@@ -5156,6 +5356,8 @@
5156
5356
  "label",
5157
5357
  "status",
5158
5358
  "durationMs",
5359
+ "timedOut",
5360
+ "timeoutMs",
5159
5361
  "browserName",
5160
5362
  "errors",
5161
5363
  "copyPrompt",
@@ -5840,7 +6042,8 @@
5840
6042
  {
5841
6043
  "type": "null"
5842
6044
  }
5843
- ]
6045
+ ],
6046
+ "description": "The application revision the run was told it tested - opt-in, null unless the CI job sets it: TESTED_REVISION=<revision>, or SAME_REPO_AS_APP=true for the commit CI built (on a pull request, the merge commit). Never the pull request's head - that is commitSha."
5844
6047
  },
5845
6048
  "startedAt": {
5846
6049
  "type": "string",
@@ -5859,6 +6062,28 @@
5859
6062
  }
5860
6063
  ]
5861
6064
  },
6065
+ "timedOut": {
6066
+ "anyOf": [
6067
+ {
6068
+ "type": "boolean"
6069
+ },
6070
+ {
6071
+ "type": "null"
6072
+ }
6073
+ ],
6074
+ "description": "The final attempt's. Whether the attempt ended by running into its time limit (Playwright's timedOut). null when the reporter did not say - every result from a reporter before 0.10.0."
6075
+ },
6076
+ "timeoutMs": {
6077
+ "anyOf": [
6078
+ {
6079
+ "type": "integer"
6080
+ },
6081
+ {
6082
+ "type": "null"
6083
+ }
6084
+ ],
6085
+ "description": "The final attempt's. The time limit Playwright applied to the attempt, in milliseconds; 0 means no limit. null when the reporter did not say."
6086
+ },
5862
6087
  "attempts": {
5863
6088
  "type": "integer"
5864
6089
  },
@@ -5874,6 +6099,8 @@
5874
6099
  "startedAt",
5875
6100
  "status",
5876
6101
  "durationMs",
6102
+ "timedOut",
6103
+ "timeoutMs",
5877
6104
  "attempts",
5878
6105
  "wastedMs"
5879
6106
  ]
@@ -6568,7 +6795,8 @@
6568
6795
  "failed",
6569
6796
  "durationMs"
6570
6797
  ]
6571
- }
6798
+ },
6799
+ "description": "The last 20 runs on branchScope, oldest first - the dashboard's Runs and Run duration charts. Cancelled runs are left out, every shard of a cancelled CI run included."
6572
6800
  }
6573
6801
  },
6574
6802
  "required": [
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squally-mcp",
3
- "version": "0.2.1",
3
+ "version": "0.2.2",
4
4
  "description": "Local MCP server for Squally — read-only access to your Playwright test runs, flaky tests and failures.",
5
5
  "license": "MIT",
6
6
  "author": "Squally",