waafir-redact リファレンス
waafir-redact サーバーは、接続された AI クライアントに Waafir の墨消し機能を 2 つの形で提供します。
redact_text— テキストブロックをインラインで墨消しし、すぐに返します。redact_file/redact_file_status— データルーム内の文書全体について PII を分析し、人によるレビューの準備をします。
文書への墨消しの適用は、意図的に MCP では提供していません。適用すると、他のすべての当事者がファイルを開いたときに見える内容が変わるため、AI 墨消しのレビュー画面で人が承認する必要があります。このサーバーのどのツールも、読み手に見える内容を変更しません。
接続:https://app.waafir.io/api/mcp/waafir、または領域サーバー https://app.waafir.io/api/mcp/waafir-redact。ツール名はどちらでも同じです。セットアップを参照してください。redact_text に必要なのは read スコープ(またはそれ以上)の PAT だけです。データルームに触れないため、ファイル単位やルーム単位のチェックはありません(ただし、モデルを実行するすべてのツールと同様に、有料プランと AI の有効化は必要です)。
どちらの文書ツールもディールチーム専用です。 redact_file には write スコープとデータルームのディールチームメンバーであることが必要です。redact_file_status も同様で、読み取りしか行わないにもかかわらず、read スコープの PAT は必要条件であって十分条件ではありません。墨消しジョブが存在すること自体が、その文書に関する事実だからです。ディールチーム外の呼び出し元は、トークンのスコープにかかわらず FORBIDDEN を受け取ります。トークンのスコープはトークンの上限であり、ディールチームのメンバーシップは本人の上限です。両方を満たす必要があります。
redact_text
テキストブロックから PII を墨消しします。テキストは組織の墨消しエージェントによって処理され、ツールは墨消し済みのテキストと、識別したエンティティの一覧を返します。必要に応じて、結果を特定のエンティティタイプに絞り込めます。
入力
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
text | string | はい | 墨消しするテキスト(空でないこと)。 |
types | string[] | いいえ | 墨消しをこれらの PII タイプに限定します。省略すると検出されたすべてを墨消しします。 |
出力
{ redacted_text, entities, truncated, processed_chars, total_chars, max_chars,
filtered_out_count, unclassified_redacted_count, unclassified_types,
filter_exact }redacted_text— 分析済みのテキストで、機密部分が黒塗りされたもの。entities— 除去された PII。typeは墨消しモデルが使用したラベル、canonical_typeはそれに対応する標準タイプで、分類できなかった場合はnullです。truncated/processed_chars/total_chars/max_chars— サイズ制限を参照してください。filtered_out_count/unclassified_redacted_count/unclassified_types/filter_exact— タイプによるフィルタリングを参照してください。
墨消しは組織独自の墨消し設定に基づいて実行されるため、結果は製品で使用されるのと同じエージェントを反映します。このサーフェス上のすべての操作と同様に、呼び出しはトークンの所有者として実行され、その組織の範囲に限定されます。
サイズ制限
分析されるのは最初の 80,000 文字 だけです。これは以前から変わりませんが、現在は結果でそのことが示されます。truncated が true の場合、processed_chars 以降のテキストは一切検査されていません。そのレスポンスを入力全体の墨消しとして扱わないでください。残りの部分は後続の呼び出しで送信してください。
タイプによるフィルタリング
types に指定できるのは次の値だけです。
name, email, phone, ssn, account, address, financial,
confidential, url, username
⚠️ 破壊的変更(2026 年 8 月)。 以前の
typesは任意の文字列を受け付けていました。現在は上記の値のみを受け付け、それ以外("emails"、"PII"、"credit-card"、あるいは"EMAIL"のように大文字小文字が異なるもの)はすべて検証エラーを返します。これは、気づきにくい失敗を明示的な失敗に置き換えるものです。以前は認識されない値は何にも一致しなかったため、ツールは何も墨消しせず、成功レスポンスの中で元のテキストを
redacted_textとして返していました。typesを指定する場合は、値を上の一覧に対応付けてください。typesを省略した呼び出しには影響しません。
要求していなくても墨消しされるエンティティタイプが 1 つあります。 墨消しモデルが、こちらで認識できないタイプのラベルを付けた場合、そのエンティティは除外されるのではなくそのまま墨消しされます。要求された範囲の外にあることを証明できず、テキストに PII を残すほうがより重大な誤りだからです。この場合:
filter_exactはfalseになります(フィルターが正確に適用された場合は常にtrue)。unclassified_redacted_countは影響を受けたエンティティの数を示します。unclassified_typesは該当するラベルを一覧表示します。
意図的にフィルターで除外したエンティティは、別途 filtered_out_count にカウントされます。
要件:有料プランであり、組織の AI 機能が有効になっていること(デフォルトでオン。組織の管理者は 設定 → AI & 統合 でオフにできます)。組織が 1 日の AI 使用量の上限に達した場合や、Waafir がこの機能を一時停止している間も、呼び出しは拒否されます。どちらの理由かはエラーメッセージに示されます。
redact_file
データルーム内の文書全体について PII を分析します。これは分析のみを行います。文書は変更されず、誰の表示内容も変わりません。分析は非同期で行われるため、redact_file_status をポーリングしてください。
入力
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
file_id | string | はい | ファイルの UUID。 |
override_redacted | boolean | いいえ | すでに墨消しされた文書を再分析します。指定しない場合、墨消し済みのファイルは拒否されます。 |
出力
{ file_id, job_id, status: "analysis_started", applied: false,
review_required: true, review_with, apply_via }設計上、auto_apply オプションはありません。このページ冒頭の注記を参照してください。画像ファイルはサポートされていません。
要件:write スコープの PAT、データルームのディールチームメンバーであること、有料プラン、および組織の AI 機能が有効になっていること(デフォルトでオン。組織の管理者は 設定 → AI & 統合 でオフにできます)。
まだチェック中のファイル。 ファイルが、Waafir のチェックがまだ完了していない新しいアップロードまたは新しいバージョンである場合、redact_file と redact_apply は error.reason: "ACTIVATION_PENDING" とメッセージ This file is still being checked. Try again shortly. を伴う UNAVAILABLE を返します。分析も適用も行われません。少し待ってからもう一度呼び出してください。
redact_file_status
文書の墨消し分析の状態を確認します。
入力
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
file_id | string | はい | ファイルの UUID。 |
出力
{ file_id, status, entity_count?, applied: false, apply_via }status—idle、analyzing、applying、review_ready、completed、failed、errorのいずれか。applyingとcompletedは、人が Waafir の UI で墨消しを適用している状態を表します。MCP からこれらの状態にすることはできませんが、ポーリング中に誰かがレビューを承認すると表示されます。entity_count— レビューの準備ができた時点で、分析が提案した PII エンティティの数。appliedは常にfalseです。墨消しの承認と適用は Waafir の UI で行われます。
認識できない status は、エラーではなく「ポーリングを続ける」と解釈してください。 終了状態はジョブマーカーがクリーンアップされるまでの短い間しか保持されないため、遅れて到着したポーラーには、待っていた状態ではなく idle(または再構築された review_ready)が見えます。また idle は「処理中のジョブがない」という意味であり、「何も起きなかった」という意味ではありません。値が固定の一覧のいずれかであると決めつけるのではなく、期限を設けて目的の状態をポーリングしてください。
redact_history
ファイルの最新の墨消し分析を、エンティティタイプ別の件数で返します。墨消しされたテキストそのものは決して返されません。
- スコープ:
read。ディールチームメンバーが、内容を読み取れるファイルに対して使用できます。 - 入力:
file_id(必須)。 - 出力:
{ file_id, analysis }。analysisは{ history_id, analysed_at, entities: { total, by_type } }で、ファイルが一度も分析されていない場合は null です。
redact_list_terms
データルームの墨消し用語:常に墨消しするフレーズ(always)と、決して墨消ししないフレーズ(never)。
- スコープ:
read。ディールチームメンバー。 - 入力:
dataroom_id(必須)。 - 出力:
{ terms }。各要素は{ id, term, kind, created_at }。
redact_add_term
データルームに用語を追加します。ルーム内のファイルの次回の墨消しから適用され、現時点ではどのファイルも変更しません。
- スコープ:
write。有料プランのディールチームメンバー。 - 入力:
dataroom_id、term(いずれも必須)、kind(alwaysまたはnever、デフォルトはalways)。 - 出力:
{ term }。
redact_remove_term
データルームから用語を削除します。現時点ではどのファイルも変更しません。用語を追加し直せば元に戻せます。
- スコープ:
write。ディールチームメンバー。 - 入力:
dataroom_id、term_id(いずれも必須)。 - 出力:
{ removed, term_id }。
redact_revert
ファイルの墨消しを解除します。投資家を含むすべての読み手に、直ちに元の文書が再び提供されます。墨消し済みバージョンは保持されるため、再適用できます。
- スコープ:
write。ディールチームメンバーが、編集できるファイルに対して使用できます。 - 入力:
file_id(必須)、confirm_token。 - 2 段階。
confirm_tokenを指定しない場合は何も変更されず、プレビューとトークンが返されます。同じ引数とそのトークンを指定してもう一度呼び出すと、元に戻されます。 - 墨消しされていないファイルは拒否されます(
409)。分析または焼き込み処理が実行中のファイルも拒否されます(409)。これはプレビューの段階で通知されるため、実行できない解除に対してトークンが発行されることはなく、確定時にも再度チェックされます。
redact_apply
redact_file によるファイルの最新の分析を、除外したエンティティタイプを差し引き、データルームの常時墨消し用語を加えて適用します。以後、投資家を含むすべての読み手には墨消し済みの文書が提供されます。redact_revert で元に戻せます。
- スコープ:
write。有料プランのディールチームメンバーが、内容を読み取れるファイルに対して使用できます。 - 入力:
file_id(必須)、exclude_types、confirm_token。 - 2 段階。
confirm_tokenを指定しない場合は何も変更されず、プレビュー(対象のタイプ別件数のみで、テキストは含まれません)とトークンが返されます。同じ引数とそのトークンを指定してもう一度呼び出すと、焼き込み処理が開始されます。その間に分析、ファイル、ルームの用語、または対象が変わった場合、呼び出しは拒否され、再度プレビューすることになります。 - 組織で AI がオフになっている場合は、Waafir と同様に、ルームに保存された常時墨消し用語のみを適用できます。