Search for rules in the ruleset by exact category name (case-insensitive).

Use rules_toc first if you do not know the exact category names.

Parameters

category: The category name to search for, e.g. "Technical nouns".

Returns

list[Rule] A (possibly empty) list of matching rules.

Search for rules in the ruleset by exact section name (case-insensitive).

Use rules_toc first if you do not know the exact section names.

Parameters

section: The section name to search for, e.g. "Words".

Returns

list[Rule] A (possibly empty) list of matching rules.

Return content items across rules, optionally scoped and filtered.

Parameters

id_: When given, only consider the rule with this exact id (case-insensitive). section: When given, only consider rules in this exact section (case-insensitive). category: When given, only consider rules in this exact category (case-insensitive). kind: When given, only return content items of this type (e.g. "ste_example"). max_results: The maximum number of matching content items to return (default 25). offset: The number of matching content items to skip before returning results, for pagination (default 0).

Returns

RulesExamplesResult results holds the (possibly empty) page of matching content items, in document order, after applying offset and max_results. total is the full match count before pagination, and truncated tells the caller whether more content items exist beyond this page. Unfiltered, the ruleset can hold well over a thousand content items, so pagination matters here even though the ruleset itself only has a few dozen rules.

Search for rules in the ruleset by exact id.

Use this first when you know the exact rule/recommendation id. Use rules_match or rules_search if this tool returns no items.

Parameters

id_: The rule/recommendation id to search for (e.g. "R1.1" or "GR-8"), matched case-insensitively.

Returns

list[Rule] A (possibly empty) list of matching rules.

Search for rules in the ruleset using a regular expression.

The pattern is matched (case-insensitively) against both the name and the summary of each rule. Use rules_search instead if you need to search the full content of every rule (notes, examples, technical noun/verb lists, ...).

Parameters

pattern: The regular expression pattern to search for.

Returns

list[Rule] A (possibly empty) list of matching rules.

Return a lightweight, per-rule overview of the ruleset.

Use this for a cheap, low-token summary of what rules exist before drilling into rules_find or rules_examples for a specific rule; each result carries only the rule's id, type, section, category, name, and (optionally) summary, plus counts/flags about its content items rather than the content items themselves.

Parameters

section: When given, only consider rules in this exact section (case-insensitive). category: When given, only consider rules in this exact category (case-insensitive). type_: When given, only consider rules of this exact type (e.g. "rule", to exclude recommendations and informational blocks). brief: When True (default), omit the summary to keep the payload small. When False, include the full summary.

Returns

list[RuleOverview] One overview per matching rule, in the ruleset's current order (natural id order by default).

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".

Return the distinct (section, category) pairs, in first-seen order.

Gives a table-of-contents style outline of the ruleset's structure, without any per-rule detail; useful to see which sections and categories exist before drilling into rules_overview, rules_by_section, or rules_by_category for a specific one.

Parameters

section: When given, only consider rules in this exact section (case-insensitive).

Returns

list[TocEntry] One entry per distinct (section, category) pair, in first-seen document order, where ids lists the ids of every rule/recommendation/information item in that (section, category), in document order.

Return the total number of entries in the vocabulary.

Use instead of word_list when you only need the count.

Returns

int The number of entries in the vocabulary.

Search for a term by exact name (case-insensitive) in the ASD-STE100 Issue 9 vocabulary.

Return approved/rejected status, part of speech, STE examples, and approved alternatives. Use this first when you know the exact word. Use word_match with a wildcard if this tool returns no items.

Parameters

term: The word or phrase to look up exactly.

Returns

list[Word] A (possibly empty) list of matching vocabulary entries.

Search for multiple terms by exact name (case-insensitive) in the ASD-STE100 Issue 9 vocabulary in a single call.

Equivalent to calling word_find once per term, but avoids one tool round-trip per term. Each input term gets its own entry in the result, holding 0, 1, or more matching vocabulary entries — an unknown or misspelled term simply yields an empty results list for that entry rather than shrinking the overall result.

Parameters

terms: The words or phrases to look up exactly.

Returns

list[WordFindEntry] One entry per input term, in the same order as terms, each holding the term and its (possibly empty) list of matching vocabulary entries.

Search for a term with sequence-matching (Python difflib.get_close_matches).

Results may not be obvious — use when find returns nothing and you want suggestions.

Parameters

term: The word or phrase to search for approximately.

Returns

list[Word] A (possibly empty) list of similar vocabulary entries.

Return all vocabulary entries.

Only use when you need to process the full vocabulary. Use word_count instead if you only need the total. This operation is expensive and returns a large number of entries -- the vocabulary holds thousands of them.

Parameters

max_results: The maximum number of vocabulary entries to return (default 25). offset: The number of vocabulary entries to skip before returning results, for pagination (default 0).

Returns

WordResult results holds the (possibly empty) page of vocabulary entries after applying offset and max_results. total is the full entry count before pagination, and truncated tells the caller whether more entries exist beyond this page.

Search the vocabulary using a regular expression pattern.

Return all entries whose term matches. Use it to find all words with a common prefix or pattern (e.g. ^de or .*tion$). A broad pattern can match a large part of the vocabulary, so results are paginated.

Parameters

term: A regular-expression pattern (e.g. "util.*"). max_results: The maximum number of matching vocabulary entries to return (default 25). offset: The number of matching vocabulary entries to skip before returning results, for pagination (default 0).

Returns

WordResult results holds the (possibly empty) page of matching vocabulary entries 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.

Search for vocabulary entries that are WordNet synonyms of a word (via the biz-dfch-asdste100nlp library's Nlp class).

Every WordNet synset for term is collected and its lemma names are cross-referenced, case-insensitively, against the vocabulary's entries by name — the same scope as word_find/word_match/word_fuzzy (approved and rejected entries both included). term itself is excluded from the result. Use this to find approved alternatives for a non-STE word.

Parameters

term: The word to search synonyms for.

Returns

list[Word] A deduplicated, alphabetically sorted list of matching vocabulary entries. Empty if term has no WordNet synsets (out-of- vocabulary) or none of its synonyms are present in the vocabulary.