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