Skip to content

Tools

Unknown keys are rejected

Every input schema has additionalProperties: false: an unknown key (for example sections where section is expected) is rejected by the SDK input validation with isError: true, not silently ignored.

Generated from dist/tools/definitions.js.

get_rfc_structureGet RFC section hierarchy and metadata. Metadata is enriched from the IETF Datatracker API (category, stream, publication date, abstract). Pass includeAuthors=true to also resolve author names (incurs extra API calls).
get_requirementsExtract normative requirements (MUST/SHOULD/MAY) from RFC in structured format.
get_definitionsGet term definitions from RFC.
get_rfc_dependenciesGet RFC reference relationships (normative/informative).
get_related_sectionsGet sections related to the specified section.
generate_checklistGenerate RFC implementation checklist in Markdown format.
validate_statementFind the RFC requirements that bear on a statement, and report detected contradictions. This does NOT decide conformance: isValid is three-valued (null = nothing matched strongly enough to judge, false = a contradiction was detected, true = none was detected among the matches). Matching is English keyword based; write the statement in the RFC's own wording.

get_rfc_structure

Get RFC section hierarchy and metadata. Metadata is enriched from the IETF Datatracker API (category, stream, publication date, abstract). Pass includeAuthors=true to also resolve author names (incurs extra API calls).

Parameters

NameTypeRequiredDefaultEnumConstraintsDescription
rfcnumberyesRFC number (e.g., 6455)
includeContentbooleannofalseInclude section content (default: false)
includeAuthorsbooleannofalseResolve author fullnames via Datatracker documentauthor + person API (default: false). Adds 1+N extra HTTP requests but results are cached.

Unknown keys are rejected (additionalProperties: false).

get_requirements

Extract normative requirements (MUST/SHOULD/MAY) from RFC in structured format.

Parameters

NameTypeRequiredDefaultEnumConstraintsDescription
rfcnumberyesRFC number
sectionstringnoFilter by section number (e.g., "5.5.1")
levelstringnoMUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, NOT RECOMMENDED, MAY, OPTIONALFilter by requirement level

Unknown keys are rejected (additionalProperties: false).

get_definitions

Get term definitions from RFC.

Parameters

NameTypeRequiredDefaultEnumConstraintsDescription
rfcnumberyesRFC number
termstringnoSearch for specific term

Unknown keys are rejected (additionalProperties: false).

get_rfc_dependencies

Get RFC reference relationships (normative/informative).

Parameters

NameTypeRequiredDefaultEnumConstraintsDescription
rfcnumberyesRFC number
includeReferencedBybooleannofalseInclude RFCs that reference this RFC (fetched from IETF Datatracker API)

Unknown keys are rejected (additionalProperties: false).

Get sections related to the specified section.

Parameters

NameTypeRequiredDefaultEnumConstraintsDescription
rfcnumberyesRFC number
sectionstringyesminLength: 1Base section number (e.g., "3.5" or "A.2")

Unknown keys are rejected (additionalProperties: false).

generate_checklist

Generate RFC implementation checklist in Markdown format.

Parameters

NameTypeRequiredDefaultEnumConstraintsDescription
rfcnumberyesRFC number
rolestringno"both"client, server, bothImplementation role (client/server/both)
sectionsstring[]noSections to include (all if omitted)
includeSubsectionsbooleannotrueInclude subsections when filtering by sections (default: true)

Unknown keys are rejected (additionalProperties: false).

validate_statement

Not a conformance judge

Find the RFC requirements that bear on a statement, and report detected contradictions. This does NOT decide conformance: isValid is three-valued (null = nothing matched strongly enough to judge, false = a contradiction was detected, true = none was detected among the matches). Matching is English keyword based; write the statement in the RFC's own wording.

Parameters

NameTypeRequiredDefaultEnumConstraintsDescription
rfcnumberyesRFC number
statementstringyesDescription of implementation or behavior to validate

Unknown keys are rejected (additionalProperties: false).