|
8 | 8 | import { Aside, Tabs, TabItem } from "@astrojs/starlight/components"; |
9 | 9 | import ParameterTable from "../../../components/ParameterTable.astro"; |
10 | 10 |
|
11 | | -The Endform CLI includes a local [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server. It gives AI coding agents tools for analyzing historical test data and debugging a Playwright test on Endform's remote infrastructure. |
| 11 | +The Endform CLI includes a local [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) server. It gives AI coding agents tools for analyzing historical test data, managing quarantine rules, and debugging a Playwright test on Endform's remote infrastructure. |
12 | 12 |
|
13 | 13 | ## Set up the MCP server |
14 | 14 |
|
@@ -154,6 +154,56 @@ Returns raw OpenTelemetry trace data for a test attempt. The trace can show Play |
154 | 154 |
|
155 | 155 | </ParameterTable> |
156 | 156 |
|
| 157 | +## Manage quarantine rules |
| 158 | + |
| 159 | +These tools let an AI agent list, create, and deactivate quarantine rules. See [Modify quarantine rules with AI](/docs/guides/modify-quarantine-rules-with-ai) for example conversations. |
| 160 | + |
| 161 | +### `list_quarantine_rules` |
| 162 | + |
| 163 | +Lists active quarantine rules and their exact rule IDs, scope, reason, and expiry. |
| 164 | + |
| 165 | +<ParameterTable> |
| 166 | + |
| 167 | + | Parameter | Type | Description | |
| 168 | + | --- | --- | --- | |
| 169 | + | `organizationId` | string | Optional organization. Omit it to use the organization from the active login. | |
| 170 | + | `includeInactive` | boolean | Include expired and deactivated rules. Defaults to `false`. | |
| 171 | + |
| 172 | +</ParameterTable> |
| 173 | + |
| 174 | +### `create_quarantine_rule` |
| 175 | + |
| 176 | +Creates a quarantine rule for an exact suite and scope. Use `query_samples` to retrieve the persisted `suite.id` and, when selecting a test, `test.id`. Test names, file paths, and Playwright worker IDs are not test IDs. |
| 177 | + |
| 178 | +<ParameterTable> |
| 179 | + |
| 180 | + | Parameter | Type | Description | |
| 181 | + | --- | --- | --- | |
| 182 | + | `suiteId` | string | Exact persisted `suite.id` returned by `query_samples`. | |
| 183 | + | `testId` | string | Optional exact persisted `test.id`. Omit it to match all tests in the suite. | |
| 184 | + | `projectName` | string | Optional exact Playwright project name. | |
| 185 | + | `branch` | string | Optional exact branch name. | |
| 186 | + | `reason` | string | Optional reason for quarantining the matching tests. | |
| 187 | + | `endsAt` | RFC 3339 string | Optional future expiry timestamp. Omit it for no expiry. | |
| 188 | + | `organizationId` | string | Optional organization. Omit it to use the organization from the active login. | |
| 189 | + |
| 190 | +</ParameterTable> |
| 191 | + |
| 192 | +In addition to `suiteId`, provide at least one of `testId`, `projectName`, or `branch`. Omitted scope fields match any value within the suite. |
| 193 | + |
| 194 | +### `deactivate_quarantine_rule` |
| 195 | + |
| 196 | +Deactivates one quarantine rule by its exact ID. Use `list_quarantine_rules` to retrieve the ID. |
| 197 | + |
| 198 | +<ParameterTable> |
| 199 | + |
| 200 | + | Parameter | Type | Description | |
| 201 | + | --- | --- | --- | |
| 202 | + | `ruleId` | string | Exact quarantine rule ID returned by `list_quarantine_rules`. | |
| 203 | + | `organizationId` | string | Optional organization. Omit it to use the organization from the active login. | |
| 204 | + |
| 205 | +</ParameterTable> |
| 206 | + |
157 | 207 | ## Debug tests |
158 | 208 |
|
159 | 209 | These tools let an AI agent pause inside one Playwright test and inspect or interact with its live browser state. See [Debug tests with AI](/docs/guides/debug-tests-with-ai) for example conversations. |
|
0 commit comments