rules_search
Find ASD-STE100 rules by regular expression across all rule text, including notes, examples, and technical lists, to locate governing rules without needing section or category IDs.
Instructions
Full-text search for rules using a regular expression.
Unlike rules_match, which only looks at name and summary,
this searches every text a rule carries: section, category,
name, summary, and the data of every content item --
i.e. explanatory text, notes, STE/non-STE examples, technical
noun/verb lists, and so on. Useful for finding "what rule governs
passive voice" or "where does STE100 mention abbreviations", without
knowing the section/category/id upfront.
Parameters
pattern:
The regular expression pattern to search for (case-insensitive).
content_types:
When given, only the data of content items whose type is in
this list is searched (section, category, name, and
summary are always searched regardless). Use this to narrow
the search to, e.g., only note or ste_example content.
max_results:
The maximum number of matching rules to return (default 25).
offset:
The number of matching rules to skip before returning results,
for pagination (default 0).
Returns
SearchResult
results holds the (possibly empty) page of matching rules,
in document order, after applying offset and max_results.
total is the full match count before pagination, and
truncated tells the caller whether more matches exist beyond
this page -- i.e. whether a reached max_results means "that's
all of them" or "call again with a higher offset".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| offset | No | The number of matching entries to skip before returning results, for pagination. | |
| pattern | Yes | A regular-expression pattern (case-insensitive) matched against the rule section, category, name, summary, and every content block (text, notes, examples, technical noun/verb lists, ...). | |
| max_results | No | The maximum number of matching entries to return. | |
| content_types | No | Only search the content of these types, e.g. ['note', 'ste_example']. The rule section/category/name/summary are always searched regardless of this option. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| total | Yes | ||
| offset | Yes | ||
| results | No | ||
| truncated | Yes | ||
| max_results | Yes |