wirecanal.json 設定リファレンス

基本形——ダウンロードしたまま動きます

canal 詳細の「セットアップ」タブからダウンロードしたwirecanal.jsonは、そのままで動きます。中身はこの 2 キーだけです。

{
  "access_key": "ck_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "forward_target": "localhost:3000"
}

キー	必須	説明
`access_key`	必須	canal ごとの接続キー（`ck_`で始まる）。これ 1 つで「どの canal か」が決まり、公開ホスト名などの設定はクラウド側から自動で取得されます。失効・再発行はダッシュボードからいつでもできます。
`forward_target`	必須	届いた通信を渡すローカルの宛先。`"localhost:3000"`のように`ホスト:ポート`で書きます。エージェントはここに書いた宛先以外へは絶対に接続しません（転送先の固定）。

info設定は起動時に読み込まれます

wirecanal.jsonを書き換えたら、エージェントを再起動してください（Windows サービスならservice stop→service start）。また、動作中のエージェントには手元の wirecanal.json が正です——転送先がクラウド側から書き換えられることはありません。間違った設定のときは、起動時に理由を表示して止まります（間違ったまま動き続けることはありません）。

よく使うオプション

必要になったら、基本形に 1 行足すだけです。

キー	既定	説明・例
`lang`	`"ja"`	起動メッセージやログの表示言語。英語にするなら`"lang": "en"`。海外拠点のサーバーに便利です。
`access_log`	`true`	届いたリクエストをエージェントのコンソールに表示するか。静かにしたいときは`"access_log": false`。
`auto_update`	`true`	新しい版が出たら自動で入れ替える（配布物の署名を検証してから適用・失敗時は直前の版へ自動で戻る）。止めたいときだけ`"auto_update": false`。
`proxy_url`	なし	プロキシ必須の社内ネットワーク用。`"proxy_url": "http://proxy.example.co.jp:8080"`（Basic 認証は`http://user:pass@proxy:8080`）。環境変数のプロキシ設定は参照しません＝このキーに書いたときだけ経由します。適用されるのは外向きの接続だけで、転送先（社内向き）には適用されません。

複数の canal を 1 台でまとめて動かす

1 つのエージェント（1 プロセス）で複数の canal を同時に開通できます。canals配列を使います（ダッシュボードのセットアップタブで複数選択してダウンロードすると、この形式で生成されます）。

{
  "canals": [
    { "access_key": "ck_xxxxxxxx...", "forward_target": "localhost:3000" },
    { "access_key": "ck_yyyyyyyy...", "forward_target": "localhost:8080" }
  ],
  "lang": "ja"
}

check_circlelang・access_log・proxy_url・auto_updateなどの共通オプションはトップレベルに書くと全 canal に効きます（各エントリの中には書けません）。
check_circlecanalsとトップレベルのaccess_key/forward_targetの併用はできません（どちらかの形式に統一）。まとめられるのは 32 件までです。
check_circle1 件でも設定に誤りがあると全体が起動しません（一部だけ公開される、という中途半端な状態を作りません）。

MCP canal の設定（見せてよいツールを決める）

MCP canal のwirecanal.jsonは 4 キーになります。どのツールを外の AI に見せるかは、この手元のファイルだけが決めます（クラウド側から変更されることはありません＝許可の台帳は社内が握る two-key 設計）。

{
  "access_key": "ck_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "forward_target": "localhost:9310",
  "mode": "mcp",
  "tools": {
    "default": "deny",
    "allow": ["search_documents", "get_ticket"],
    "deny_destructive": true,
    "hide_denied_in_list": true
  }
}

キー	既定	説明
`mode`	自動	canal の種別に合わせてダッシュボードが生成します（MCP canal なら`"mcp"`）。手で書き換える必要はありません（種別と食い違うと起動時に止まって教えてくれます）。
`tools.default`	`"deny"`	許可リストにないツールの扱い。既定の`deny`のままがおすすめです（`allow`一覧が空のままなら「接続はできるが全ツールお断り」から安全に始まります）。
`tools.allow`	`[]`	外の AI に見せてよいツール名の一覧（完全一致）。
`tools.deny_destructive`	`false`	`true`にすると、delete / drop / remove など変更系の名前を持つツールをまとめて許可しません（許可リストより優先）。
`tools.hide_denied_in_list`	`false`	`true`にすると、許可していないツールは AI から見える一覧（tools/list）にもそもそも載せません。

高度な設定（通常は変更不要）

以下は既定のままで運用できるオプションです。要件があるときだけ足してください。

キー	既定	説明
`forward_target`（詳細形）	—	文字列の代わりにオブジェクトでも書けます:`{"host": "127.0.0.1", "port": 3001, "scheme": "http"}`。転送先を HTTPS で受けているなら`"scheme": "https"`。宛先に使えるのは localhost 系だけで、社内の別ホスト名（FQDN）を指定したい場合のみ`"allow_hostnames": true`を明示します（意図しない宛先への転送を防ぐため、既定では許可していません）。
`timeouts`	—	予約キー（将来対応。現在のエージェントは内部既定で動作し、このキーを書いても動作は変わりません）。応答をどこまで待つか（既定 120 秒）は、サーバー側の canal 設定で変更できます: canal 詳細のセットアップタブ、または公開 API の`response_timeout_sec`（有償プラン・最大 3600 秒）。
`reconnect`	自動	再接続の間隔。`base: "1s"`から`max_interval: "30s"`まで徐々に延ばし、打ち切らずに粘ります（常駐前提）。
`limits`	—	予約キー（将来対応。現在のエージェントは内部既定で動作し、このキーを書いても動作は変わりません）。流量の制御はサーバー側（プランと共通基盤）で行っています。
`audit`	無効	ツール呼び出しの操作記録を手元に残します:`{"enabled": true, "path": "ログの出力先", "hash_chain": true}`。`hash_chain`は記録の改変を検出できる形式。記録は既定で社内に閉じます（`ship_metadata_to_edge`は既定`false`）。
`kill_switch`	なし	緊急停止ファイルの場所:`{"file": "パス"}`。このファイルを置いた瞬間に、すべての転送を即時に止めます（削除すれば再開）。

取り扱いの注意

check_circlewirecanal.jsonには接続キーが入っています。読み取りを本人だけに絞ってください（Linux / macOS はchmod 600・Windows はフォルダのアクセス許可）。
check_circleキーが漏れた疑いがあれば、ダッシュボードから即時に失効・再発行できます（影響はその canal 1 本だけ。しかも転送先の固定により、書かれた宛先以外へは使えません）。
check_circleコメントを書きたいときは"__"で始まるキー（例"__about"）が無視されるので、メモとして使えます。

無料で canal を作るセットアップガイドへ戻る

wirecanal.json仕様