LLMOrchestrator/ARCHITECTURE.html at master · HelixDevelopment/LLMOrchestrator · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
  <meta charset="utf-8" />
  <meta name="generator" content="pandoc" />
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" />
  <title>ARCHITECTURE</title>
  <style>

html {
color: #1a1a1a;
background-color: #fdfdfd;
}
body {
margin: 0 auto;
max-width: 36em;
padding-left: 50px;
padding-right: 50px;
padding-top: 50px;
padding-bottom: 50px;
hyphens: auto;
overflow-wrap: break-word;
text-rendering: optimizeLegibility;
font-kerning: normal;
}
@media (max-width: 600px) {
body {
font-size: 0.9em;
padding: 12px;
}
h1 {
font-size: 1.8em;
}
}
@media print {
html {
background-color: white;
}
body {
background-color: transparent;
color: black;
font-size: 12pt;
}
p, h2, h3 {
orphans: 3;
widows: 3;
}
h2, h3, h4 {
page-break-after: avoid;
}
}
p {
margin: 1em 0;
}
a {
color: #1a1a1a;
}
a:visited {
color: #1a1a1a;
}
img {
max-width: 100%;
}
svg {
height: auto;
max-width: 100%;
}
h1, h2, h3, h4, h5, h6 {
margin-top: 1.4em;
}
h5, h6 {
font-size: 1em;
font-style: italic;
}
h6 {
font-weight: normal;
}
ol, ul {
padding-left: 1.7em;
margin-top: 1em;
}
li > ol, li > ul {
margin-top: 0;
}
blockquote {
margin: 1em 0 1em 1.7em;
padding-left: 1em;
border-left: 2px solid #e6e6e6;
color: #606060;
}
code {
font-family: Menlo, Monaco, Consolas, 'Lucida Console', monospace;
font-size: 85%;
margin: 0;
hyphens: manual;
}
pre {
margin: 1em 0;
overflow: auto;
}
pre code {
padding: 0;
overflow: visible;
overflow-wrap: normal;
}
.sourceCode {
background-color: transparent;
overflow: visible;
}
hr {
border: none;
border-top: 1px solid #1a1a1a;
height: 1px;
margin: 1em 0;
}
table {
margin: 1em 0;
border-collapse: collapse;
width: 100%;
overflow-x: auto;
display: block;
font-variant-numeric: lining-nums tabular-nums;
}
table caption {
margin-bottom: 0.75em;
}
tbody {
margin-top: 0.5em;
border-top: 1px solid #1a1a1a;
border-bottom: 1px solid #1a1a1a;
}
th {
border-top: 1px solid #1a1a1a;
padding: 0.25em 0.5em 0.25em 0.5em;
}
td {
padding: 0.125em 0.5em 0.25em 0.5em;
}
header {
margin-bottom: 4em;
text-align: center;
}
#TOC li {
list-style: none;
}
#TOC ul {
padding-left: 1.3em;
}
#TOC > ul {
padding-left: 0;
}
#TOC a:not(:hover) {
text-decoration: none;
}
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}

ul.task-list[class]{list-style: none;}
ul.task-list li input[type="checkbox"] {
font-size: inherit;
width: 0.8em;
margin: 0 0.8em 0.2em -1.6em;
vertical-align: middle;
}
.display.math{display: block; text-align: center; margin: 0.5rem auto;}
</style>
</head>
<body>
<header id="title-block-header">
<h1 class="title">ARCHITECTURE</h1>
</header>
<h1 id="architecture">Architecture</h1>
<h2 id="component-diagram">Component Diagram</h2>
<pre class="mermaid"><code>graph TB
    subgraph LLMOrchestrator
        Pool[AgentPool]
        HM[HealthMonitor]
        CB[CircuitBreaker]

        subgraph Adapters
            OC[OpenCodeAgent]
            CC[ClaudeCodeAgent]
            GEM[GeminiAgent]
            JUN[JunieAgent]
            QW[QwenCodeAgent]
        end

        BA[BaseAdapter]
        PT[PipeTransport]
        FT[FileTransport]
        RP[ResponseParser]
        CFG[Config]
    end

    Pool --&gt; HM
    HM --&gt; CB
    OC --&gt; BA
    CC --&gt; BA
    GEM --&gt; BA
    JUN --&gt; BA
    QW --&gt; BA
    BA --&gt; PT
    BA --&gt; RP
    BA --&gt; FT
    CFG --&gt; Pool</code></pre>
<h2 id="sequence-diagram-agent-send">Sequence Diagram: Agent Send</h2>
<pre class="mermaid"><code>sequenceDiagram
    participant C as Caller
    participant P as AgentPool
    participant A as Agent (Adapter)
    participant CB as CircuitBreaker
    participant T as PipeTransport
    participant CLI as CLI Process

    C-&gt;&gt;P: Acquire(ctx, requirements)
    P-&gt;&gt;P: findAvailable(requirements)
    P--&gt;&gt;C: agent
    C-&gt;&gt;A: Send(ctx, prompt)
    A-&gt;&gt;CB: AllowRequest()
    CB--&gt;&gt;A: true
    A-&gt;&gt;T: SendPrompt(ctx, id, prompt, &quot;&quot;)
    T-&gt;&gt;CLI: JSON-line via stdin
    CLI--&gt;&gt;T: JSON-line via stdout
    T--&gt;&gt;A: PipeMessage
    A-&gt;&gt;CB: RecordSuccess()
    A--&gt;&gt;C: Response
    C-&gt;&gt;P: Release(agent)</code></pre>
<h2 id="class-diagram">Class Diagram</h2>
<pre class="mermaid"><code>classDiagram
    class Agent {
        &lt;&lt;interface&gt;&gt;
        +ID() string
        +Name() string
        +Start(ctx) error
        +Stop(ctx) error
        +IsRunning() bool
        +Health(ctx) HealthStatus
        +Send(ctx, prompt) Response, error
        +SendStream(ctx, prompt) chan StreamChunk, error
        +SendWithAttachments(ctx, prompt, attachments) Response, error
        +OutputDir() string
        +Capabilities() AgentCapabilities
        +SupportsVision() bool
        +ModelInfo() ModelInfo
    }

    class BaseAdapter {
        -id string
        -name string
        -config AdapterConfig
        -transport PipeTransport
        -breaker CircuitBreaker
        +Start(ctx) error
        +Stop(ctx) error
        +Send(ctx, prompt) Response, error
    }

    class AgentPool {
        &lt;&lt;interface&gt;&gt;
        +Register(agent) error
        +Acquire(ctx, requirements) Agent, error
        +Release(agent)
        +Available() []Agent
        +HealthCheck(ctx) []HealthStatus
        +Shutdown(ctx) error
    }

    Agent &lt;|.. BaseAdapter
    BaseAdapter &lt;|-- OpenCodeAgent
    BaseAdapter &lt;|-- ClaudeCodeAgent
    BaseAdapter &lt;|-- GeminiAgent
    BaseAdapter &lt;|-- JunieAgent
    BaseAdapter &lt;|-- QwenCodeAgent</code></pre>
<h2 id="state-diagram-circuit-breaker">State Diagram: Circuit
Breaker</h2>
<pre class="mermaid"><code>stateDiagram-v2
    [*] --&gt; Closed
    Closed --&gt; Open : N consecutive failures
    Open --&gt; HalfOpen : Recovery timeout elapsed
    HalfOpen --&gt; Closed : Success
    HalfOpen --&gt; Open : Failure
    Closed --&gt; Closed : Success (reset counter)</code></pre>
<h2 id="flowchart-agent-acquisition">Flowchart: Agent Acquisition</h2>
<pre class="mermaid"><code>flowchart TD
    A[Acquire Request] --&gt; B{Pool Shutdown?}
    B --&gt;|Yes| C[Return ErrPoolShutdown]
    B --&gt;|No| D{Context Cancelled?}
    D --&gt;|Yes| E[Return ctx.Err]
    D --&gt;|No| F{Preferred Agent Available?}
    F --&gt;|Yes| G{Meets Requirements?}
    G --&gt;|Yes| H[Return Preferred Agent]
    G --&gt;|No| I{Any Agent Meets Requirements?}
    F --&gt;|No| I
    I --&gt;|Yes| J[Return Matching Agent]
    I --&gt;|No| K[Wait on Condition Variable]
    K --&gt; B</code></pre>
<h2 id="key-design-decisions">Key Design Decisions</h2>
<ol type="1">
<li><p><strong>BaseAdapter Pattern</strong>: Shared process management
(spawn, pipe, shutdown) in BaseAdapter. Each CLI adapter only implements
protocol-specific response parsing.</p></li>
<li><p><strong>Thread-safe Pool</strong>: Uses <code>sync.Mutex</code> +
<code>sync.Cond</code> for blocking acquire with context cancellation
support.</p></li>
<li><p><strong>Circuit Breaker</strong>: Per-agent, 3 consecutive
failures opens the circuit for 60 seconds. Half-open state allows probe
requests.</p></li>
<li><p><strong>Hybrid Communication</strong>: Real-time pipe for
interactive prompts, file-based for large artifacts. Prevents blocking
on large payloads.</p></li>
<li><p><strong>No Module Dependencies</strong>: LLMOrchestrator defines
its own types (ModelInfo, etc.) and does not import LLMsVerifier,
VisionEngine, or DocProcessor. HelixQA bridges them.</p></li>
</ol>
</body>
</html>