Explain a test-quality-linter rule
tql.explainLook up a test quality lint rule by its ID to see what it catches, a bad example, a fixed example, and configuration options.
Instructions
Returns the documentation of one rule: what it catches, a bad example, a fixed example and its options. Rule ids look like TQL003.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"ruleId": "<ruleId>"
},
"name": "tql.explain"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ruleId | Yes | Rule id, for example TQL003 |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| doc | Yes | ||
| name | Yes | ||
| severity | Yes | ||
| description | Yes |