synapse-a2a 0.2.4__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of synapse-a2a might be problematic. Click here for more details.

Files changed (97) hide show
  1. synapse_a2a-0.2.4/PKG-INFO +1365 -0
  2. synapse_a2a-0.2.4/README.md +1351 -0
  3. synapse_a2a-0.2.4/pyproject.toml +99 -0
  4. synapse_a2a-0.2.4/setup.cfg +4 -0
  5. synapse_a2a-0.2.4/synapse/__init__.py +0 -0
  6. synapse_a2a-0.2.4/synapse/a2a_client.py +459 -0
  7. synapse_a2a-0.2.4/synapse/a2a_compat.py +1117 -0
  8. synapse_a2a-0.2.4/synapse/auth.py +283 -0
  9. synapse_a2a-0.2.4/synapse/cli.py +2065 -0
  10. synapse_a2a-0.2.4/synapse/commands/__init__.py +0 -0
  11. synapse_a2a-0.2.4/synapse/commands/list.py +162 -0
  12. synapse_a2a-0.2.4/synapse/commands/start.py +111 -0
  13. synapse_a2a-0.2.4/synapse/config.py +68 -0
  14. synapse_a2a-0.2.4/synapse/controller.py +599 -0
  15. synapse_a2a-0.2.4/synapse/delegation.py +99 -0
  16. synapse_a2a-0.2.4/synapse/error_detector.py +139 -0
  17. synapse_a2a-0.2.4/synapse/file_safety.py +1192 -0
  18. synapse_a2a-0.2.4/synapse/grpc_server.py +403 -0
  19. synapse_a2a-0.2.4/synapse/history.py +741 -0
  20. synapse_a2a-0.2.4/synapse/input_router.py +404 -0
  21. synapse_a2a-0.2.4/synapse/logging_config.py +135 -0
  22. synapse_a2a-0.2.4/synapse/output_parser.py +280 -0
  23. synapse_a2a-0.2.4/synapse/port_manager.py +185 -0
  24. synapse_a2a-0.2.4/synapse/profiles/claude.yaml +19 -0
  25. synapse_a2a-0.2.4/synapse/profiles/codex.yaml +12 -0
  26. synapse_a2a-0.2.4/synapse/profiles/dummy.yaml +13 -0
  27. synapse_a2a-0.2.4/synapse/profiles/gemini.yaml +13 -0
  28. synapse_a2a-0.2.4/synapse/proto/__init__.py +75 -0
  29. synapse_a2a-0.2.4/synapse/proto/a2a_pb2.py +84 -0
  30. synapse_a2a-0.2.4/synapse/proto/a2a_pb2_grpc.py +371 -0
  31. synapse_a2a-0.2.4/synapse/registry.py +171 -0
  32. synapse_a2a-0.2.4/synapse/server.py +317 -0
  33. synapse_a2a-0.2.4/synapse/settings.py +541 -0
  34. synapse_a2a-0.2.4/synapse/shell.py +197 -0
  35. synapse_a2a-0.2.4/synapse/shell_hook.py +112 -0
  36. synapse_a2a-0.2.4/synapse/templates/.synapse/default.md +72 -0
  37. synapse_a2a-0.2.4/synapse/templates/.synapse/delegate.md +40 -0
  38. synapse_a2a-0.2.4/synapse/templates/.synapse/file-safety.md +56 -0
  39. synapse_a2a-0.2.4/synapse/templates/.synapse/gemini.md +72 -0
  40. synapse_a2a-0.2.4/synapse/templates/.synapse/settings.json +32 -0
  41. synapse_a2a-0.2.4/synapse/tools/a2a.py +358 -0
  42. synapse_a2a-0.2.4/synapse/utils.py +64 -0
  43. synapse_a2a-0.2.4/synapse/webhooks.py +294 -0
  44. synapse_a2a-0.2.4/synapse_a2a.egg-info/PKG-INFO +1365 -0
  45. synapse_a2a-0.2.4/synapse_a2a.egg-info/SOURCES.txt +95 -0
  46. synapse_a2a-0.2.4/synapse_a2a.egg-info/dependency_links.txt +1 -0
  47. synapse_a2a-0.2.4/synapse_a2a.egg-info/entry_points.txt +4 -0
  48. synapse_a2a-0.2.4/synapse_a2a.egg-info/requires.txt +5 -0
  49. synapse_a2a-0.2.4/synapse_a2a.egg-info/top_level.txt +1 -0
  50. synapse_a2a-0.2.4/tests/test_a2a_client.py +332 -0
  51. synapse_a2a-0.2.4/tests/test_a2a_compat.py +644 -0
  52. synapse_a2a-0.2.4/tests/test_a2a_compat_extended.py +239 -0
  53. synapse_a2a-0.2.4/tests/test_auth.py +431 -0
  54. synapse_a2a-0.2.4/tests/test_cli.py +1218 -0
  55. synapse_a2a-0.2.4/tests/test_cli_args.py +187 -0
  56. synapse_a2a-0.2.4/tests/test_cli_commands_coverage.py +74 -0
  57. synapse_a2a-0.2.4/tests/test_cli_extra.py +96 -0
  58. synapse_a2a-0.2.4/tests/test_cli_file_safety.py +414 -0
  59. synapse_a2a-0.2.4/tests/test_cli_history.py +243 -0
  60. synapse_a2a-0.2.4/tests/test_cli_interactive.py +213 -0
  61. synapse_a2a-0.2.4/tests/test_cli_main.py +213 -0
  62. synapse_a2a-0.2.4/tests/test_cli_refactor_spec.py +181 -0
  63. synapse_a2a-0.2.4/tests/test_cmd_list_file_safety.py +147 -0
  64. synapse_a2a-0.2.4/tests/test_cmd_list_watch.py +710 -0
  65. synapse_a2a-0.2.4/tests/test_cmd_list_working_dir.py +165 -0
  66. synapse_a2a-0.2.4/tests/test_config.py +149 -0
  67. synapse_a2a-0.2.4/tests/test_controller.py +691 -0
  68. synapse_a2a-0.2.4/tests/test_controller_pty.py +261 -0
  69. synapse_a2a-0.2.4/tests/test_controller_registry_sync.py +173 -0
  70. synapse_a2a-0.2.4/tests/test_controller_resume.py +96 -0
  71. synapse_a2a-0.2.4/tests/test_delegation.py +121 -0
  72. synapse_a2a-0.2.4/tests/test_error_detector.py +268 -0
  73. synapse_a2a-0.2.4/tests/test_file_safety.py +735 -0
  74. synapse_a2a-0.2.4/tests/test_file_safety_extended.py +180 -0
  75. synapse_a2a-0.2.4/tests/test_gemini_init_timing.py +303 -0
  76. synapse_a2a-0.2.4/tests/test_grpc_server.py +230 -0
  77. synapse_a2a-0.2.4/tests/test_grpc_server_methods.py +195 -0
  78. synapse_a2a-0.2.4/tests/test_history.py +1013 -0
  79. synapse_a2a-0.2.4/tests/test_input_router.py +601 -0
  80. synapse_a2a-0.2.4/tests/test_input_router_extended.py +264 -0
  81. synapse_a2a-0.2.4/tests/test_interactive_idle_detection.py +495 -0
  82. synapse_a2a-0.2.4/tests/test_output_parser.py +444 -0
  83. synapse_a2a-0.2.4/tests/test_port_manager.py +215 -0
  84. synapse_a2a-0.2.4/tests/test_refactoring.py +234 -0
  85. synapse_a2a-0.2.4/tests/test_registry.py +201 -0
  86. synapse_a2a-0.2.4/tests/test_registry_extended.py +174 -0
  87. synapse_a2a-0.2.4/tests/test_sender_identification.py +294 -0
  88. synapse_a2a-0.2.4/tests/test_server.py +332 -0
  89. synapse_a2a-0.2.4/tests/test_server_extra.py +63 -0
  90. synapse_a2a-0.2.4/tests/test_server_lifespan.py +88 -0
  91. synapse_a2a-0.2.4/tests/test_settings.py +724 -0
  92. synapse_a2a-0.2.4/tests/test_shell.py +544 -0
  93. synapse_a2a-0.2.4/tests/test_shell_hook.py +266 -0
  94. synapse_a2a-0.2.4/tests/test_status_unification.py +117 -0
  95. synapse_a2a-0.2.4/tests/test_tools_a2a.py +903 -0
  96. synapse_a2a-0.2.4/tests/test_utils.py +199 -0
  97. synapse_a2a-0.2.4/tests/test_webhooks.py +303 -0
@@ -0,0 +1,1365 @@
1
+ Metadata-Version: 2.4
2
+ Name: synapse-a2a
3
+ Version: 0.2.4
4
+ Summary: Agent-to-Agent communication protocol for CLI agents
5
+ Author: Synapse A2A Team
6
+ License: MIT
7
+ Requires-Python: >=3.10
8
+ Description-Content-Type: text/markdown
9
+ Requires-Dist: fastapi>=0.100.0
10
+ Requires-Dist: uvicorn>=0.23.0
11
+ Requires-Dist: pyyaml>=6.0
12
+ Requires-Dist: requests>=2.31.0
13
+ Requires-Dist: httpx>=0.24.0
14
+
15
+ # Synapse A2A
16
+
17
+ > **各エージェントの挙動を変えることなく、エージェント同士を協力させてタスクを実行する**
18
+
19
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
20
+ [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
21
+ [![Tests](https://img.shields.io/badge/tests-915%20passed-brightgreen.svg)](#テスト)
22
+ [![Ask DeepWiki](https://img.shields.io/badge/Ask-DeepWiki-blue)](https://deepwiki.com/s-hiraoku/synapse-a2a)
23
+
24
+ > Claude Code、Codex、Gemini などの CLI エージェントを**そのままの形で**活用しながら、Google A2A プロトコルによるエージェント間協調を実現するフレームワーク
25
+
26
+ ## プロジェクトの目標
27
+
28
+ ```text
29
+ ┌─────────────────────────────────────────────────────────────────┐
30
+ │ ✅ エージェントの挙動を変えない(Non-Invasive) │
31
+ │ ✅ エージェント同士を協力させる(Collaborative) │
32
+ │ ✅ 既存のワークフローを維持する(Transparent) │
33
+ └─────────────────────────────────────────────────────────────────┘
34
+ ```
35
+
36
+ Synapse A2A は、各エージェントの入出力を**透過的に**ラップするだけで、エージェント自体の挙動には一切手を加えません。これにより:
37
+
38
+ - **各エージェントの強みを活かす**: 役割や得意分野はユーザーが自由に設定可能
39
+ - **学習コストゼロ**: 既存の使い方をそのまま継続できる
40
+ - **将来の変更に強い**: エージェントのアップデートに影響されにくい
41
+
42
+ 詳細は [プロジェクト哲学](docs/project-philosophy.md) を参照してください。
43
+
44
+ ```mermaid
45
+ flowchart LR
46
+ subgraph Terminal1["Terminal 1"]
47
+ subgraph Agent1["synapse claude :8100"]
48
+ Server1["A2A Server"]
49
+ PTY1["PTY + Claude CLI"]
50
+ end
51
+ end
52
+ subgraph Terminal2["Terminal 2"]
53
+ subgraph Agent2["synapse codex :8120"]
54
+ Server2["A2A Server"]
55
+ PTY2["PTY + Codex CLI"]
56
+ end
57
+ end
58
+ subgraph External["外部"]
59
+ ExtAgent["Google A2A Agent"]
60
+ end
61
+
62
+ Server1 <-->|"POST /tasks/send"| Server2
63
+ Server1 <-->|"A2A Protocol"| ExtAgent
64
+ Server2 <-->|"A2A Protocol"| ExtAgent
65
+ ```
66
+
67
+ ---
68
+
69
+ ## 目次
70
+
71
+ - [主な特徴](#主な特徴)
72
+ - [前提条件](#前提条件)
73
+ - [クイックスタート](#クイックスタート)
74
+ - [ユースケース](#ユースケース)
75
+ - [Claude Code プラグイン](#claude-code-プラグイン)
76
+ - [ドキュメント](#ドキュメント)
77
+ - [アーキテクチャ](#アーキテクチャ)
78
+ - [CLI コマンド](#cli-コマンド)
79
+ - [API エンドポイント](#api-エンドポイント)
80
+ - [Task 構造](#task-構造)
81
+ - [送信元識別](#送信元識別)
82
+ - [Priority(優先度)](#priority優先度)
83
+ - [Agent Card](#agent-card)
84
+ - [レジストリとポート管理](#レジストリとポート管理)
85
+ - [File Safety(ファイル競合防止)](#file-safetyファイル競合防止)
86
+ - [テスト](#テスト)
87
+ - [設定ファイル (.synapse)](#設定ファイル-synapse)
88
+ - [開発・リリース](#開発リリース)
89
+
90
+ ---
91
+
92
+ ## 主な特徴
93
+
94
+ | カテゴリ | 機能 |
95
+ | ---------------------- | -------------------------------------------------------- |
96
+ | **A2A 準拠** | 全通信が Message/Part + Task 形式、Agent Card による発見 |
97
+ | **CLI 連携** | 既存の CLI ツールを改造せずに A2A エージェント化 |
98
+ | **@Agent 記法** | `@claude`, `@codex-8120` で直接メッセージ送信 |
99
+ | **送信元識別** | `metadata.sender` + PID マッチングで送信元を自動識別 |
100
+ | **Priority Interrupt** | Priority 5 で SIGINT 送信後にメッセージ送信(緊急停止) |
101
+ | **マルチインスタンス** | 同じエージェントタイプを複数同時起動(ポート自動割当) |
102
+ | **外部連携** | 他の Google A2A エージェントとの通信 |
103
+ | **タスク委任** | 自然言語ルールで他エージェントへ自動タスク転送 |
104
+ | **File Safety** | ファイルロックと変更追跡でマルチエージェント競合を防止(`synapse list` でロック状態を確認可能) |
105
+
106
+ ---
107
+
108
+ ## 前提条件
109
+
110
+ - **OS**: macOS / Linux(Windows は WSL2 推奨)
111
+ - **Python**: 3.10+
112
+ - **CLI ツール**: 使用するエージェントの CLI を事前にインストール & 初期設定
113
+ - [Claude Code](https://docs.anthropic.com/en/docs/claude-code)
114
+ - [Codex CLI](https://github.com/openai/codex)
115
+ - [Gemini CLI](https://github.com/google-gemini/gemini-cli)
116
+
117
+ ---
118
+
119
+ ## クイックスタート
120
+
121
+ ### 1. Synapse A2A のインストール
122
+
123
+ ```bash
124
+ # PyPI からインストール(推奨)
125
+ pip install synapse-a2a
126
+
127
+ # gRPC も使う場合
128
+ pip install "synapse-a2a[grpc]"
129
+ ```
130
+
131
+ 開発者向け(このリポジトリを編集する場合):
132
+
133
+ ```bash
134
+ # uv でインストール
135
+ uv sync
136
+
137
+ # または pip(editable)
138
+ pip install -e .
139
+ ```
140
+
141
+ ### 2. Claude Code プラグインのインストール(推奨)
142
+
143
+ **Synapse A2A を最大限活用するには、Claude Code プラグインのインストールを強く推奨します。**
144
+
145
+ プラグインをインストールすると、Claude が自動的に Synapse A2A の機能を理解し、@agent パターンでのメッセージ送信、タスク委任、File Safety などを適切に使用できるようになります。
146
+
147
+ ```bash
148
+ # Claude Code 内で実行
149
+ /plugin marketplace add s-hiraoku/synapse-a2a
150
+ /plugin install synapse-a2a@s-hiraoku/synapse-a2a
151
+ ```
152
+
153
+ 詳細は [Claude Code プラグイン](#claude-code-プラグイン) を参照してください。
154
+
155
+ ### 3. エージェントを起動
156
+
157
+ ```bash
158
+ # Terminal 1: Claude
159
+ synapse claude
160
+
161
+ # Terminal 2: Codex
162
+ synapse codex
163
+
164
+ # Terminal 3: Gemini
165
+ synapse gemini
166
+ ```
167
+
168
+ > Note: 端末のスクロールバック表示が崩れる場合は、以下の起動方法を試してください。
169
+ > ```bash
170
+ > uv run synapse gemini
171
+ > # または
172
+ > uv run python -m synapse.cli gemini
173
+ > ```
174
+
175
+ ポートは自動割当されます:
176
+
177
+ | エージェント | ポート範囲 |
178
+ | ------------ | ---------- |
179
+ | Claude | 8100-8109 |
180
+ | Gemini | 8110-8119 |
181
+ | Codex | 8120-8129 |
182
+
183
+ ### 4. エージェント間通信
184
+
185
+ 端末内で `@Agent` を使ってメッセージ送信:
186
+
187
+ ```text
188
+ @codex この設計をレビューして
189
+ @gemini APIの改善案を出して
190
+ ```
191
+
192
+ #### 応答制御フラグ
193
+
194
+ ```text
195
+ @gemini --response 分析結果を教えて # 結果を待って受け取る(roundtrip)
196
+ @codex --no-response ビルドして # 転送のみ、結果を待たない(oneway)
197
+ ```
198
+
199
+ - `--response`: 結果を待って受け取る
200
+ - `--no-response`: 転送のみ(fire and forget)
201
+ - フラグなし: `a2a.flow` 設定に従う(デフォルトは結果を待つ)
202
+
203
+ 複数インスタンスがある場合は `@type-port` 形式で指定:
204
+
205
+ ```text
206
+ @codex-8120 こちらを担当して
207
+ @codex-8121 こちらを担当して
208
+ ```
209
+
210
+ ### 5. HTTP API
211
+
212
+ ```bash
213
+ # メッセージ送信
214
+ curl -X POST http://localhost:8100/tasks/send \
215
+ -H "Content-Type: application/json" \
216
+ -d '{"message": {"role": "user", "parts": [{"type": "text", "text": "Hello!"}]}}'
217
+
218
+ # 緊急停止(Priority 5)
219
+ curl -X POST "http://localhost:8100/tasks/send-priority?priority=5" \
220
+ -H "Content-Type: application/json" \
221
+ -d '{"message": {"role": "user", "parts": [{"type": "text", "text": "Stop!"}]}}'
222
+ ```
223
+
224
+ ---
225
+
226
+ ## ユースケース
227
+
228
+ ### 1. 瞬時の仕様確認 (Simple)
229
+ コーディングに特化した **Claude** で作業中、最新のライブラリ仕様やエラー情報を確認したい場合、Web検索が得意な **Gemini** にその場で問い合わせることで、コンテキストスイッチを防ぎます。
230
+
231
+ ```bash
232
+ # Claudeの画面で:
233
+ @gemini Python 3.12の新しいf-stringの仕様を要約して
234
+ ```
235
+
236
+ ### 2. 設計のクロスレビュー (Intermediate)
237
+ 自分の考えた設計に対して、異なる視点を持つエージェントからフィードバックをもらいます。
238
+
239
+ ```bash
240
+ # Claudeで設計案を出した後に:
241
+ @gemini この設計について、スケーラビリティと保守性の観点から批判的にレビューして
242
+ ```
243
+
244
+ ### 3. TDD ペアプログラミング (Intermediate)
245
+ 「テストを書く人」と「実装する人」を分けることで、堅牢なコードを作成します。
246
+
247
+ ```bash
248
+ # Terminal 1 (Codex):
249
+ auth.py の単体テストを作成して。ケースは正常系と、トークン期限切れの異常系で。
250
+
251
+ # Terminal 2 (Claude):
252
+ @codex-8120 が作成したテストに通るように auth.py を実装して
253
+ ```
254
+
255
+ ### 4. セキュリティ監査 (Specialized)
256
+ 自分の書いたコードをコミットする前に、セキュリティ専門家という役割を与えたエージェントに監査させます。
257
+
258
+ ```bash
259
+ # Gemini に役割を与える
260
+ あなたはセキュリティエンジニアです。脆弱性(SQLi, XSS等)の観点のみでレビューしてください。
261
+
262
+ # コードを書いてから:
263
+ @gemini 現在の変更内容(git diff)を監査して
264
+ ```
265
+
266
+ ### 5. エラーログからの自動修復 (Advanced)
267
+ テスト実行でエラーが出た際、ログファイルをエージェントに渡して修正案を適用させます。
268
+
269
+ ```bash
270
+ # テストが失敗した...
271
+ pytest > error.log
272
+
273
+ # エージェントに修正を依頼
274
+ @claude error.log を読んで、原因となっている synapse/server.py の箇所を修正して
275
+ ```
276
+
277
+ ### 6. 言語・フレームワークの移行 (Advanced)
278
+ 大規模なリファクタリングで、古い構文を新しい構文に置換する作業を分担します。
279
+
280
+ ```bash
281
+ # Terminal 1 (Claude):
282
+ legacy_api.js を読み込んで、TypeScriptの型定義を作成して
283
+
284
+ # Terminal 2 (Codex):
285
+ @claude が作成した型定義を使って、legacy_api.js を src/new_api.ts に書き換えて
286
+ ```
287
+
288
+ ### SSHリモート環境との違い
289
+
290
+ | 操作 | SSH | Synapse |
291
+ |-----|-----|---------|
292
+ | 手動でCLI操作 | ◎ | ◎ |
293
+ | プログラムからタスク投入 | △ expect等が必要 | ◎ HTTP API |
294
+ | 複数クライアント同時接続 | △ 複数セッション | ◎ 単一エンドポイント |
295
+ | 進捗のリアルタイム通知 | ✗ | ◎ SSE/Webhook |
296
+ | エージェント間の自動連携 | ✗ | ◎ @Agent記法 |
297
+
298
+ > **Note**: 個人でCLI操作するだけなら SSH で十分なケースも多いです。Synapse は「自動化」「連携」「マルチエージェント」が必要な場面で真価を発揮します。
299
+
300
+ ---
301
+
302
+ ## Claude Code プラグイン
303
+
304
+ Synapse A2A を Claude Code で使用する場合、**プラグインのインストールを強く推奨します**。
305
+
306
+ ### なぜプラグインが必要か
307
+
308
+ プラグインをインストールすると、Claude が以下を自動的に理解・実行できるようになります:
309
+
310
+ - **@agent パターン**: `@codex ファイルを修正して` のようなエージェント間通信
311
+ - **応答制御**: `--response` / `--no-response` フラグでの応答制御
312
+ - **優先度制御**: Priority 1-5 でのメッセージ送信(5 は緊急停止)
313
+ - **タスク委任**: `delegation.enabled` での自動タスク振り分け
314
+ - **File Safety**: ファイルロックと変更追跡でマルチエージェント競合を防止
315
+ - **履歴管理**: タスク履歴の検索・エクスポート・統計
316
+
317
+ ### インストール方法
318
+
319
+ ```bash
320
+ # Claude Code 内で実行
321
+ /plugin marketplace add s-hiraoku/synapse-a2a
322
+ /plugin install synapse-a2a@s-hiraoku/synapse-a2a
323
+ ```
324
+
325
+ ### 含まれるスキル
326
+
327
+ | スキル | 説明 |
328
+ |--------|------|
329
+ | **synapse-a2a** | エージェント間通信の包括的ガイド。@agent ルーティング、`--response`/`--no-response` フラグ、優先度、A2A プロトコル、履歴管理、File Safety、設定管理をカバー |
330
+ | **delegation** | 自動タスク委任の設定。`delegation.enabled` での有効化、事前チェック、エラーハンドリング、File Safety 連携 |
331
+
332
+ ### ディレクトリ構造
333
+
334
+ ```text
335
+ plugins/
336
+ └── synapse-a2a/
337
+ ├── .claude-plugin/plugin.json
338
+ ├── README.md
339
+ └── skills/
340
+ ├── synapse-a2a/SKILL.md
341
+ └── delegation/SKILL.md
342
+ ```
343
+
344
+ 詳細は [plugins/synapse-a2a/README.md](plugins/synapse-a2a/README.md) を参照してください。
345
+
346
+ > **Note**: Codex もプラグインには対応していませんが、展開された skills を `.codex/` ディレクトリ(具体的には `.codex/skills/`)に配置することで、これらの機能を活用することが可能です。
347
+
348
+ ---
349
+
350
+ ## ドキュメント
351
+
352
+ - [guides/README.md](guides/README.md) - ドキュメント全体の見取り図
353
+ - [guides/multi-agent-setup.md](guides/multi-agent-setup.md) - セットアップ手順
354
+ - [guides/usage.md](guides/usage.md) - コマンドと運用パターン
355
+ - [guides/settings.md](guides/settings.md) - `.synapse` 設定の詳細
356
+ - [guides/troubleshooting.md](guides/troubleshooting.md) - よくある問題と対処
357
+
358
+ ---
359
+
360
+ ## アーキテクチャ
361
+
362
+ ### A2A サーバー / クライアント構成
363
+
364
+ Synapse では **各エージェントが A2A サーバーとして動作** します。中央サーバーは存在せず、P2P 構成です。
365
+
366
+ ```
367
+ ┌─────────────────────────────────────┐ ┌─────────────────────────────────────┐
368
+ │ synapse claude (port 8100) │ │ synapse codex (port 8120) │
369
+ │ ┌───────────────────────────────┐ │ │ ┌───────────────────────────────┐ │
370
+ │ │ FastAPI Server (A2A Server) │ │ │ │ FastAPI Server (A2A Server) │ │
371
+ │ │ /.well-known/agent.json │ │ │ │ /.well-known/agent.json │ │
372
+ │ │ /tasks/send │◄─┼────┼──│ A2AClient │ │
373
+ │ │ /tasks/{id} │ │ │ └───────────────────────────────┘ │
374
+ │ └───────────────────────────────┘ │ │ ┌───────────────────────────────┐ │
375
+ │ ┌───────────────────────────────┐ │ │ │ PTY + Codex CLI │ │
376
+ │ │ PTY + Claude CLI │ │ │ └───────────────────────────────┘ │
377
+ │ └───────────────────────────────┘ │ └─────────────────────────────────────┘
378
+ └─────────────────────────────────────┘
379
+ ```
380
+
381
+ 各エージェントは:
382
+
383
+ - **A2A サーバー**: 他のエージェントからのリクエストを受け付ける
384
+ - **A2A クライアント**: 他のエージェントにリクエストを送信する
385
+
386
+ ### 主要コンポーネント
387
+
388
+ | コンポーネント | ファイル | 役割 |
389
+ | ------------------ | ------------------------- | ------------------------ |
390
+ | FastAPI Server | `synapse/server.py` | A2A エンドポイント提供 |
391
+ | A2A Router | `synapse/a2a_compat.py` | A2A プロトコル実装 |
392
+ | A2A Client | `synapse/a2a_client.py` | 他エージェントへの通信 |
393
+ | TerminalController | `synapse/controller.py` | PTY 管理、READY/PROCESSING 検出 |
394
+ | InputRouter | `synapse/input_router.py` | @Agent パターン検出 |
395
+ | AgentRegistry | `synapse/registry.py` | エージェント登録・検索 |
396
+
397
+ ### 起動シーケンス
398
+
399
+ ```mermaid
400
+ sequenceDiagram
401
+ participant Synapse as Synapse Server
402
+ participant Registry as AgentRegistry
403
+ participant PTY as TerminalController
404
+ participant CLI as CLI Agent
405
+
406
+ Synapse->>Registry: 1. エージェント登録 (agent_id, pid, port)
407
+ Synapse->>PTY: 2. PTY 起動
408
+ PTY->>CLI: 3. CLI エージェント起動
409
+ Synapse->>PTY: 4. 初期指示送信 (sender: synapse-system)
410
+ PTY->>CLI: 5. AI が初期指示を受信
411
+ ```
412
+
413
+ ### 通信フロー
414
+
415
+ ```mermaid
416
+ sequenceDiagram
417
+ participant User as ユーザー
418
+ participant Claude as Claude (8100)
419
+ participant Client as A2AClient
420
+ participant Codex as Codex (8120)
421
+
422
+ User->>Claude: @codex 設計をレビューして
423
+ Claude->>Client: send_to_local()
424
+ Client->>Codex: POST /tasks/send-priority
425
+ Codex->>Codex: Task 作成 → PTY に書き込み
426
+ Codex-->>Client: {"task": {"id": "...", "status": "working"}}
427
+ Client-->>Claude: [→ codex] 送信完了
428
+ ```
429
+
430
+ ---
431
+
432
+ ## CLI コマンド
433
+
434
+ ### 基本操作
435
+
436
+ ```bash
437
+ # エージェント起動(フォアグラウンド)
438
+ synapse claude
439
+ synapse codex
440
+ synapse gemini
441
+
442
+ # ポート指定
443
+ synapse claude --port 8105
444
+
445
+ # CLI ツールに引数を渡す
446
+ synapse claude -- --resume
447
+ ```
448
+
449
+ ### コマンド一覧
450
+
451
+ | コマンド | 説明 |
452
+ | --------------------------------- | ---------------------- |
453
+ | `synapse <profile>` | フォアグラウンドで起動 |
454
+ | `synapse start <profile>` | バックグラウンドで起動 |
455
+ | `synapse stop <profile\|id>` | エージェント停止(ID指定も可) |
456
+ | `synapse --version` | バージョン情報表示 |
457
+ | `synapse list` | 実行中エージェント一覧 |
458
+ | `synapse logs <profile>` | ログ表示 |
459
+ | `synapse send <target> <message>` | メッセージ送信 |
460
+ | `synapse history list` | タスク履歴表示 |
461
+ | `synapse history show <task_id>` | タスク詳細表示 |
462
+ | `synapse history search` | キーワード検索 |
463
+ | `synapse history cleanup` | 古いデータ削除 |
464
+ | `synapse history stats` | 統計情報表示 |
465
+ | `synapse history export` | JSON/CSV エクスポート |
466
+ | `synapse file-safety status` | ファイル安全統計表示 |
467
+ | `synapse file-safety locks` | アクティブロック一覧 |
468
+ | `synapse file-safety lock` | ファイルをロック |
469
+ | `synapse file-safety unlock` | ロック解放 |
470
+ | `synapse file-safety history` | ファイル変更履歴 |
471
+ | `synapse file-safety recent` | 最近の変更一覧 |
472
+ | `synapse file-safety record` | 変更を手動記録 |
473
+ | `synapse file-safety cleanup` | 古いデータ削除 |
474
+ | `synapse file-safety debug` | デバッグ情報表示 |
475
+
476
+ ### コンテキストの再開 (Resume Mode)
477
+
478
+ 既存のセッションを再開する場合、以下のフラグを使用すると **初期インストラクション(A2A プロトコル説明)の送信をスキップ** できます。これにより、コンテキストを汚さずにスムーズに作業を継続できます。
479
+
480
+ ```bash
481
+ # Claude Code のセッション再開
482
+ synapse claude -- --resume
483
+
484
+ # Gemini の履歴指定再開
485
+ synapse gemini -- --resume=5
486
+
487
+ # フラグは settings.json でカスタマイズ可能
488
+ synapse codex -- resume --last
489
+ ```
490
+
491
+ デフォルトの対応フラグ(`settings.json` で変更可能):
492
+ - **Claude**: `--resume`, `--continue`, `-r`, `-c`
493
+ - **Gemini**: `--resume`, `-r`
494
+ - **Codex**: `resume`
495
+
496
+
497
+ ### 外部エージェント管理
498
+
499
+ ```bash
500
+ # 外部エージェント登録
501
+ synapse external add http://other-agent:9000 --alias other
502
+
503
+ # 一覧表示
504
+ synapse external list
505
+
506
+ # メッセージ送信
507
+ synapse external send other "タスクを処理して"
508
+ ```
509
+
510
+ ### タスク履歴管理
511
+
512
+ タスク履歴機能により、過去のエージェント実行結果を検索・参照・分析できます。
513
+
514
+ **有効化:**
515
+
516
+ ```bash
517
+ # 環境変数で有効化
518
+ export SYNAPSE_HISTORY_ENABLED=true
519
+ synapse claude
520
+ ```
521
+
522
+ #### 基本操作
523
+
524
+ ```bash
525
+ # 最新50件の履歴を表示
526
+ synapse history list
527
+
528
+ # 特定エージェントのみ表示
529
+ synapse history list --agent claude
530
+
531
+ # カスタム件数で表示
532
+ synapse history list --limit 100
533
+
534
+ # タスク詳細を表示
535
+ synapse history show task-id-uuid
536
+ ```
537
+
538
+ #### キーワード検索(Phase 2a)
539
+
540
+ 入力・出力フィールドからキーワードで検索:
541
+
542
+ ```bash
543
+ # 単一キーワード検索
544
+ synapse history search "Python"
545
+
546
+ # 複数キーワード(OR ロジック)
547
+ synapse history search "Python" "Docker"
548
+
549
+ # AND ロジック(すべてのキーワードを含む)
550
+ synapse history search "Python" "function" --logic AND
551
+
552
+ # エージェント フィルタ付き
553
+ synapse history search "Python" --agent claude
554
+
555
+ # 件数制限
556
+ synapse history search "error" --limit 20
557
+ ```
558
+
559
+ #### 統計情報表示(Phase 2d)
560
+
561
+ タスク実行の統計情報を表示:
562
+
563
+ ```bash
564
+ # 全体統計(総数、成功率、エージェント別集計)
565
+ synapse history stats
566
+
567
+ # 特定エージェントの統計
568
+ synapse history stats --agent claude
569
+ ```
570
+
571
+ 出力例:
572
+ ```text
573
+ ============================================================
574
+ TASK HISTORY STATISTICS
575
+ ============================================================
576
+
577
+ Total Tasks: 150
578
+ Completed: 140
579
+ Failed: 10
580
+ Success Rate: 93.3%
581
+
582
+ Database Size: 2.5 MB
583
+ Oldest Task: 2026-01-01 10:00:00
584
+ Newest Task: 2026-01-04 15:30:00
585
+
586
+ ============================================================
587
+ BY AGENT
588
+ ============================================================
589
+
590
+ Agent Total Completed Failed
591
+ ------------------------------------------------------------
592
+ claude 100 95 5
593
+ gemini 50 45 5
594
+ ```
595
+
596
+ #### データ エクスポート(Phase 2b)
597
+
598
+ JSON または CSV 形式でエクスポート:
599
+
600
+ ```bash
601
+ # JSON エクスポート(標準出力)
602
+ synapse history export --format json
603
+
604
+ # CSV エクスポート
605
+ synapse history export --format csv
606
+
607
+ # ファイル保存
608
+ synapse history export --format json --output history.json
609
+ synapse history export --format csv --agent claude > claude_history.csv
610
+
611
+ # フィルタ付きエクスポート
612
+ synapse history export --format json --agent gemini --limit 50
613
+ ```
614
+
615
+ #### リテンション ポリシー(Phase 2c)
616
+
617
+ 古いデータを自動削除:
618
+
619
+ ```bash
620
+ # 30日以上前のデータを削除
621
+ synapse history cleanup --days 30
622
+
623
+ # データベースサイズを 100MB 以下に保つ
624
+ synapse history cleanup --max-size 100
625
+
626
+ # 確認なしで実行(自動化用)
627
+ synapse history cleanup --days 30 --force
628
+
629
+ # ドライラン(削除予定内容を表示するだけ)
630
+ synapse history cleanup --days 30 --dry-run
631
+ ```
632
+
633
+ **ストレージ:**
634
+
635
+ - SQLite データベース: `~/.synapse/history/history.db`
636
+ - 保存項目: タスクID、エージェント名、入力、出力、ステータス、メタデータ
637
+ - 自動インデックス: agent_name, timestamp, task_id
638
+
639
+ **設定:**
640
+
641
+ - **有効化**: `SYNAPSE_HISTORY_ENABLED=true`
642
+ - **無効化**: `SYNAPSE_HISTORY_ENABLED=false`(デフォルト)
643
+ - デフォルトでは無効です。有効化するには環境変数を設定してから起動してください
644
+
645
+ ### A2A CLI ツール
646
+
647
+ 低レベル操作用:
648
+
649
+ ```bash
650
+ # エージェント一覧
651
+ python3 synapse/tools/a2a.py list
652
+
653
+ # メッセージ送信
654
+ python3 synapse/tools/a2a.py send --target claude --priority 1 "Hello"
655
+
656
+ # 緊急停止
657
+ python3 synapse/tools/a2a.py send --target claude --priority 5 "Stop!"
658
+ ```
659
+
660
+ ---
661
+
662
+ ## API エンドポイント
663
+
664
+ ### A2A 準拠
665
+
666
+ | エンドポイント | メソッド | 説明 |
667
+ | ------------------------- | -------- | ----------------- |
668
+ | `/.well-known/agent.json` | GET | Agent Card |
669
+ | `/tasks/send` | POST | メッセージ送信 |
670
+ | `/tasks/send-priority` | POST | Priority 付き送信 |
671
+ | `/tasks/{id}` | GET | タスク状態取得 |
672
+ | `/tasks` | GET | タスク一覧 |
673
+ | `/tasks/{id}/cancel` | POST | タスクキャンセル |
674
+ | `/status` | GET | READY/PROCESSING 状態 |
675
+
676
+ ### 外部エージェント
677
+
678
+ | エンドポイント | メソッド | 説明 |
679
+ | ------------------------------- | -------- | -------------------- |
680
+ | `/external/discover` | POST | 外部エージェント登録 |
681
+ | `/external/agents` | GET | 一覧 |
682
+ | `/external/agents/{alias}` | DELETE | 削除 |
683
+ | `/external/agents/{alias}/send` | POST | 送信 |
684
+
685
+ ---
686
+
687
+ ## Task 構造
688
+
689
+ A2A プロトコルでは、全ての通信が **Task** として管理されます。
690
+
691
+ ### Task ライフサイクル
692
+
693
+ ```mermaid
694
+ stateDiagram-v2
695
+ [*] --> submitted: POST /tasks/send
696
+ submitted --> working: 処理開始
697
+ working --> completed: 正常終了
698
+ working --> failed: エラー
699
+ working --> input_required: 追加入力待ち
700
+ input_required --> working: 入力受信
701
+ completed --> [*]
702
+ failed --> [*]
703
+ ```
704
+
705
+ ### Task オブジェクト
706
+
707
+ ```json
708
+ {
709
+ "id": "550e8400-e29b-41d4-a716-446655440000",
710
+ "context_id": "conversation-123",
711
+ "status": "working",
712
+ "message": {
713
+ "role": "user",
714
+ "parts": [{ "type": "text", "text": "この設計をレビューして" }]
715
+ },
716
+ "artifacts": [],
717
+ "metadata": {
718
+ "sender": {
719
+ "sender_id": "synapse-claude-8100",
720
+ "sender_type": "claude",
721
+ "sender_endpoint": "http://localhost:8100"
722
+ }
723
+ },
724
+ "created_at": "2024-01-15T10:30:00Z",
725
+ "updated_at": "2024-01-15T10:30:05Z"
726
+ }
727
+ ```
728
+
729
+ ### フィールド説明
730
+
731
+ | フィールド | 型 | 説明 |
732
+ | ------------ | ---------- | ------------------------------------------------------------------- |
733
+ | `id` | string | タスクの一意識別子(UUID) |
734
+ | `context_id` | string? | 会話コンテキスト ID(マルチターン用) |
735
+ | `status` | string | `submitted` / `working` / `completed` / `failed` / `input_required` |
736
+ | `message` | Message | 送信されたメッセージ |
737
+ | `artifacts` | Artifact[] | タスク完了時の成果物 |
738
+ | `metadata` | object | 送信元情報など(`metadata.sender`) |
739
+ | `created_at` | string | 作成日時(ISO 8601) |
740
+ | `updated_at` | string | 更新日時(ISO 8601) |
741
+
742
+ ### Message 構造
743
+
744
+ ```json
745
+ {
746
+ "role": "user",
747
+ "parts": [
748
+ { "type": "text", "text": "メッセージ内容" },
749
+ {
750
+ "type": "file",
751
+ "file": {
752
+ "name": "doc.pdf",
753
+ "mimeType": "application/pdf",
754
+ "bytes": "..."
755
+ }
756
+ }
757
+ ]
758
+ }
759
+ ```
760
+
761
+ | Part タイプ | 説明 |
762
+ | ----------- | ------------------ |
763
+ | `text` | テキストメッセージ |
764
+ | `file` | ファイル添付 |
765
+ | `data` | 構造化データ |
766
+
767
+ ### 初期指示 Task
768
+
769
+ エージェント起動時、Synapse は A2A Task として初期指示を送信します。
770
+
771
+ ```json
772
+ {
773
+ "id": "init-task-id",
774
+ "status": "working",
775
+ "message": {
776
+ "role": "user",
777
+ "parts": [
778
+ { "type": "text", "text": "[Synapse A2A Protocol Instructions]\n\n..." }
779
+ ]
780
+ },
781
+ "metadata": {
782
+ "sender": {
783
+ "sender_id": "synapse-system",
784
+ "sender_type": "system",
785
+ "sender_endpoint": "http://localhost:8100"
786
+ }
787
+ }
788
+ }
789
+ ```
790
+
791
+ PTY 出力形式:
792
+
793
+ ```
794
+ [A2A:init1234:synapse-system] [Synapse A2A Protocol Instructions]
795
+
796
+ You are participating in a multi-agent environment connected via the Synapse A2A Protocol.
797
+
798
+ ## Your Identity
799
+ - Agent ID: synapse-claude-8100
800
+ - Agent Type: claude
801
+ - Port: 8100
802
+
803
+ ## How to Send Messages (@Agent)
804
+ ...
805
+ ```
806
+
807
+ 初期指示には以下が含まれます:
808
+
809
+ - エージェントの identity(ID, type, port)
810
+ - @Agent でのメッセージ送信方法
811
+ - 利用可能な他のエージェント一覧
812
+ - 送信元識別と **返信方法**(`[A2A:task_id:sender_id]` から sender_id を抽出して返信)
813
+
814
+ ---
815
+
816
+ ## 送信元識別
817
+
818
+ A2A メッセージの送信元は `metadata.sender` で識別できます。
819
+
820
+ ### PTY 出力形式
821
+
822
+ ```
823
+ [A2A:<task_id>:<sender_id>] <message>
824
+ ```
825
+
826
+ 例:
827
+
828
+ ```
829
+ [A2A:abc12345:synapse-claude-8100] この設計をレビューしてください
830
+ ```
831
+
832
+ ### Task API での確認
833
+
834
+ ```bash
835
+ curl -s http://localhost:8120/tasks/{task_id} | jq '.metadata.sender'
836
+ ```
837
+
838
+ レスポンス:
839
+
840
+ ```json
841
+ {
842
+ "sender_id": "synapse-claude-8100",
843
+ "sender_type": "claude",
844
+ "sender_endpoint": "http://localhost:8100"
845
+ }
846
+ ```
847
+
848
+ ### 仕組み
849
+
850
+ 1. **送信時**: Registry を参照し、PID マッチングで自身の agent_id を特定
851
+ 2. **Task 作成時**: `metadata.sender` に送信元情報を付与
852
+ 3. **受信時**: PTY プレフィックスまたは Task API で確認
853
+
854
+ ---
855
+
856
+ ## Priority(優先度)
857
+
858
+ | Priority | 動作 | 用途 |
859
+ | -------- | ----------------------- | -------------- |
860
+ | 1-4 | 通常の stdin 書き込み | 通常メッセージ |
861
+ | 5 | SIGINT 送信後に書き込み | 緊急停止 |
862
+
863
+ ```bash
864
+ # 緊急停止
865
+ synapse send claude "Stop!" --priority 5
866
+ ```
867
+
868
+ ---
869
+
870
+ ## Agent Card
871
+
872
+ 各エージェントは `/.well-known/agent.json` で Agent Card を公開します。
873
+
874
+ ```bash
875
+ curl http://localhost:8100/.well-known/agent.json
876
+ ```
877
+
878
+ ```json
879
+ {
880
+ "name": "Synapse Claude",
881
+ "description": "PTY-wrapped claude CLI agent with A2A communication",
882
+ "url": "http://localhost:8100",
883
+ "capabilities": {
884
+ "streaming": false,
885
+ "pushNotifications": false,
886
+ "multiTurn": true
887
+ },
888
+ "skills": [
889
+ {
890
+ "id": "chat",
891
+ "name": "Chat",
892
+ "description": "Send messages to the CLI agent"
893
+ },
894
+ {
895
+ "id": "interrupt",
896
+ "name": "Interrupt",
897
+ "description": "Interrupt current processing"
898
+ }
899
+ ],
900
+ "extensions": {
901
+ "synapse": {
902
+ "agent_id": "synapse-claude-8100",
903
+ "pty_wrapped": true,
904
+ "priority_interrupt": true,
905
+ "at_agent_syntax": true
906
+ }
907
+ }
908
+ }
909
+ ```
910
+
911
+ ### 設計思想
912
+
913
+ Agent Card は「名刺」として他者向け情報のみを含みます:
914
+
915
+ - capabilities, skills, endpoint など
916
+ - 内部指示は含まない(起動時に A2A Task で送信)
917
+
918
+ ---
919
+
920
+ ## レジストリとポート管理
921
+
922
+ ### レジストリファイル
923
+
924
+ ```
925
+ ~/.a2a/registry/
926
+ ├── synapse-claude-8100.json
927
+ ├── synapse-claude-8101.json
928
+ └── synapse-gemini-8110.json
929
+ ```
930
+
931
+ ### 自動クリーンアップ
932
+
933
+ stale エントリは以下の操作で自動削除:
934
+
935
+ - `synapse list` 実行時
936
+ - メッセージ送信時(対象が死んでいる場合)
937
+
938
+ ### ポート範囲
939
+
940
+ ```python
941
+ PORT_RANGES = {
942
+ "claude": (8100, 8109),
943
+ "gemini": (8110, 8119),
944
+ "codex": (8120, 8129),
945
+ "dummy": (8190, 8199),
946
+ }
947
+ ```
948
+
949
+ ---
950
+
951
+ ## File Safety(ファイル競合防止)
952
+
953
+ マルチエージェント環境で複数のエージェントが同時にファイルを編集する際の競合を防止します。
954
+
955
+ ```mermaid
956
+ sequenceDiagram
957
+ participant Claude
958
+ participant FS as File Safety
959
+ participant Gemini
960
+
961
+ Claude->>FS: acquire_lock("auth.py")
962
+ FS-->>Claude: ACQUIRED
963
+
964
+ Gemini->>FS: validate_write("auth.py")
965
+ FS-->>Gemini: DENIED (locked by claude)
966
+
967
+ Claude->>FS: release_lock("auth.py")
968
+ Gemini->>FS: acquire_lock("auth.py")
969
+ FS-->>Gemini: ACQUIRED
970
+ ```
971
+
972
+ ### 機能
973
+
974
+ | 機能 | 説明 |
975
+ |------|------|
976
+ | **ファイルロック** | 排他制御で同時編集を防止 |
977
+ | **変更追跡** | 誰がいつ何を変更したか記録 |
978
+ | **コンテキスト注入** | 読み込み時に最近の変更履歴を提供 |
979
+ | **事前バリデーション** | 書き込み前にロック状態をチェック |
980
+
981
+ ### 有効化
982
+
983
+ ```bash
984
+ # 環境変数で有効化
985
+ export SYNAPSE_FILE_SAFETY_ENABLED=true
986
+ synapse claude
987
+ ```
988
+
989
+ ### 基本コマンド
990
+
991
+ ```bash
992
+ # 統計表示
993
+ synapse file-safety status
994
+
995
+ # アクティブロック一覧
996
+ synapse file-safety locks
997
+
998
+ # ロック取得
999
+ synapse file-safety lock /path/to/file.py claude --intent "Refactoring"
1000
+
1001
+ # ロック解放
1002
+ synapse file-safety unlock /path/to/file.py claude
1003
+
1004
+ # ファイル変更履歴
1005
+ synapse file-safety history /path/to/file.py
1006
+
1007
+ # 最近の変更一覧
1008
+ synapse file-safety recent
1009
+
1010
+ # 古いデータ削除
1011
+ synapse file-safety cleanup --days 30
1012
+ ```
1013
+
1014
+ ### Python API
1015
+
1016
+ ```python
1017
+ from synapse.file_safety import FileSafetyManager, ChangeType, LockStatus
1018
+
1019
+ manager = FileSafetyManager.from_env()
1020
+
1021
+ # ロック取得
1022
+ result = manager.acquire_lock("/path/to/file.py", "claude", intent="Refactoring")
1023
+ if result["status"] == LockStatus.ACQUIRED:
1024
+ # ファイル編集...
1025
+
1026
+ # 変更記録
1027
+ manager.record_modification(
1028
+ file_path="/path/to/file.py",
1029
+ agent_name="claude",
1030
+ task_id="task-123",
1031
+ change_type=ChangeType.MODIFY,
1032
+ intent="Fix authentication bug"
1033
+ )
1034
+
1035
+ # ロック解放
1036
+ manager.release_lock("/path/to/file.py", "claude")
1037
+
1038
+ # 書き込み前バリデーション
1039
+ validation = manager.validate_write("/path/to/file.py", "gemini")
1040
+ if not validation["allowed"]:
1041
+ print(f"Write blocked: {validation['reason']}")
1042
+ ```
1043
+
1044
+ **ストレージ**: デフォルトは `~/.synapse/file_safety.db` (SQLite)。`SYNAPSE_FILE_SAFETY_DB_PATH` で変更可能(例: `./.synapse/file_safety.db` でプロジェクト単位)。
1045
+
1046
+ 詳細は [docs/file-safety.md](docs/file-safety.md) を参照してください。
1047
+
1048
+ ---
1049
+
1050
+ ## テスト
1051
+
1052
+ 218 のテストケースで A2A プロトコル準拠を検証:
1053
+
1054
+ ```bash
1055
+ # 全テスト
1056
+ pytest
1057
+
1058
+ # 特定カテゴリ
1059
+ pytest tests/test_a2a_compat.py -v
1060
+ pytest tests/test_sender_identification.py -v
1061
+ ```
1062
+
1063
+ ---
1064
+
1065
+ ## 設定ファイル (.synapse)
1066
+
1067
+ `.synapse/settings.json` を使って、環境変数や初期インストラクションをカスタマイズできます。
1068
+
1069
+ ### スコープ
1070
+
1071
+ | スコープ | パス | 優先度 |
1072
+ |----------|------|--------|
1073
+ | User | `~/.synapse/settings.json` | 低 |
1074
+ | Project | `./.synapse/settings.json` | 中 |
1075
+ | Local | `./.synapse/settings.local.json` | 高(gitignore推奨) |
1076
+
1077
+ 高優先度の設定が低優先度を上書きします。
1078
+
1079
+ ### セットアップ
1080
+
1081
+ ```bash
1082
+ # 設定ファイルを作成
1083
+ synapse init
1084
+
1085
+ # ? Where do you want to create settings.json?
1086
+ # ❯ User scope (~/.synapse/settings.json)
1087
+ # Project scope (./.synapse/settings.json)
1088
+
1089
+ # デフォルトに戻す
1090
+ synapse reset
1091
+ ```
1092
+
1093
+ **Skills のインストール**: Claude Code を使用する場合、**プラグイン marketplace からのインストールを強く推奨します**。これにより、最新のスキルと機能(File Safety, Delegation など)が適用されます。
1094
+
1095
+ ```bash
1096
+ # Claude Code 内で実行
1097
+ /plugin marketplace add s-hiraoku/synapse-a2a
1098
+ /plugin install synapse-a2a@s-hiraoku/synapse-a2a
1099
+ ```
1100
+
1101
+ > **Note**: `synapse init` は設定ファイルの初期化(`env`, `instructions`, `resume_flags`, `delegation`)を行います。Codex はプラグインに対応していないため、`synapse init` は `.claude/skills/synapse-a2a/` から `.codex/skills/synapse-a2a/` へスキルを自動コピーします。(Gemini は Skills 非対応のためスキップ)
1102
+
1103
+ ### settings.json の構造
1104
+
1105
+ ```json
1106
+ {
1107
+ "env": {
1108
+ "SYNAPSE_HISTORY_ENABLED": "true",
1109
+ "SYNAPSE_FILE_SAFETY_ENABLED": "true",
1110
+ "SYNAPSE_FILE_SAFETY_DB_PATH": ".synapse/file_safety.db",
1111
+ "SYNAPSE_AUTH_ENABLED": "false",
1112
+ "SYNAPSE_API_KEYS": "",
1113
+ "SYNAPSE_ADMIN_KEY": "",
1114
+ "SYNAPSE_ALLOW_LOCALHOST": "true",
1115
+ "SYNAPSE_USE_HTTPS": "false",
1116
+ "SYNAPSE_WEBHOOK_SECRET": "",
1117
+ "SYNAPSE_WEBHOOK_TIMEOUT": "10",
1118
+ "SYNAPSE_WEBHOOK_MAX_RETRIES": "3"
1119
+ },
1120
+ "instructions": {
1121
+ "default": "[SYNAPSE INSTRUCTIONS...]\n...",
1122
+ "claude": "",
1123
+ "gemini": "",
1124
+ "codex": ""
1125
+ },
1126
+ "a2a": {
1127
+ "flow": "auto"
1128
+ },
1129
+ "delegation": {
1130
+ "enabled": false
1131
+ }
1132
+ }
1133
+ ```
1134
+
1135
+ ### 環境変数 (env)
1136
+
1137
+ | 変数 | 説明 | デフォルト |
1138
+ |------|------|-----------|
1139
+ | `SYNAPSE_HISTORY_ENABLED` | タスク履歴を有効化 | `false` |
1140
+ | `SYNAPSE_FILE_SAFETY_ENABLED` | ファイル安全機能を有効化 | `false` |
1141
+ | `SYNAPSE_FILE_SAFETY_DB_PATH` | file-safety DB パス | `~/.synapse/file_safety.db` |
1142
+ | `SYNAPSE_AUTH_ENABLED` | API認証を有効化 | `false` |
1143
+ | `SYNAPSE_API_KEYS` | APIキー(カンマ区切り) | - |
1144
+ | `SYNAPSE_ADMIN_KEY` | 管理者キー | - |
1145
+ | `SYNAPSE_ALLOW_LOCALHOST` | localhost認証スキップ | `true` |
1146
+ | `SYNAPSE_USE_HTTPS` | HTTPS使用 | `false` |
1147
+ | `SYNAPSE_WEBHOOK_SECRET` | Webhookシークレット | - |
1148
+ | `SYNAPSE_WEBHOOK_TIMEOUT` | Webhookタイムアウト(秒) | `10` |
1149
+ | `SYNAPSE_WEBHOOK_MAX_RETRIES` | Webhookリトライ数 | `3` |
1150
+
1151
+ ### A2A 通信設定 (a2a)
1152
+
1153
+ エージェント間通信の動作を制御します。
1154
+
1155
+ | 設定 | 値 | 説明 |
1156
+ |------|-----|------|
1157
+ | `flow` | `roundtrip` | 常に結果を待つ |
1158
+ | `flow` | `oneway` | 常に転送のみ(結果を待たない) |
1159
+ | `flow` | `auto` | AIエージェントがタスクに応じて判断(デフォルト) |
1160
+
1161
+ ```json
1162
+ {
1163
+ "a2a": {
1164
+ "flow": "auto"
1165
+ }
1166
+ }
1167
+ ```
1168
+
1169
+ ### 委任設定 (delegation)
1170
+
1171
+ 自動タスク委任を制御します。
1172
+
1173
+ | 設定 | 値 | 説明 |
1174
+ |------|-----|------|
1175
+ | `enabled` | `true` | `.synapse/delegate.md` を読み込み、委任ルールを有効化 |
1176
+ | `enabled` | `false` | 委任を無効化(デフォルト) |
1177
+
1178
+ ```json
1179
+ {
1180
+ "delegation": {
1181
+ "enabled": true
1182
+ }
1183
+ }
1184
+ ```
1185
+
1186
+ 委任を有効にするには、`.synapse/delegate.md` に委任ルールを記述してください。
1187
+
1188
+ ### 初期インストラクション (instructions)
1189
+
1190
+ エージェント起動時に送信される指示をカスタマイズできます。
1191
+
1192
+ ```json
1193
+ {
1194
+ "instructions": {
1195
+ "default": "全エージェント共通の指示",
1196
+ "claude": "Claude専用の指示(設定時はdefaultより優先)",
1197
+ "gemini": "Gemini専用の指示",
1198
+ "codex": "Codex専用の指示"
1199
+ }
1200
+ }
1201
+ ```
1202
+
1203
+ **優先順位**:
1204
+ 1. エージェント固有の設定(`claude`, `gemini`, `codex`)があればそれを使用
1205
+ 2. なければ `default` を使用
1206
+ 3.両方とも空なら初期インストラクションは送信しない
1207
+
1208
+ **プレースホルダー**:
1209
+ - `{{agent_id}}` - エージェントID(例: `synapse-claude-8100`)
1210
+ - `{{port}}` - ポート番号(例: `8100`)
1211
+
1212
+ 詳細は [guides/settings.md](guides/settings.md) を参照してください。
1213
+
1214
+ ---
1215
+
1216
+ ## 開発・リリース
1217
+
1218
+ ### PyPI への公開
1219
+
1220
+ タグをプッシュすると GitHub Actions で自動的に PyPI へ公開されます。
1221
+
1222
+ ```bash
1223
+ # 1. pyproject.toml のバージョンを更新
1224
+ # version = "0.2.0"
1225
+
1226
+ # 2. タグを作成してプッシュ
1227
+ git tag v0.2.0
1228
+ git push origin v0.2.0
1229
+ ```
1230
+
1231
+ ### 手動公開
1232
+
1233
+ ```bash
1234
+ # uv でビルド・公開
1235
+ uv build
1236
+ uv publish
1237
+ ```
1238
+
1239
+ ### ユーザーのインストール方法
1240
+
1241
+ ```bash
1242
+ # pipx(推奨)
1243
+ pipx install synapse-a2a
1244
+
1245
+ # または pip
1246
+ pip install synapse-a2a
1247
+
1248
+ # uvx で直接実行
1249
+ uvx synapse-a2a claude
1250
+ ```
1251
+
1252
+ ---
1253
+
1254
+ ## 既知の制約
1255
+
1256
+ - **TUI 描画**: Ink ベースの CLI で描画が乱れる場合あり
1257
+ - **PTY 制限**: 一部の特殊入力シーケンスは未対応
1258
+
1259
+ ---
1260
+
1261
+ ## エンタープライズ機能
1262
+
1263
+ 本番環境向けのセキュリティ・通知・高性能通信機能を提供します。
1264
+
1265
+ ### API Key 認証
1266
+
1267
+ ```bash
1268
+ # 認証を有効にして起動
1269
+ export SYNAPSE_AUTH_ENABLED=true
1270
+ export SYNAPSE_API_KEYS=my-secret-key
1271
+ synapse claude
1272
+
1273
+ # API Key でリクエスト
1274
+ curl -H "X-API-Key: my-secret-key" http://localhost:8100/tasks
1275
+ ```
1276
+
1277
+ ### Webhook 通知
1278
+
1279
+ タスク完了時に外部 URL へ通知を送信します。
1280
+
1281
+ ```bash
1282
+ # Webhook を登録
1283
+ curl -X POST http://localhost:8100/webhooks \
1284
+ -H "Content-Type: application/json" \
1285
+ -d '{"url": "https://your-server.com/hook", "events": ["task.completed"]}'
1286
+ ```
1287
+
1288
+ | イベント | 説明 |
1289
+ |---------|------|
1290
+ | `task.completed` | タスク正常完了 |
1291
+ | `task.failed` | タスク失敗 |
1292
+ | `task.canceled` | タスクキャンセル |
1293
+
1294
+ ### SSE ストリーミング
1295
+
1296
+ リアルタイムでタスク出力を受信できます。
1297
+
1298
+ ```bash
1299
+ curl -N http://localhost:8100/tasks/{task_id}/subscribe
1300
+ ```
1301
+
1302
+ イベントタイプ:
1303
+
1304
+ | イベント | 説明 |
1305
+ |---------|------|
1306
+ | `output` | 新しい CLI 出力 |
1307
+ | `status` | ステータス変更 |
1308
+ | `done` | タスク完了(Artifact 含む) |
1309
+
1310
+ ### 出力解析
1311
+
1312
+ CLI 出力を自動解析し、エラー検出・ステータス更新・Artifact 生成を行います。
1313
+
1314
+ ```bash
1315
+ # エラー検出 → 自動的に failed ステータス
1316
+ # input_required 検出 → 追加入力待ち状態
1317
+ # 出力パース → コードブロック・ファイル参照を Artifact に変換
1318
+ ```
1319
+
1320
+ | 機能 | 説明 |
1321
+ |------|------|
1322
+ | エラー検出 | `command not found`, `permission denied` 等を検出 |
1323
+ | input_required | 質問・確認プロンプトを検出 |
1324
+ | 出力パーサー | コード/ファイル/エラーを構造化 |
1325
+
1326
+ ### gRPC サポート
1327
+
1328
+ 高性能通信が必要な場合は gRPC を使用できます。
1329
+
1330
+ ```bash
1331
+ # gRPC 依存をインストール
1332
+ pip install synapse-a2a[grpc]
1333
+
1334
+ # gRPC は REST ポート + 1 で起動
1335
+ # REST: 8100 → gRPC: 8101
1336
+ ```
1337
+
1338
+ 詳細は [guides/enterprise.md](guides/enterprise.md) を参照してください。
1339
+
1340
+ ---
1341
+
1342
+ ## ドキュメント
1343
+
1344
+ | パス | 内容 |
1345
+ | -------------------------------------------------------- | ---------------------- |
1346
+ | [guides/usage.md](guides/usage.md) | 使い方詳細 |
1347
+ | [guides/architecture.md](guides/architecture.md) | アーキテクチャ詳細 |
1348
+ | [guides/enterprise.md](guides/enterprise.md) | エンタープライズ機能 |
1349
+ | [guides/troubleshooting.md](guides/troubleshooting.md) | トラブルシューティング |
1350
+ | [guides/delegation.md](guides/delegation.md) | タスク委任ガイド |
1351
+ | [docs/file-safety.md](docs/file-safety.md) | ファイル競合防止機能 |
1352
+ | [docs/project-philosophy.md](docs/project-philosophy.md) | 設計思想 |
1353
+
1354
+ ---
1355
+
1356
+ ## ライセンス
1357
+
1358
+ MIT License
1359
+
1360
+ ---
1361
+
1362
+ ## 関連リンク
1363
+
1364
+ - [Claude Code](https://claude.ai/code) - Anthropic の CLI エージェント
1365
+ - [Google A2A Protocol](https://github.com/google/A2A) - Agent-to-Agent プロトコル