Skip to content

ツール

定義されていないキーは受け付けません

すべてのツールの入力スキーマに additionalProperties: false が指定されているため、定義されていないキー(たとえば section のつもりで sections を渡した場合)は SDK の入力検証で isError: true になり、黙って無視されることはありません。

このページは dist/tools/definitions.js から生成しています。説明文の日本語訳は翻訳メモリ(docs/i18n/ja.json)から当てており、原文が更新されて訳が追いついていない項目は英語のまま表示されます。

get_rfc_structureRFC の節の階層とメタデータを返します。メタデータ(分類・ストリーム・公開日・要旨)は IETF Datatracker API で補完します。includeAuthors=true を渡すと著者名も解決しますが、API 呼び出しが増えます。
get_requirementsRFC の規範的要件(MUST / SHOULD / MAY)を構造化した形で取り出します。
get_definitionsRFC に書かれている用語の定義を返します。
get_rfc_dependenciesRFC の参照関係(normative / informative)を返します。
get_related_sections指定した節と関連する節を返します。
generate_checklistRFC の実装チェックリストを Markdown で生成します。
validate_statement主張に関係する RFC の要件を探し、検出した矛盾を報告します。適合判定は行いませんisValid は 3 値で、null は判定できるだけの一致が無かったこと、false は矛盾を検出したこと、true は一致した要件の中に矛盾が無かったことを表します。照合は英語のキーワードに基づくので、主張は RFC の言い回しに合わせて英語で書いてください。

get_rfc_structure

RFC の節の階層とメタデータを返します。メタデータ(分類・ストリーム・公開日・要旨)は IETF Datatracker API で補完します。includeAuthors=true を渡すと著者名も解決しますが、API 呼び出しが増えます。

パラメータ

名前必須既定値enum制約説明
rfcnumberはいRFC 番号(例: 6455)
includeContentbooleanいいえfalse節の本文を含める(既定: false)
includeAuthorsbooleanいいえfalseDatatracker の documentauthorperson API で著者のフルネームを解決する(既定: false)。HTTP リクエストが 1 + N 回増えるが、結果はキャッシュされる。

定義されていないキーは受け付けません(additionalProperties: false)。

get_requirements

RFC の規範的要件(MUST / SHOULD / MAY)を構造化した形で取り出します。

パラメータ

名前必須既定値enum制約説明
rfcnumberはいRFC 番号
sectionstringいいえ節番号で絞り込む(例: "5.5.1")
levelstringいいえMUST, MUST NOT, REQUIRED, SHALL, SHALL NOT, SHOULD, SHOULD NOT, RECOMMENDED, NOT RECOMMENDED, MAY, OPTIONAL要件のレベルで絞り込む

定義されていないキーは受け付けません(additionalProperties: false)。

get_definitions

RFC に書かれている用語の定義を返します。

パラメータ

名前必須既定値enum制約説明
rfcnumberはいRFC 番号
termstringいいえ特定の用語を検索する

定義されていないキーは受け付けません(additionalProperties: false)。

get_rfc_dependencies

RFC の参照関係(normative / informative)を返します。

パラメータ

名前必須既定値enum制約説明
rfcnumberはいRFC 番号
includeReferencedBybooleanいいえfalseこの RFC を参照している RFC も含める(IETF Datatracker API から取得)

定義されていないキーは受け付けません(additionalProperties: false)。

指定した節と関連する節を返します。

パラメータ

名前必須既定値enum制約説明
rfcnumberはいRFC 番号
sectionstringはいminLength: 1起点にする節番号(例: "3.5" や "A.2")

定義されていないキーは受け付けません(additionalProperties: false)。

generate_checklist

RFC の実装チェックリストを Markdown で生成します。

パラメータ

名前必須既定値enum制約説明
rfcnumberはいRFC 番号
rolestringいいえ"both"client, server, both実装の役割(client / server / both)
sectionsstring[]いいえ含める節(省略時はすべて)
includeSubsectionsbooleanいいえtrue節で絞り込むときに下位の節も含める(既定: true)

定義されていないキーは受け付けません(additionalProperties: false)。

validate_statement

適合判定ではありません

主張に関係する RFC の要件を探し、検出した矛盾を報告します。適合判定は行いませんisValid は 3 値で、null は判定できるだけの一致が無かったこと、false は矛盾を検出したこと、true は一致した要件の中に矛盾が無かったことを表します。照合は英語のキーワードに基づくので、主張は RFC の言い回しに合わせて英語で書いてください。

パラメータ

名前必須既定値enum制約説明
rfcnumberはいRFC 番号
statementstringはい検証したい実装や振る舞いの記述

定義されていないキーは受け付けません(additionalProperties: false)。