JSON Schema に合致した構造化出力を得たい
12. CI/CD・自動化コマンド / 機能
--json-schemaJSON Schema バリデーション付き出力(print モードのみ)
概要
--json-schema フラグにスキーマを渡すと、エージェントのワークフロー完了後に指定スキーマに合致した JSON オブジェクトが出力されます。データパイプラインや自動化での安定した出力に便利です。
設定例
# JSON Schema を指定して構造化出力を得る
claude -p --json-schema '{
"type": "object",
"properties": {
"summary": {"type": "string"},
"issues": {"type": "array", "items": {"type": "string"}},
"severity": {"type": "string", "enum": ["low", "medium", "high"]}
},
"required": ["summary", "issues", "severity"]
}' "このコードをレビューして"
# スキーマファイルを使う場合
claude -p --json-schema "$(cat schema.json)" "処理して"こんな時に使う
- コードレビュー結果を一定のフォーマットで受け取りたい時
- パイプライン処理で安定した JSON 出力が必要な時
- 複数ファイルを処理して結果を集計したい時
使い方
- 1-p(print モード)と合わせて使用
- 2--json-schema に JSON Schema 文字列を渡す
- 3エージェントの処理完了後にスキーマ準拠の JSON が出力される
Tips
- print モード(-p)専用のフラグ
- Agent SDK のドキュメントに詳細な使い方がある
- --output-format json と組み合わせると JSON ラッパーで受け取れる