List rules
list_rulesRead-only
Lists a ruleset's rules sorted by name and filters them by format, filename overrides, or enabled status so you can see which checks apply before linting.
Instructions
Lists a ruleset's rules, sorted by name. format keeps the rules that apply to documents of that format: oas3.1 includes rules for OpenAPI 3.1 and 3.x; oas3 includes rules for every OpenAPI 3 version. Rules that overrides in the ruleset add or turn off for a document are included when filename matches them. Use explain_rule for one rule in detail.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "list_rules"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| format | No | A format such as oas2 (or swagger), oas3, oas3.1, asyncapi2, asyncapi3 or arazzo1.0 | |
| ruleset | No | A ruleset name from list_rulesets (or oas, asyncapi, arazzo), or an inline YAML/JSON ruleset. Default: the default ruleset. | |
| filename | No | A document name, such as "openapi.json", to include the rules the ruleset's overrides apply to it, as lint_document would. Never read. Default: document.yaml. | |
| enabledOnly | No | Only rules that lint_document runs |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rules | Yes |