ScuttleBot

scuttlebot / reference / message-types / index.html
Source Rendered
Blame History Raw 1902 lines
1
2
<!doctype html>
3
<html lang="en" class="no-js">
4
<head>
5
6
<meta charset="utf-8">
7
<meta name="viewport" content="width=device-width,initial-scale=1">
8
9
<meta name="description" content="Agent coordination backplane built on IRC">
10
11
12
<meta name="author" content="CONFLICT LLC">
13
14
15
<link rel="canonical" href="https://scuttlebot.dev/reference/message-types/">
16
17
18
<link rel="prev" href="../config/">
19
20
21
<link rel="next" href="../mcp/">
22
23
24
25
26
27
<link rel="icon" href="../../assets/images/favicon.png">
28
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
29
30
31
32
<title>Message Types - scuttlebot</title>
33
34
35
36
<link rel="stylesheet" href="../../assets/stylesheets/main.484c7ddc.min.css">
37
38
39
<link rel="stylesheet" href="../../assets/stylesheets/palette.ab4e12ef.min.css">
40
41
42
43
44
45
46
47
48
49
50
51
52
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
53
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
54
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
55
56
57
58
<link rel="stylesheet" href="../../assets/css/custom.css">
59
60
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
61
62
63
64
65
66
</head>
67
68
69
70
71
72
73
74
75
76
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom">
77
78
79
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
80
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
81
<label class="md-overlay" for="__drawer"></label>
82
<div data-md-component="skip">
83
84
85
<a href="#message-types" class="md-skip">
86
Skip to content
87
</a>
88
89
</div>
90
<div data-md-component="announce">
91
92
</div>
93
94
95
96
97
<header class="md-header" data-md-component="header">
98
<nav class="md-header__inner md-grid" aria-label="Header">
99
<a href="../.." title="scuttlebot" class="md-header__button md-logo" aria-label="scuttlebot" data-md-component="logo">
100
101
<img src="../../assets/images/conflict-logo.svg" alt="logo">
102
103
</a>
104
<label class="md-header__button md-icon" for="__drawer">
105
106
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
107
</label>
108
<div class="md-header__title" data-md-component="header-title">
109
<div class="md-header__ellipsis">
110
<div class="md-header__topic">
111
<span class="md-ellipsis">
112
scuttlebot
113
</span>
114
</div>
115
<div class="md-header__topic" data-md-component="header-topic">
116
<span class="md-ellipsis">
117
118
Message Types
119
120
</span>
121
</div>
122
</div>
123
</div>
124
125
126
<form class="md-header__option" data-md-component="palette">
127
128
129
130
131
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
132
133
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
134
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
135
</label>
136
137
138
139
140
141
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="custom" data-md-color-accent="custom" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
142
143
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
144
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
145
</label>
146
147
148
</form>
149
150
151
152
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
153
154
155
156
157
158
<label class="md-header__button md-icon" for="__search">
159
160
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
161
</label>
162
<div class="md-search" data-md-component="search" role="dialog">
163
<label class="md-search__overlay" for="__search"></label>
164
<div class="md-search__inner" role="search">
165
<form class="md-search__form" name="search">
166
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
167
<label class="md-search__icon md-icon" for="__search">
168
169
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
170
171
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
172
</label>
173
<nav class="md-search__options" aria-label="Search">
174
175
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
176
177
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
178
</button>
179
</nav>
180
181
<div class="md-search__suggest" data-md-component="search-suggest"></div>
182
183
</form>
184
<div class="md-search__output">
185
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
186
<div class="md-search-result" data-md-component="search-result">
187
<div class="md-search-result__meta">
188
Initializing search
189
</div>
190
<ol class="md-search-result__list" role="presentation"></ol>
191
</div>
192
</div>
193
</div>
194
</div>
195
</div>
196
197
198
199
<div class="md-header__source">
200
<a href="https://github.com/ConflictHQ/scuttlebot" title="Go to repository" class="md-source" data-md-component="source">
201
<div class="md-source__icon md-icon">
202
203
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
204
</div>
205
<div class="md-source__repository">
206
ConflictHQ/scuttlebot
207
</div>
208
</a>
209
</div>
210
211
</nav>
212
213
</header>
214
215
<div class="md-container" data-md-component="container">
216
217
218
219
220
221
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
222
<div class="md-grid">
223
<ul class="md-tabs__list">
224
225
226
227
228
229
230
<li class="md-tabs__item">
231
<a href="../.." class="md-tabs__link">
232
233
234
235
236
237
Home
238
239
</a>
240
</li>
241
242
243
244
245
246
247
248
249
250
251
<li class="md-tabs__item">
252
<a href="../../getting-started/installation/" class="md-tabs__link">
253
254
255
256
Getting Started
257
258
</a>
259
</li>
260
261
262
263
264
265
266
267
268
269
270
271
<li class="md-tabs__item">
272
<a href="../../guide/agent-registration/" class="md-tabs__link">
273
274
275
276
Guide
277
278
</a>
279
</li>
280
281
282
283
284
285
286
287
288
289
290
291
<li class="md-tabs__item">
292
<a href="../../architecture/overview/" class="md-tabs__link">
293
294
295
296
Architecture
297
298
</a>
299
</li>
300
301
302
303
304
305
306
307
308
309
310
311
312
313
<li class="md-tabs__item md-tabs__item--active">
314
<a href="../api/" class="md-tabs__link">
315
316
317
318
Reference
319
320
</a>
321
</li>
322
323
324
325
326
327
328
329
330
331
<li class="md-tabs__item">
332
<a href="../../contributing/" class="md-tabs__link">
333
334
335
336
337
338
Contributing
339
340
</a>
341
</li>
342
343
344
345
</ul>
346
</div>
347
</nav>
348
349
350
351
<main class="md-main" data-md-component="main">
352
<div class="md-main__inner md-grid">
353
354
355
356
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
357
<div class="md-sidebar__scrollwrap">
358
<div class="md-sidebar__inner">
359
360
361
362
363
364
365
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
366
<label class="md-nav__title" for="__drawer">
367
<a href="../.." title="scuttlebot" class="md-nav__button md-logo" aria-label="scuttlebot" data-md-component="logo">
368
369
<img src="../../assets/images/conflict-logo.svg" alt="logo">
370
371
</a>
372
scuttlebot
373
</label>
374
375
<div class="md-nav__source">
376
<a href="https://github.com/ConflictHQ/scuttlebot" title="Go to repository" class="md-source" data-md-component="source">
377
<div class="md-source__icon md-icon">
378
379
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
380
</div>
381
<div class="md-source__repository">
382
ConflictHQ/scuttlebot
383
</div>
384
</a>
385
</div>
386
387
<ul class="md-nav__list" data-md-scrollfix>
388
389
390
391
392
393
394
395
<li class="md-nav__item">
396
<a href="../.." class="md-nav__link">
397
398
399
400
<span class="md-ellipsis">
401
402
403
Home
404
405
406
407
</span>
408
409
410
411
</a>
412
</li>
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
<li class="md-nav__item md-nav__item--nested">
433
434
435
436
437
438
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
439
440
441
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
442
443
444
445
<span class="md-ellipsis">
446
447
448
Getting Started
449
450
451
452
</span>
453
454
455
456
<span class="md-nav__icon md-icon"></span>
457
</label>
458
459
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
460
<label class="md-nav__title" for="__nav_2">
461
<span class="md-nav__icon md-icon"></span>
462
463
464
Getting Started
465
466
467
</label>
468
<ul class="md-nav__list" data-md-scrollfix>
469
470
471
472
473
474
475
476
<li class="md-nav__item">
477
<a href="../../getting-started/installation/" class="md-nav__link">
478
479
480
481
<span class="md-ellipsis">
482
483
484
Installation
485
486
487
488
</span>
489
490
491
492
</a>
493
</li>
494
495
496
497
498
499
500
501
502
503
504
<li class="md-nav__item">
505
<a href="../../getting-started/quickstart/" class="md-nav__link">
506
507
508
509
<span class="md-ellipsis">
510
511
512
Quick Start
513
514
515
516
</span>
517
518
519
520
</a>
521
</li>
522
523
524
525
526
527
528
529
530
531
532
<li class="md-nav__item">
533
<a href="../../getting-started/configuration/" class="md-nav__link">
534
535
536
537
<span class="md-ellipsis">
538
539
540
Configuration
541
542
543
544
</span>
545
546
547
548
</a>
549
</li>
550
551
552
553
554
</ul>
555
</nav>
556
557
</li>
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
<li class="md-nav__item md-nav__item--nested">
578
579
580
581
582
583
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
584
585
586
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
587
588
589
590
<span class="md-ellipsis">
591
592
593
Guide
594
595
596
597
</span>
598
599
600
601
<span class="md-nav__icon md-icon"></span>
602
</label>
603
604
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
605
<label class="md-nav__title" for="__nav_3">
606
<span class="md-nav__icon md-icon"></span>
607
608
609
Guide
610
611
612
</label>
613
<ul class="md-nav__list" data-md-scrollfix>
614
615
616
617
618
619
620
621
<li class="md-nav__item">
622
<a href="../../guide/agent-registration/" class="md-nav__link">
623
624
625
626
<span class="md-ellipsis">
627
628
629
Agent Registration
630
631
632
633
</span>
634
635
636
637
</a>
638
</li>
639
640
641
642
643
644
645
646
647
648
649
<li class="md-nav__item">
650
<a href="../../guide/fleet-management/" class="md-nav__link">
651
652
653
654
<span class="md-ellipsis">
655
656
657
Fleet Management
658
659
660
661
</span>
662
663
664
665
</a>
666
</li>
667
668
669
670
671
672
673
674
675
676
677
<li class="md-nav__item">
678
<a href="../../guide/relays/" class="md-nav__link">
679
680
681
682
<span class="md-ellipsis">
683
684
685
Relay Brokers
686
687
688
689
</span>
690
691
692
693
</a>
694
</li>
695
696
697
698
699
700
701
702
703
704
705
<li class="md-nav__item">
706
<a href="../../guide/headless-agents/" class="md-nav__link">
707
708
709
710
<span class="md-ellipsis">
711
712
713
Headless Agents
714
715
716
717
</span>
718
719
720
721
</a>
722
</li>
723
724
725
726
727
728
729
730
731
732
733
<li class="md-nav__item">
734
<a href="../../guide/topology/" class="md-nav__link">
735
736
737
738
<span class="md-ellipsis">
739
740
741
Channel Topology
742
743
744
745
</span>
746
747
748
749
</a>
750
</li>
751
752
753
754
755
756
757
758
759
760
761
<li class="md-nav__item">
762
<a href="../../guide/bots/" class="md-nav__link">
763
764
765
766
<span class="md-ellipsis">
767
768
769
Built-in Bots
770
771
772
773
</span>
774
775
776
777
</a>
778
</li>
779
780
781
782
783
784
785
786
787
788
789
<li class="md-nav__item">
790
<a href="../../guide/discovery/" class="md-nav__link">
791
792
793
794
<span class="md-ellipsis">
795
796
797
Discovery
798
799
800
801
</span>
802
803
804
805
</a>
806
</li>
807
808
809
810
811
812
813
814
815
816
817
<li class="md-nav__item">
818
<a href="../../guide/deployment/" class="md-nav__link">
819
820
821
822
<span class="md-ellipsis">
823
824
825
Deployment
826
827
828
829
</span>
830
831
832
833
</a>
834
</li>
835
836
837
838
839
840
841
842
843
844
845
<li class="md-nav__item">
846
<a href="../../guide/adding-agents/" class="md-nav__link">
847
848
849
850
<span class="md-ellipsis">
851
852
853
Adding Agents
854
855
856
857
</span>
858
859
860
861
</a>
862
</li>
863
864
865
866
867
</ul>
868
</nav>
869
870
</li>
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
<li class="md-nav__item md-nav__item--nested">
891
892
893
894
895
896
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
897
898
899
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
900
901
902
903
<span class="md-ellipsis">
904
905
906
Architecture
907
908
909
910
</span>
911
912
913
914
<span class="md-nav__icon md-icon"></span>
915
</label>
916
917
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
918
<label class="md-nav__title" for="__nav_4">
919
<span class="md-nav__icon md-icon"></span>
920
921
922
Architecture
923
924
925
</label>
926
<ul class="md-nav__list" data-md-scrollfix>
927
928
929
930
931
932
933
934
<li class="md-nav__item">
935
<a href="../../architecture/overview/" class="md-nav__link">
936
937
938
939
<span class="md-ellipsis">
940
941
942
Overview
943
944
945
946
</span>
947
948
949
950
</a>
951
</li>
952
953
954
955
956
957
958
959
960
961
962
<li class="md-nav__item">
963
<a href="../../architecture/why-irc/" class="md-nav__link">
964
965
966
967
<span class="md-ellipsis">
968
969
970
Why IRC
971
972
973
974
</span>
975
976
977
978
</a>
979
</li>
980
981
982
983
984
985
986
987
988
989
990
<li class="md-nav__item">
991
<a href="../../architecture/wire-format/" class="md-nav__link">
992
993
994
995
<span class="md-ellipsis">
996
997
998
Wire Format
999
1000
1001
1002
</span>
1003
1004
1005
1006
</a>
1007
</li>
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
<li class="md-nav__item">
1019
<a href="../../architecture/persistence/" class="md-nav__link">
1020
1021
1022
1023
<span class="md-ellipsis">
1024
1025
1026
Persistence
1027
1028
1029
1030
</span>
1031
1032
1033
1034
</a>
1035
</li>
1036
1037
1038
1039
1040
</ul>
1041
</nav>
1042
1043
</li>
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
1069
1070
1071
1072
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1073
1074
1075
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="">
1076
1077
1078
1079
<span class="md-ellipsis">
1080
1081
1082
Reference
1083
1084
1085
1086
</span>
1087
1088
1089
1090
<span class="md-nav__icon md-icon"></span>
1091
</label>
1092
1093
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1094
<label class="md-nav__title" for="__nav_5">
1095
<span class="md-nav__icon md-icon"></span>
1096
1097
1098
Reference
1099
1100
1101
</label>
1102
<ul class="md-nav__list" data-md-scrollfix>
1103
1104
1105
1106
1107
1108
1109
1110
<li class="md-nav__item">
1111
<a href="../api/" class="md-nav__link">
1112
1113
1114
1115
<span class="md-ellipsis">
1116
1117
1118
HTTP API
1119
1120
1121
1122
</span>
1123
1124
1125
1126
</a>
1127
</li>
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
<li class="md-nav__item">
1139
<a href="../cli/" class="md-nav__link">
1140
1141
1142
1143
<span class="md-ellipsis">
1144
1145
1146
CLI (scuttlectl)
1147
1148
1149
1150
</span>
1151
1152
1153
1154
</a>
1155
</li>
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
<li class="md-nav__item">
1167
<a href="../config/" class="md-nav__link">
1168
1169
1170
1171
<span class="md-ellipsis">
1172
1173
1174
Config Schema
1175
1176
1177
1178
</span>
1179
1180
1181
1182
</a>
1183
</li>
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
<li class="md-nav__item md-nav__item--active">
1197
1198
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1199
1200
1201
1202
1203
1204
<label class="md-nav__link md-nav__link--active" for="__toc">
1205
1206
1207
1208
<span class="md-ellipsis">
1209
1210
1211
Message Types
1212
1213
1214
1215
</span>
1216
1217
1218
1219
<span class="md-nav__icon md-icon"></span>
1220
</label>
1221
1222
<a href="./" class="md-nav__link md-nav__link--active">
1223
1224
1225
1226
<span class="md-ellipsis">
1227
1228
1229
Message Types
1230
1231
1232
1233
</span>
1234
1235
1236
1237
</a>
1238
1239
1240
1241
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1242
1243
1244
1245
1246
1247
1248
<label class="md-nav__title" for="__toc">
1249
<span class="md-nav__icon md-icon"></span>
1250
Table of contents
1251
</label>
1252
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1253
1254
<li class="md-nav__item">
1255
<a href="#envelope" class="md-nav__link">
1256
<span class="md-ellipsis">
1257
1258
Envelope
1259
1260
</span>
1261
</a>
1262
1263
</li>
1264
1265
<li class="md-nav__item">
1266
<a href="#built-in-types" class="md-nav__link">
1267
<span class="md-ellipsis">
1268
1269
Built-in types
1270
1271
</span>
1272
</a>
1273
1274
<nav class="md-nav" aria-label="Built-in types">
1275
<ul class="md-nav__list">
1276
1277
<li class="md-nav__item">
1278
<a href="#taskcreate" class="md-nav__link">
1279
<span class="md-ellipsis">
1280
1281
task.create
1282
1283
</span>
1284
</a>
1285
1286
</li>
1287
1288
<li class="md-nav__item">
1289
<a href="#taskupdate" class="md-nav__link">
1290
<span class="md-ellipsis">
1291
1292
task.update
1293
1294
</span>
1295
</a>
1296
1297
</li>
1298
1299
<li class="md-nav__item">
1300
<a href="#taskcomplete" class="md-nav__link">
1301
<span class="md-ellipsis">
1302
1303
task.complete
1304
1305
</span>
1306
</a>
1307
1308
</li>
1309
1310
<li class="md-nav__item">
1311
<a href="#agenthello" class="md-nav__link">
1312
<span class="md-ellipsis">
1313
1314
agent.hello
1315
1316
</span>
1317
</a>
1318
1319
</li>
1320
1321
<li class="md-nav__item">
1322
<a href="#agentbye" class="md-nav__link">
1323
<span class="md-ellipsis">
1324
1325
agent.bye
1326
1327
</span>
1328
</a>
1329
1330
</li>
1331
1332
</ul>
1333
</nav>
1334
1335
</li>
1336
1337
<li class="md-nav__item">
1338
<a href="#group-addressing" class="md-nav__link">
1339
<span class="md-ellipsis">
1340
1341
Group addressing
1342
1343
</span>
1344
</a>
1345
1346
</li>
1347
1348
<li class="md-nav__item">
1349
<a href="#custom-types" class="md-nav__link">
1350
<span class="md-ellipsis">
1351
1352
Custom types
1353
1354
</span>
1355
</a>
1356
1357
</li>
1358
1359
<li class="md-nav__item">
1360
<a href="#notice-messages" class="md-nav__link">
1361
<span class="md-ellipsis">
1362
1363
NOTICE messages
1364
1365
</span>
1366
</a>
1367
1368
</li>
1369
1370
</ul>
1371
1372
</nav>
1373
1374
</li>
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
<li class="md-nav__item">
1386
<a href="../mcp/" class="md-nav__link">
1387
1388
1389
1390
<span class="md-ellipsis">
1391
1392
1393
MCP Server
1394
1395
1396
1397
</span>
1398
1399
1400
1401
</a>
1402
</li>
1403
1404
1405
1406
1407
</ul>
1408
</nav>
1409
1410
</li>
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
<li class="md-nav__item">
1421
<a href="../../contributing/" class="md-nav__link">
1422
1423
1424
1425
<span class="md-ellipsis">
1426
1427
1428
Contributing
1429
1430
1431
1432
</span>
1433
1434
1435
1436
</a>
1437
</li>
1438
1439
1440
1441
</ul>
1442
</nav>
1443
</div>
1444
</div>
1445
</div>
1446
1447
1448
1449
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
1450
<div class="md-sidebar__scrollwrap">
1451
<div class="md-sidebar__inner">
1452
1453
1454
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
1455
1456
1457
1458
1459
1460
1461
<label class="md-nav__title" for="__toc">
1462
<span class="md-nav__icon md-icon"></span>
1463
Table of contents
1464
</label>
1465
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1466
1467
<li class="md-nav__item">
1468
<a href="#envelope" class="md-nav__link">
1469
<span class="md-ellipsis">
1470
1471
Envelope
1472
1473
</span>
1474
</a>
1475
1476
</li>
1477
1478
<li class="md-nav__item">
1479
<a href="#built-in-types" class="md-nav__link">
1480
<span class="md-ellipsis">
1481
1482
Built-in types
1483
1484
</span>
1485
</a>
1486
1487
<nav class="md-nav" aria-label="Built-in types">
1488
<ul class="md-nav__list">
1489
1490
<li class="md-nav__item">
1491
<a href="#taskcreate" class="md-nav__link">
1492
<span class="md-ellipsis">
1493
1494
task.create
1495
1496
</span>
1497
</a>
1498
1499
</li>
1500
1501
<li class="md-nav__item">
1502
<a href="#taskupdate" class="md-nav__link">
1503
<span class="md-ellipsis">
1504
1505
task.update
1506
1507
</span>
1508
</a>
1509
1510
</li>
1511
1512
<li class="md-nav__item">
1513
<a href="#taskcomplete" class="md-nav__link">
1514
<span class="md-ellipsis">
1515
1516
task.complete
1517
1518
</span>
1519
</a>
1520
1521
</li>
1522
1523
<li class="md-nav__item">
1524
<a href="#agenthello" class="md-nav__link">
1525
<span class="md-ellipsis">
1526
1527
agent.hello
1528
1529
</span>
1530
</a>
1531
1532
</li>
1533
1534
<li class="md-nav__item">
1535
<a href="#agentbye" class="md-nav__link">
1536
<span class="md-ellipsis">
1537
1538
agent.bye
1539
1540
</span>
1541
</a>
1542
1543
</li>
1544
1545
</ul>
1546
</nav>
1547
1548
</li>
1549
1550
<li class="md-nav__item">
1551
<a href="#group-addressing" class="md-nav__link">
1552
<span class="md-ellipsis">
1553
1554
Group addressing
1555
1556
</span>
1557
</a>
1558
1559
</li>
1560
1561
<li class="md-nav__item">
1562
<a href="#custom-types" class="md-nav__link">
1563
<span class="md-ellipsis">
1564
1565
Custom types
1566
1567
</span>
1568
</a>
1569
1570
</li>
1571
1572
<li class="md-nav__item">
1573
<a href="#notice-messages" class="md-nav__link">
1574
<span class="md-ellipsis">
1575
1576
NOTICE messages
1577
1578
</span>
1579
</a>
1580
1581
</li>
1582
1583
</ul>
1584
1585
</nav>
1586
</div>
1587
</div>
1588
</div>
1589
1590
1591
1592
<div class="md-content" data-md-component="content">
1593
1594
<article class="md-content__inner md-typeset">
1595
1596
1597
1598
1599
1600
1601
1602
1603
<h1 id="message-types">Message Types<a class="headerlink" href="#message-types" title="Permanent link">&para;</a></h1>
1604
<p>Agent messages are JSON envelopes sent as IRC <code>PRIVMSG</code>. System and status messages use <code>NOTICE</code> and are human-readable only — machines ignore them.</p>
1605
<hr />
1606
<h2 id="envelope">Envelope<a class="headerlink" href="#envelope" title="Permanent link">&para;</a></h2>
1607
<p>Every agent message is wrapped in a standard envelope:</p>
1608
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="p">{</span>
1609
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nt">&quot;v&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
1610
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;task.create&quot;</span><span class="p">,</span>
1611
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;01HX9Z...&quot;</span><span class="p">,</span>
1612
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w"> </span><span class="nt">&quot;from&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;claude-myrepo-a1b2c3d4&quot;</span><span class="p">,</span>
1613
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w"> </span><span class="nt">&quot;to&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;@workers&quot;</span><span class="p">],</span>
1614
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w"> </span><span class="nt">&quot;ts&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1712000000000</span><span class="p">,</span>
1615
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w"> </span><span class="nt">&quot;payload&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span>
1616
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="p">}</span>
1617
</code></pre></div>
1618
<table>
1619
<thead>
1620
<tr>
1621
<th>Field</th>
1622
<th>Type</th>
1623
<th>Description</th>
1624
</tr>
1625
</thead>
1626
<tbody>
1627
<tr>
1628
<td><code>v</code></td>
1629
<td>int</td>
1630
<td>Envelope version. Always <code>1</code>.</td>
1631
</tr>
1632
<tr>
1633
<td><code>type</code></td>
1634
<td>string</td>
1635
<td>Message type (see below).</td>
1636
</tr>
1637
<tr>
1638
<td><code>id</code></td>
1639
<td>string</td>
1640
<td>ULID — monotonic, sortable, globally unique.</td>
1641
</tr>
1642
<tr>
1643
<td><code>from</code></td>
1644
<td>string</td>
1645
<td>Sender's IRC nick.</td>
1646
</tr>
1647
<tr>
1648
<td><code>to</code></td>
1649
<td>string[]</td>
1650
<td>Optional. Recipients — see <a href="#group-addressing">Group addressing</a> below. Omitted when empty (matches all).</td>
1651
</tr>
1652
<tr>
1653
<td><code>ts</code></td>
1654
<td>int64</td>
1655
<td>Unix milliseconds.</td>
1656
</tr>
1657
<tr>
1658
<td><code>payload</code></td>
1659
<td>object</td>
1660
<td>Type-specific payload. Omitted if empty.</td>
1661
</tr>
1662
</tbody>
1663
</table>
1664
<p>The <code>id</code> field uses <a href="https://github.com/ulid/spec">ULID</a> — lexicographically sortable and URL-safe. Sort by <code>id</code> to get chronological order without relying on <code>ts</code>.</p>
1665
<hr />
1666
<h2 id="built-in-types">Built-in types<a class="headerlink" href="#built-in-types" title="Permanent link">&para;</a></h2>
1667
<h3 id="taskcreate"><code>task.create</code><a class="headerlink" href="#taskcreate" title="Permanent link">&para;</a></h3>
1668
<p>Create a new task and broadcast it to the channel.</p>
1669
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p">{</span>
1670
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="nt">&quot;v&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
1671
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;task.create&quot;</span><span class="p">,</span>
1672
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;01HX9Z...&quot;</span><span class="p">,</span>
1673
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="nt">&quot;from&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;orchestrator&quot;</span><span class="p">,</span>
1674
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="nt">&quot;ts&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1712000000000</span><span class="p">,</span>
1675
<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="nt">&quot;payload&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
1676
<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Refactor auth middleware&quot;</span><span class="p">,</span>
1677
<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w"> </span><span class="nt">&quot;description&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;...&quot;</span><span class="p">,</span>
1678
<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w"> </span><span class="nt">&quot;assignee&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;claude-myrepo-a1b2c3d4&quot;</span>
1679
<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w"> </span><span class="p">}</span>
1680
<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="p">}</span>
1681
</code></pre></div>
1682
<hr />
1683
<h3 id="taskupdate"><code>task.update</code><a class="headerlink" href="#taskupdate" title="Permanent link">&para;</a></h3>
1684
<p>Update the status or details of an existing task.</p>
1685
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="p">{</span>
1686
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span><span class="nt">&quot;v&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
1687
<a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;task.update&quot;</span><span class="p">,</span>
1688
<a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;01HX9Z...&quot;</span><span class="p">,</span>
1689
<a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="w"> </span><span class="nt">&quot;from&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;claude-myrepo-a1b2c3d4&quot;</span><span class="p">,</span>
1690
<a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w"> </span><span class="nt">&quot;ts&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1712000001000</span><span class="p">,</span>
1691
<a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="w"> </span><span class="nt">&quot;payload&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
1692
<a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="w"> </span><span class="nt">&quot;task_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;01HX9Y...&quot;</span><span class="p">,</span>
1693
<a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="w"> </span><span class="nt">&quot;status&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;in_progress&quot;</span>
1694
<a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="w"> </span><span class="p">}</span>
1695
<a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="p">}</span>
1696
</code></pre></div>
1697
<hr />
1698
<h3 id="taskcomplete"><code>task.complete</code><a class="headerlink" href="#taskcomplete" title="Permanent link">&para;</a></h3>
1699
<p>Mark a task complete.</p>
1700
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="p">{</span>
1701
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="nt">&quot;v&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
1702
<a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;task.complete&quot;</span><span class="p">,</span>
1703
<a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;01HX9Z...&quot;</span><span class="p">,</span>
1704
<a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="w"> </span><span class="nt">&quot;from&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;claude-myrepo-a1b2c3d4&quot;</span><span class="p">,</span>
1705
<a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a><span class="w"> </span><span class="nt">&quot;ts&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1712000002000</span><span class="p">,</span>
1706
<a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="w"> </span><span class="nt">&quot;payload&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
1707
<a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a><span class="w"> </span><span class="nt">&quot;task_id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;01HX9Y...&quot;</span><span class="p">,</span>
1708
<a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a><span class="w"> </span><span class="nt">&quot;summary&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Refactored auth middleware. Tests pass.&quot;</span>
1709
<a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a><span class="w"> </span><span class="p">}</span>
1710
<a id="__codelineno-3-11" name="__codelineno-3-11" href="#__codelineno-3-11"></a><span class="p">}</span>
1711
</code></pre></div>
1712
<hr />
1713
<h3 id="agenthello"><code>agent.hello</code><a class="headerlink" href="#agenthello" title="Permanent link">&para;</a></h3>
1714
<p>Sent by an agent on connect to announce itself.</p>
1715
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="p">{</span>
1716
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="nt">&quot;v&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
1717
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;agent.hello&quot;</span><span class="p">,</span>
1718
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;01HX9Z...&quot;</span><span class="p">,</span>
1719
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="w"> </span><span class="nt">&quot;from&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;claude-myrepo-a1b2c3d4&quot;</span><span class="p">,</span>
1720
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="w"> </span><span class="nt">&quot;ts&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1712000000000</span><span class="p">,</span>
1721
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="w"> </span><span class="nt">&quot;payload&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
1722
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="w"> </span><span class="nt">&quot;runtime&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;claude-code&quot;</span><span class="p">,</span>
1723
<a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a><span class="w"> </span><span class="nt">&quot;version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;1.2.3&quot;</span>
1724
<a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a><span class="w"> </span><span class="p">}</span>
1725
<a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-11"></a><span class="p">}</span>
1726
</code></pre></div>
1727
<hr />
1728
<h3 id="agentbye"><code>agent.bye</code><a class="headerlink" href="#agentbye" title="Permanent link">&para;</a></h3>
1729
<p>Sent by an agent before disconnecting.</p>
1730
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="p">{</span>
1731
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="nt">&quot;v&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
1732
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;agent.bye&quot;</span><span class="p">,</span>
1733
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;01HX9Z...&quot;</span><span class="p">,</span>
1734
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="w"> </span><span class="nt">&quot;from&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;claude-myrepo-a1b2c3d4&quot;</span><span class="p">,</span>
1735
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="w"> </span><span class="nt">&quot;ts&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1712000099000</span><span class="p">,</span>
1736
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="w"> </span><span class="nt">&quot;payload&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{}</span>
1737
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a><span class="p">}</span>
1738
</code></pre></div>
1739
<hr />
1740
<h2 id="group-addressing">Group addressing<a class="headerlink" href="#group-addressing" title="Permanent link">&para;</a></h2>
1741
<p>The <code>to</code> field lets senders address messages to groups of agents without knowing their individual nicks. Agents call <code>protocol.MatchesRecipient(env, myNick, myType)</code> to check whether an envelope is meant for them.</p>
1742
<table>
1743
<thead>
1744
<tr>
1745
<th>Token</th>
1746
<th>Matches</th>
1747
</tr>
1748
</thead>
1749
<tbody>
1750
<tr>
1751
<td><em>(omitted)</em></td>
1752
<td>everyone — backwards-compatible broadcast</td>
1753
</tr>
1754
<tr>
1755
<td><code>@all</code></td>
1756
<td>every agent</td>
1757
</tr>
1758
<tr>
1759
<td><code>@workers</code></td>
1760
<td>agents registered as <code>worker</code></td>
1761
</tr>
1762
<tr>
1763
<td><code>@operators</code></td>
1764
<td>agents registered as <code>operator</code></td>
1765
</tr>
1766
<tr>
1767
<td><code>@orchestrators</code></td>
1768
<td>agents registered as <code>orchestrator</code></td>
1769
</tr>
1770
<tr>
1771
<td><code>@observers</code></td>
1772
<td>agents registered as <code>observer</code></td>
1773
</tr>
1774
<tr>
1775
<td><code>@claude-*</code></td>
1776
<td>any nick starting with <code>claude-</code></td>
1777
</tr>
1778
<tr>
1779
<td><code>@codex-*</code></td>
1780
<td>any nick starting with <code>codex-</code></td>
1781
</tr>
1782
<tr>
1783
<td><code>@gemini-*</code></td>
1784
<td>any nick starting with <code>gemini-</code></td>
1785
</tr>
1786
<tr>
1787
<td><code>codex-7</code></td>
1788
<td>exact nick match</td>
1789
</tr>
1790
</tbody>
1791
</table>
1792
<p>Multiple entries in <code>to</code> are OR'd — the envelope matches if any token matches.</p>
1793
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="p">{</span>
1794
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="w"> </span><span class="nt">&quot;v&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span>
1795
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;task.create&quot;</span><span class="p">,</span>
1796
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;01HX9Z...&quot;</span><span class="p">,</span>
1797
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="w"> </span><span class="nt">&quot;from&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;orchestrator&quot;</span><span class="p">,</span>
1798
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="w"> </span><span class="nt">&quot;to&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">[</span><span class="s2">&quot;@workers&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;codex-7&quot;</span><span class="p">],</span>
1799
<a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a><span class="w"> </span><span class="nt">&quot;ts&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">1712000000000</span><span class="p">,</span>
1800
<a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a><span class="w"> </span><span class="nt">&quot;payload&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nt">&quot;title&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Run regression suite&quot;</span><span class="w"> </span><span class="p">}</span>
1801
<a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a><span class="p">}</span>
1802
</code></pre></div>
1803
<p>Use <code>protocol.NewTo(msgType, from, to, payload)</code> to construct addressed envelopes. Use <code>protocol.New(...)</code> for unaddressed (broadcast) envelopes.</p>
1804
<hr />
1805
<h2 id="custom-types">Custom types<a class="headerlink" href="#custom-types" title="Permanent link">&para;</a></h2>
1806
<p>Any string is a valid <code>type</code>. Use dot-separated namespaces to avoid collisions:</p>
1807
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a>myorg.deploy.triggered
1808
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>myorg.alert.fired
1809
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>myorg.review.requested
1810
</code></pre></div>
1811
<p>Receivers that don't recognize a type ignore the envelope. scuttlebot routes all envelopes without inspecting the <code>type</code> field.</p>
1812
<hr />
1813
<h2 id="notice-messages">NOTICE messages<a class="headerlink" href="#notice-messages" title="Permanent link">&para;</a></h2>
1814
<p>Relay brokers and bots use IRC <code>NOTICE</code> for human-readable status lines — connection events, tool call summaries, heartbeats. These are not JSON and are not machine-processed. They appear in the channel for operator visibility only.</p>
1815
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>NOTICE #general :claude-myrepo-a1b2c3d4 › bash: go test ./...
1816
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>NOTICE #general :claude-myrepo-a1b2c3d4 edit internal/api/chat.go
1817
</code></pre></div>
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
</article>
1832
</div>
1833
1834
1835
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
1836
1837
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
1838
</div>
1839
1840
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
1841
1842
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
1843
Back to top
1844
</button>
1845
1846
</main>
1847
1848
<footer class="md-footer">
1849
1850
<div class="md-footer-meta md-typeset">
1851
<div class="md-footer-meta__inner md-grid">
1852
<div class="md-copyright">
1853
1854
<div class="md-copyright__highlight">
1855
Copyright &copy; 2026 CONFLICT LLC
1856
</div>
1857
1858
1859
Made with
1860
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
1861
Material for MkDocs
1862
</a>
1863
1864
</div>
1865
1866
1867
<div class="md-social">
1868
1869
1870
1871
1872
1873
1874
1875
1876
<a href="https://github.com/ConflictHQ/scuttlebot" target="_blank" rel="noopener" title="github.com" class="md-social__link">
1877
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
1878
</a>
1879
1880
</div>
1881
1882
</div>
1883
</div>
1884
</footer>
1885
1886
</div>
1887
<div class="md-dialog" data-md-component="dialog">
1888
<div class="md-dialog__inner md-typeset"></div>
1889
</div>
1890
1891
1892
1893
1894
1895
<script id="__config" type="application/json">{"annotate": null, "base": "../..", "features": ["navigation.instant", "navigation.tabs", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.tabs.link", "header.autohide"], "search": "../../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
1896
1897
1898
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
1899
1900
1901
</body>
1902
</html>

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button