robot_lab 0.1.0 → 0.2.1

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 (242) hide show
  1. checksums.yaml +4 -4
  2. data/.architecture/AGENTS.md +32 -0
  3. data/.architecture/config.yml +8 -0
  4. data/.architecture/members.yml +60 -0
  5. data/.architecture/reviews/feature-free-will.md +490 -0
  6. data/.architecture/reviews/overall-codebase.md +427 -0
  7. data/.claude/settings.local.json +57 -0
  8. data/.codex/config.toml +2 -0
  9. data/.irbrc +2 -2
  10. data/.rubocop.yml +172 -0
  11. data/CHANGELOG.md +72 -0
  12. data/CLAUDE.md +139 -0
  13. data/README.md +91 -95
  14. data/Rakefile +109 -3
  15. data/agent2agent_review.md +192 -0
  16. data/agentf_improvements.md +253 -0
  17. data/agents.md +14 -0
  18. data/docs/examples/index.md +37 -2
  19. data/docs/getting-started/configuration.md +20 -7
  20. data/docs/guides/index.md +16 -16
  21. data/docs/guides/knowledge.md +7 -1
  22. data/docs/guides/observability.md +132 -0
  23. data/docs/index.md +30 -3
  24. data/docs/superpowers/plans/2026-05-06-agentskills.md +1303 -0
  25. data/docs/superpowers/specs/2026-05-06-agentskills-design.md +247 -0
  26. data/examples/.envrc +1 -0
  27. data/examples/01_simple_robot.rb +5 -9
  28. data/examples/02_tools.rb +5 -9
  29. data/examples/03_network.rb +8 -9
  30. data/examples/04_mcp.rb +21 -29
  31. data/examples/05_streaming.rb +12 -18
  32. data/examples/06_prompt_templates.rb +11 -19
  33. data/examples/07_network_memory.rb +16 -31
  34. data/examples/08_llm_config.rb +10 -22
  35. data/examples/09_chaining.rb +16 -27
  36. data/examples/10_memory.rb +12 -28
  37. data/examples/11_network_introspection.rb +15 -29
  38. data/examples/12_message_bus.rb +5 -12
  39. data/examples/13_spawn.rb +5 -10
  40. data/examples/14_rusty_circuit/.envrc +1 -0
  41. data/examples/14_rusty_circuit/comic.rb +2 -0
  42. data/examples/14_rusty_circuit/heckler.rb +1 -1
  43. data/examples/14_rusty_circuit/open_mic.rb +1 -3
  44. data/examples/14_rusty_circuit/scout.rb +2 -0
  45. data/examples/15_memory_network_and_bus/.envrc +1 -0
  46. data/examples/15_memory_network_and_bus/editorial_pipeline.rb +6 -3
  47. data/examples/15_memory_network_and_bus/linux_writer.rb +1 -1
  48. data/examples/15_memory_network_and_bus/output/combined_article.md +6 -6
  49. data/examples/15_memory_network_and_bus/output/final_article.md +6 -8
  50. data/examples/15_memory_network_and_bus/output/linux_draft.md +4 -2
  51. data/examples/15_memory_network_and_bus/output/mac_draft.md +3 -3
  52. data/examples/15_memory_network_and_bus/output/memory.json +6 -6
  53. data/examples/15_memory_network_and_bus/output/revision_1.md +10 -11
  54. data/examples/15_memory_network_and_bus/output/revision_2.md +6 -8
  55. data/examples/15_memory_network_and_bus/output/windows_draft.md +3 -3
  56. data/examples/16_writers_room/.envrc +1 -0
  57. data/examples/16_writers_room/writers_room.rb +2 -4
  58. data/examples/17_skills.rb +8 -17
  59. data/examples/18_rails/Gemfile +1 -0
  60. data/examples/19_token_tracking.rb +9 -15
  61. data/examples/20_circuit_breaker.rb +10 -19
  62. data/examples/21_learning_loop.rb +11 -20
  63. data/examples/22_context_compression.rb +6 -13
  64. data/examples/23_convergence.rb +6 -17
  65. data/examples/24_structured_delegation.rb +11 -15
  66. data/examples/25_history_search.rb +5 -12
  67. data/examples/26_document_store.rb +6 -13
  68. data/examples/27_incident_response/incident_response.rb +4 -5
  69. data/examples/28_mcp_discovery.rb +8 -11
  70. data/examples/29_ractor_tools.rb +4 -9
  71. data/examples/30_ractor_network.rb +10 -19
  72. data/examples/31_launch_assessment.rb +10 -23
  73. data/examples/32_newsletter_reader.rb +188 -0
  74. data/examples/33_stock_generator.rb +80 -0
  75. data/examples/33_stock_predictor.rb +306 -0
  76. data/examples/34_agentskills.rb +72 -0
  77. data/examples/README.md +1 -1
  78. data/examples/common.rb +76 -0
  79. data/examples/ruboruby.md +423 -0
  80. data/examples/temp.md +51 -0
  81. data/lib/robot_lab/agent_skill.rb +63 -0
  82. data/lib/robot_lab/agent_skill_catalog.rb +74 -0
  83. data/lib/robot_lab/ask_user.rb +2 -2
  84. data/lib/robot_lab/bus_poller.rb +12 -5
  85. data/lib/robot_lab/config.rb +1 -12
  86. data/lib/robot_lab/delegation_future.rb +1 -1
  87. data/lib/robot_lab/doom_loop_detector.rb +98 -0
  88. data/lib/robot_lab/history_compressor.rb +4 -10
  89. data/lib/robot_lab/mcp/client.rb +1 -2
  90. data/lib/robot_lab/mcp/connection_poller.rb +3 -3
  91. data/lib/robot_lab/mcp/server.rb +1 -1
  92. data/lib/robot_lab/mcp/server_discovery.rb +0 -2
  93. data/lib/robot_lab/memory.rb +32 -27
  94. data/lib/robot_lab/memory_change.rb +2 -2
  95. data/lib/robot_lab/message.rb +4 -4
  96. data/lib/robot_lab/network.rb +11 -6
  97. data/lib/robot_lab/robot/agent_skill_matching.rb +99 -0
  98. data/lib/robot_lab/robot/bus_messaging.rb +9 -27
  99. data/lib/robot_lab/robot/history_search.rb +4 -1
  100. data/lib/robot_lab/robot/mcp_management.rb +5 -11
  101. data/lib/robot_lab/robot/template_rendering.rb +60 -40
  102. data/lib/robot_lab/robot.rb +323 -206
  103. data/lib/robot_lab/robot_result.rb +6 -5
  104. data/lib/robot_lab/run_config.rb +5 -11
  105. data/lib/robot_lab/script_tool.rb +76 -0
  106. data/lib/robot_lab/state_proxy.rb +7 -5
  107. data/lib/robot_lab/tool.rb +3 -3
  108. data/lib/robot_lab/tool_config.rb +1 -1
  109. data/lib/robot_lab/tool_manifest.rb +5 -7
  110. data/lib/robot_lab/user_message.rb +2 -2
  111. data/lib/robot_lab/version.rb +1 -1
  112. data/lib/robot_lab/waiter.rb +1 -1
  113. data/lib/robot_lab.rb +41 -52
  114. data/logfile +8 -0
  115. data/mkdocs.yml +2 -3
  116. data/robot_concurrency.md +38 -0
  117. data/simple_acp_review.md +298 -0
  118. data/site/404.html +2300 -0
  119. data/site/api/core/index.html +2706 -0
  120. data/site/api/core/memory/index.html +3793 -0
  121. data/site/api/core/network/index.html +3500 -0
  122. data/site/api/core/robot/index.html +4566 -0
  123. data/site/api/core/state/index.html +3390 -0
  124. data/site/api/core/tool/index.html +3843 -0
  125. data/site/api/index.html +2635 -0
  126. data/site/api/mcp/client/index.html +3435 -0
  127. data/site/api/mcp/index.html +2783 -0
  128. data/site/api/mcp/server/index.html +3252 -0
  129. data/site/api/mcp/transports/index.html +3352 -0
  130. data/site/api/messages/index.html +2641 -0
  131. data/site/api/messages/text-message/index.html +3087 -0
  132. data/site/api/messages/tool-call-message/index.html +3159 -0
  133. data/site/api/messages/tool-result-message/index.html +3252 -0
  134. data/site/api/messages/user-message/index.html +3212 -0
  135. data/site/api/streaming/context/index.html +3282 -0
  136. data/site/api/streaming/events/index.html +3347 -0
  137. data/site/api/streaming/index.html +2738 -0
  138. data/site/architecture/core-concepts/index.html +3757 -0
  139. data/site/architecture/index.html +2797 -0
  140. data/site/architecture/message-flow/index.html +3238 -0
  141. data/site/architecture/network-orchestration/index.html +3433 -0
  142. data/site/architecture/robot-execution/index.html +3140 -0
  143. data/site/architecture/state-management/index.html +3498 -0
  144. data/site/assets/css/custom.css +56 -0
  145. data/site/assets/images/favicon.png +0 -0
  146. data/site/assets/images/robot_lab.jpg +0 -0
  147. data/site/assets/javascripts/bundle.79ae519e.min.js +16 -0
  148. data/site/assets/javascripts/bundle.79ae519e.min.js.map +7 -0
  149. data/site/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
  150. data/site/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
  151. data/site/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
  152. data/site/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
  153. data/site/assets/javascripts/lunr/min/lunr.el.min.js +1 -0
  154. data/site/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
  155. data/site/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
  156. data/site/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
  157. data/site/assets/javascripts/lunr/min/lunr.he.min.js +1 -0
  158. data/site/assets/javascripts/lunr/min/lunr.hi.min.js +1 -0
  159. data/site/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
  160. data/site/assets/javascripts/lunr/min/lunr.hy.min.js +1 -0
  161. data/site/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
  162. data/site/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
  163. data/site/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
  164. data/site/assets/javascripts/lunr/min/lunr.kn.min.js +1 -0
  165. data/site/assets/javascripts/lunr/min/lunr.ko.min.js +1 -0
  166. data/site/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
  167. data/site/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
  168. data/site/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
  169. data/site/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
  170. data/site/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
  171. data/site/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
  172. data/site/assets/javascripts/lunr/min/lunr.sa.min.js +1 -0
  173. data/site/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
  174. data/site/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
  175. data/site/assets/javascripts/lunr/min/lunr.ta.min.js +1 -0
  176. data/site/assets/javascripts/lunr/min/lunr.te.min.js +1 -0
  177. data/site/assets/javascripts/lunr/min/lunr.th.min.js +1 -0
  178. data/site/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
  179. data/site/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
  180. data/site/assets/javascripts/lunr/min/lunr.zh.min.js +1 -0
  181. data/site/assets/javascripts/lunr/tinyseg.js +206 -0
  182. data/site/assets/javascripts/lunr/wordcut.js +6708 -0
  183. data/site/assets/javascripts/workers/search.2c215733.min.js +42 -0
  184. data/site/assets/javascripts/workers/search.2c215733.min.js.map +7 -0
  185. data/site/assets/stylesheets/main.484c7ddc.min.css +1 -0
  186. data/site/assets/stylesheets/main.484c7ddc.min.css.map +1 -0
  187. data/site/assets/stylesheets/palette.ab4e12ef.min.css +1 -0
  188. data/site/assets/stylesheets/palette.ab4e12ef.min.css.map +1 -0
  189. data/site/concepts/index.html +3455 -0
  190. data/site/examples/basic-chat/index.html +2880 -0
  191. data/site/examples/index.html +2907 -0
  192. data/site/examples/mcp-server/index.html +3018 -0
  193. data/site/examples/multi-robot-network/index.html +3131 -0
  194. data/site/examples/rails-application/index.html +3329 -0
  195. data/site/examples/tool-usage/index.html +3085 -0
  196. data/site/getting-started/configuration/index.html +3745 -0
  197. data/site/getting-started/index.html +2572 -0
  198. data/site/getting-started/installation/index.html +2981 -0
  199. data/site/getting-started/quick-start/index.html +2942 -0
  200. data/site/guides/building-robots/index.html +4290 -0
  201. data/site/guides/creating-networks/index.html +3858 -0
  202. data/site/guides/index.html +2586 -0
  203. data/site/guides/mcp-integration/index.html +3581 -0
  204. data/site/guides/memory/index.html +3586 -0
  205. data/site/guides/rails-integration/index.html +4019 -0
  206. data/site/guides/streaming/index.html +3157 -0
  207. data/site/guides/using-tools/index.html +3802 -0
  208. data/site/index.html +2671 -0
  209. data/site/search/search_index.json +1 -0
  210. data/site/sitemap.xml +183 -0
  211. data/site/sitemap.xml.gz +0 -0
  212. data/site/tags.json +1 -0
  213. data/temp.md +6 -0
  214. data/tool_manifest_plan.md +155 -0
  215. metadata +154 -92
  216. data/docs/examples/rails-application.md +0 -419
  217. data/docs/guides/ractor-parallelism.md +0 -364
  218. data/docs/guides/rails-integration.md +0 -681
  219. data/docs/superpowers/plans/2026-04-14-ractor-integration.md +0 -1538
  220. data/docs/superpowers/specs/2026-04-14-ractor-integration-design.md +0 -258
  221. data/lib/generators/robot_lab/install_generator.rb +0 -90
  222. data/lib/generators/robot_lab/job_generator.rb +0 -40
  223. data/lib/generators/robot_lab/robot_generator.rb +0 -55
  224. data/lib/generators/robot_lab/templates/initializer.rb.tt +0 -42
  225. data/lib/generators/robot_lab/templates/job.rb.tt +0 -21
  226. data/lib/generators/robot_lab/templates/migration.rb.tt +0 -32
  227. data/lib/generators/robot_lab/templates/result_model.rb.tt +0 -52
  228. data/lib/generators/robot_lab/templates/robot.rb.tt +0 -31
  229. data/lib/generators/robot_lab/templates/robot_job.rb.tt +0 -18
  230. data/lib/generators/robot_lab/templates/robot_test.rb.tt +0 -34
  231. data/lib/generators/robot_lab/templates/routing_robot.rb.tt +0 -59
  232. data/lib/generators/robot_lab/templates/thread_model.rb.tt +0 -40
  233. data/lib/robot_lab/document_store.rb +0 -155
  234. data/lib/robot_lab/ractor_boundary.rb +0 -42
  235. data/lib/robot_lab/ractor_job.rb +0 -37
  236. data/lib/robot_lab/ractor_memory_proxy.rb +0 -85
  237. data/lib/robot_lab/ractor_network_scheduler.rb +0 -154
  238. data/lib/robot_lab/ractor_worker_pool.rb +0 -117
  239. data/lib/robot_lab/rails_integration/engine.rb +0 -29
  240. data/lib/robot_lab/rails_integration/job.rb +0 -158
  241. data/lib/robot_lab/rails_integration/railtie.rb +0 -51
  242. data/lib/robot_lab/rails_integration/turbo_stream_callbacks.rb +0 -72
@@ -0,0 +1,3352 @@
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="Multi-robot LLM workflow orchestration for Ruby">
10
+
11
+
12
+ <meta name="author" content="Dewayne VanHoozer">
13
+
14
+
15
+ <link rel="canonical" href="https://madbomber.github.io/robot_lab/api/mcp/transports/">
16
+
17
+
18
+ <link rel="prev" href="../server/">
19
+
20
+
21
+ <link rel="next" href="../../streaming/">
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.1">
29
+
30
+
31
+
32
+ <title>Transports - RobotLab</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
+
67
+
68
+ </head>
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+ <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="amber">
79
+
80
+
81
+ <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
82
+ <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
83
+ <label class="md-overlay" for="__drawer"></label>
84
+ <div data-md-component="skip">
85
+
86
+
87
+ <a href="#mcp-transports" class="md-skip">
88
+ Skip to content
89
+ </a>
90
+
91
+ </div>
92
+ <div data-md-component="announce">
93
+
94
+ </div>
95
+
96
+
97
+
98
+
99
+
100
+
101
+ <header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
102
+ <nav class="md-header__inner md-grid" aria-label="Header">
103
+ <a href="../../.." title="RobotLab" class="md-header__button md-logo" aria-label="RobotLab" data-md-component="logo">
104
+
105
+
106
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a2 2 0 0 1 2 2c0 .74-.4 1.39-1 1.73V7h1a7 7 0 0 1 7 7h1a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1h-1v1a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-1H2a1 1 0 0 1-1-1v-3a1 1 0 0 1 1-1h1a7 7 0 0 1 7-7h1V5.73c-.6-.34-1-.99-1-1.73a2 2 0 0 1 2-2M7.5 13A2.5 2.5 0 0 0 5 15.5 2.5 2.5 0 0 0 7.5 18a2.5 2.5 0 0 0 2.5-2.5A2.5 2.5 0 0 0 7.5 13m9 0a2.5 2.5 0 0 0-2.5 2.5 2.5 2.5 0 0 0 2.5 2.5 2.5 2.5 0 0 0 2.5-2.5 2.5 2.5 0 0 0-2.5-2.5"/></svg>
107
+
108
+ </a>
109
+ <label class="md-header__button md-icon" for="__drawer">
110
+
111
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
112
+ </label>
113
+ <div class="md-header__title" data-md-component="header-title">
114
+ <div class="md-header__ellipsis">
115
+ <div class="md-header__topic">
116
+ <span class="md-ellipsis">
117
+ RobotLab
118
+ </span>
119
+ </div>
120
+ <div class="md-header__topic" data-md-component="header-topic">
121
+ <span class="md-ellipsis">
122
+
123
+ Transports
124
+
125
+ </span>
126
+ </div>
127
+ </div>
128
+ </div>
129
+
130
+
131
+ <form class="md-header__option" data-md-component="palette">
132
+
133
+
134
+
135
+
136
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="amber" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
137
+
138
+ <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
139
+ <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>
140
+ </label>
141
+
142
+
143
+
144
+
145
+
146
+ <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="amber" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
147
+
148
+ <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
149
+ <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>
150
+ </label>
151
+
152
+
153
+ </form>
154
+
155
+
156
+
157
+ <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>
158
+
159
+
160
+
161
+
162
+
163
+ <label class="md-header__button md-icon" for="__search">
164
+
165
+ <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>
166
+ </label>
167
+ <div class="md-search" data-md-component="search" role="dialog">
168
+ <label class="md-search__overlay" for="__search"></label>
169
+ <div class="md-search__inner" role="search">
170
+ <form class="md-search__form" name="search">
171
+ <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>
172
+ <label class="md-search__icon md-icon" for="__search">
173
+
174
+ <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>
175
+
176
+ <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>
177
+ </label>
178
+ <nav class="md-search__options" aria-label="Search">
179
+
180
+ <a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
181
+
182
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
183
+ </a>
184
+
185
+ <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
186
+
187
+ <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>
188
+ </button>
189
+ </nav>
190
+
191
+ <div class="md-search__suggest" data-md-component="search-suggest"></div>
192
+
193
+ </form>
194
+ <div class="md-search__output">
195
+ <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
196
+ <div class="md-search-result" data-md-component="search-result">
197
+ <div class="md-search-result__meta">
198
+ Initializing search
199
+ </div>
200
+ <ol class="md-search-result__list" role="presentation"></ol>
201
+ </div>
202
+ </div>
203
+ </div>
204
+ </div>
205
+ </div>
206
+
207
+
208
+
209
+ <div class="md-header__source">
210
+ <a href="https://github.com/madbomber/robot_lab" title="Go to repository" class="md-source" data-md-component="source">
211
+ <div class="md-source__icon md-icon">
212
+
213
+ <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>
214
+ </div>
215
+ <div class="md-source__repository">
216
+ madbomber/robot_lab
217
+ </div>
218
+ </a>
219
+ </div>
220
+
221
+ </nav>
222
+
223
+
224
+
225
+ <nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
226
+ <div class="md-grid">
227
+ <ul class="md-tabs__list">
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+ <li class="md-tabs__item">
237
+ <a href="../../.." class="md-tabs__link">
238
+
239
+
240
+
241
+
242
+
243
+ Home
244
+
245
+ </a>
246
+ </li>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <li class="md-tabs__item">
259
+ <a href="../../../getting-started/" class="md-tabs__link">
260
+
261
+
262
+
263
+
264
+
265
+ Getting Started
266
+
267
+ </a>
268
+ </li>
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+
277
+
278
+
279
+
280
+ <li class="md-tabs__item">
281
+ <a href="../../../architecture/" class="md-tabs__link">
282
+
283
+
284
+
285
+
286
+
287
+ Architecture
288
+
289
+ </a>
290
+ </li>
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+ <li class="md-tabs__item">
303
+ <a href="../../../guides/" class="md-tabs__link">
304
+
305
+
306
+
307
+
308
+
309
+ Guides
310
+
311
+ </a>
312
+ </li>
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+ <li class="md-tabs__item md-tabs__item--active">
327
+ <a href="../../" class="md-tabs__link">
328
+
329
+
330
+
331
+
332
+
333
+ API Reference
334
+
335
+ </a>
336
+ </li>
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+
345
+
346
+
347
+
348
+ <li class="md-tabs__item">
349
+ <a href="../../../examples/" class="md-tabs__link">
350
+
351
+
352
+
353
+
354
+
355
+ Examples
356
+
357
+ </a>
358
+ </li>
359
+
360
+
361
+
362
+
363
+ </ul>
364
+ </div>
365
+ </nav>
366
+
367
+
368
+ </header>
369
+
370
+ <div class="md-container" data-md-component="container">
371
+
372
+
373
+
374
+
375
+ <main class="md-main" data-md-component="main">
376
+ <div class="md-main__inner md-grid">
377
+
378
+
379
+
380
+ <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
381
+ <div class="md-sidebar__scrollwrap">
382
+ <div class="md-sidebar__inner">
383
+
384
+
385
+
386
+
387
+
388
+
389
+ <nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
390
+ <label class="md-nav__title" for="__drawer">
391
+ <a href="../../.." title="RobotLab" class="md-nav__button md-logo" aria-label="RobotLab" data-md-component="logo">
392
+
393
+
394
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a2 2 0 0 1 2 2c0 .74-.4 1.39-1 1.73V7h1a7 7 0 0 1 7 7h1a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1h-1v1a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-1H2a1 1 0 0 1-1-1v-3a1 1 0 0 1 1-1h1a7 7 0 0 1 7-7h1V5.73c-.6-.34-1-.99-1-1.73a2 2 0 0 1 2-2M7.5 13A2.5 2.5 0 0 0 5 15.5 2.5 2.5 0 0 0 7.5 18a2.5 2.5 0 0 0 2.5-2.5A2.5 2.5 0 0 0 7.5 13m9 0a2.5 2.5 0 0 0-2.5 2.5 2.5 2.5 0 0 0 2.5 2.5 2.5 2.5 0 0 0 2.5-2.5 2.5 2.5 0 0 0-2.5-2.5"/></svg>
395
+
396
+ </a>
397
+ RobotLab
398
+ </label>
399
+
400
+ <div class="md-nav__source">
401
+ <a href="https://github.com/madbomber/robot_lab" title="Go to repository" class="md-source" data-md-component="source">
402
+ <div class="md-source__icon md-icon">
403
+
404
+ <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>
405
+ </div>
406
+ <div class="md-source__repository">
407
+ madbomber/robot_lab
408
+ </div>
409
+ </a>
410
+ </div>
411
+
412
+ <ul class="md-nav__list" data-md-scrollfix>
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+
428
+
429
+
430
+
431
+
432
+
433
+
434
+
435
+
436
+ <li class="md-nav__item md-nav__item--nested">
437
+
438
+
439
+
440
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
441
+
442
+
443
+ <div class="md-nav__link md-nav__container">
444
+ <a href="../../.." class="md-nav__link ">
445
+
446
+
447
+
448
+ <span class="md-ellipsis">
449
+
450
+
451
+ Home
452
+
453
+
454
+
455
+ </span>
456
+
457
+
458
+
459
+ </a>
460
+
461
+
462
+ <label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
463
+ <span class="md-nav__icon md-icon"></span>
464
+ </label>
465
+
466
+ </div>
467
+
468
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
469
+ <label class="md-nav__title" for="__nav_1">
470
+ <span class="md-nav__icon md-icon"></span>
471
+
472
+
473
+ Home
474
+
475
+
476
+ </label>
477
+ <ul class="md-nav__list" data-md-scrollfix>
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+ <li class="md-nav__item">
488
+ <a href="../../../concepts/" class="md-nav__link">
489
+
490
+
491
+
492
+ <span class="md-ellipsis">
493
+
494
+
495
+ Concepts
496
+
497
+
498
+
499
+ </span>
500
+
501
+
502
+
503
+ </a>
504
+ </li>
505
+
506
+
507
+
508
+
509
+ </ul>
510
+ </nav>
511
+
512
+ </li>
513
+
514
+
515
+
516
+
517
+
518
+
519
+
520
+
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+
534
+
535
+
536
+
537
+
538
+
539
+
540
+
541
+
542
+ <li class="md-nav__item md-nav__item--nested">
543
+
544
+
545
+
546
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
547
+
548
+
549
+ <div class="md-nav__link md-nav__container">
550
+ <a href="../../../getting-started/" class="md-nav__link ">
551
+
552
+
553
+
554
+ <span class="md-ellipsis">
555
+
556
+
557
+ Getting Started
558
+
559
+
560
+
561
+ </span>
562
+
563
+
564
+
565
+ </a>
566
+
567
+
568
+ <label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="0">
569
+ <span class="md-nav__icon md-icon"></span>
570
+ </label>
571
+
572
+ </div>
573
+
574
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
575
+ <label class="md-nav__title" for="__nav_2">
576
+ <span class="md-nav__icon md-icon"></span>
577
+
578
+
579
+ Getting Started
580
+
581
+
582
+ </label>
583
+ <ul class="md-nav__list" data-md-scrollfix>
584
+
585
+
586
+
587
+
588
+
589
+
590
+
591
+
592
+
593
+ <li class="md-nav__item">
594
+ <a href="../../../getting-started/installation/" class="md-nav__link">
595
+
596
+
597
+
598
+ <span class="md-ellipsis">
599
+
600
+
601
+ Installation
602
+
603
+
604
+
605
+ </span>
606
+
607
+
608
+
609
+ </a>
610
+ </li>
611
+
612
+
613
+
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+ <li class="md-nav__item">
622
+ <a href="../../../getting-started/quick-start/" class="md-nav__link">
623
+
624
+
625
+
626
+ <span class="md-ellipsis">
627
+
628
+
629
+ Quick Start
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="../../../getting-started/configuration/" class="md-nav__link">
651
+
652
+
653
+
654
+ <span class="md-ellipsis">
655
+
656
+
657
+ Configuration
658
+
659
+
660
+
661
+ </span>
662
+
663
+
664
+
665
+ </a>
666
+ </li>
667
+
668
+
669
+
670
+
671
+ </ul>
672
+ </nav>
673
+
674
+ </li>
675
+
676
+
677
+
678
+
679
+
680
+
681
+
682
+
683
+
684
+
685
+
686
+
687
+
688
+
689
+
690
+
691
+
692
+
693
+
694
+
695
+
696
+
697
+
698
+
699
+
700
+
701
+
702
+
703
+
704
+
705
+
706
+
707
+
708
+ <li class="md-nav__item md-nav__item--nested">
709
+
710
+
711
+
712
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
713
+
714
+
715
+ <div class="md-nav__link md-nav__container">
716
+ <a href="../../../architecture/" class="md-nav__link ">
717
+
718
+
719
+
720
+ <span class="md-ellipsis">
721
+
722
+
723
+ Architecture
724
+
725
+
726
+
727
+ </span>
728
+
729
+
730
+
731
+ </a>
732
+
733
+
734
+ <label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
735
+ <span class="md-nav__icon md-icon"></span>
736
+ </label>
737
+
738
+ </div>
739
+
740
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
741
+ <label class="md-nav__title" for="__nav_3">
742
+ <span class="md-nav__icon md-icon"></span>
743
+
744
+
745
+ Architecture
746
+
747
+
748
+ </label>
749
+ <ul class="md-nav__list" data-md-scrollfix>
750
+
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+ <li class="md-nav__item">
760
+ <a href="../../../architecture/core-concepts/" class="md-nav__link">
761
+
762
+
763
+
764
+ <span class="md-ellipsis">
765
+
766
+
767
+ Core Concepts
768
+
769
+
770
+
771
+ </span>
772
+
773
+
774
+
775
+ </a>
776
+ </li>
777
+
778
+
779
+
780
+
781
+
782
+
783
+
784
+
785
+
786
+
787
+ <li class="md-nav__item">
788
+ <a href="../../../architecture/robot-execution/" class="md-nav__link">
789
+
790
+
791
+
792
+ <span class="md-ellipsis">
793
+
794
+
795
+ Robot Execution
796
+
797
+
798
+
799
+ </span>
800
+
801
+
802
+
803
+ </a>
804
+ </li>
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+ <li class="md-nav__item">
816
+ <a href="../../../architecture/network-orchestration/" class="md-nav__link">
817
+
818
+
819
+
820
+ <span class="md-ellipsis">
821
+
822
+
823
+ Network Orchestration
824
+
825
+
826
+
827
+ </span>
828
+
829
+
830
+
831
+ </a>
832
+ </li>
833
+
834
+
835
+
836
+
837
+
838
+
839
+
840
+
841
+
842
+
843
+ <li class="md-nav__item">
844
+ <a href="../../../architecture/state-management/" class="md-nav__link">
845
+
846
+
847
+
848
+ <span class="md-ellipsis">
849
+
850
+
851
+ State Management
852
+
853
+
854
+
855
+ </span>
856
+
857
+
858
+
859
+ </a>
860
+ </li>
861
+
862
+
863
+
864
+
865
+
866
+
867
+
868
+
869
+
870
+
871
+ <li class="md-nav__item">
872
+ <a href="../../../architecture/message-flow/" class="md-nav__link">
873
+
874
+
875
+
876
+ <span class="md-ellipsis">
877
+
878
+
879
+ Message Flow
880
+
881
+
882
+
883
+ </span>
884
+
885
+
886
+
887
+ </a>
888
+ </li>
889
+
890
+
891
+
892
+
893
+ </ul>
894
+ </nav>
895
+
896
+ </li>
897
+
898
+
899
+
900
+
901
+
902
+
903
+
904
+
905
+
906
+
907
+
908
+
909
+
910
+
911
+
912
+
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+
933
+
934
+ <li class="md-nav__item md-nav__item--nested">
935
+
936
+
937
+
938
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
939
+
940
+
941
+ <div class="md-nav__link md-nav__container">
942
+ <a href="../../../guides/" class="md-nav__link ">
943
+
944
+
945
+
946
+ <span class="md-ellipsis">
947
+
948
+
949
+ Guides
950
+
951
+
952
+
953
+ </span>
954
+
955
+
956
+
957
+ </a>
958
+
959
+
960
+ <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
961
+ <span class="md-nav__icon md-icon"></span>
962
+ </label>
963
+
964
+ </div>
965
+
966
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
967
+ <label class="md-nav__title" for="__nav_4">
968
+ <span class="md-nav__icon md-icon"></span>
969
+
970
+
971
+ Guides
972
+
973
+
974
+ </label>
975
+ <ul class="md-nav__list" data-md-scrollfix>
976
+
977
+
978
+
979
+
980
+
981
+
982
+
983
+
984
+
985
+ <li class="md-nav__item">
986
+ <a href="../../../guides/building-robots/" class="md-nav__link">
987
+
988
+
989
+
990
+ <span class="md-ellipsis">
991
+
992
+
993
+ Building Robots
994
+
995
+
996
+
997
+ </span>
998
+
999
+
1000
+
1001
+ </a>
1002
+ </li>
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+ <li class="md-nav__item">
1014
+ <a href="../../../guides/creating-networks/" class="md-nav__link">
1015
+
1016
+
1017
+
1018
+ <span class="md-ellipsis">
1019
+
1020
+
1021
+ Creating Networks
1022
+
1023
+
1024
+
1025
+ </span>
1026
+
1027
+
1028
+
1029
+ </a>
1030
+ </li>
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+ <li class="md-nav__item">
1042
+ <a href="../../../guides/using-tools/" class="md-nav__link">
1043
+
1044
+
1045
+
1046
+ <span class="md-ellipsis">
1047
+
1048
+
1049
+ Using Tools
1050
+
1051
+
1052
+
1053
+ </span>
1054
+
1055
+
1056
+
1057
+ </a>
1058
+ </li>
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+ <li class="md-nav__item">
1070
+ <a href="../../../guides/mcp-integration/" class="md-nav__link">
1071
+
1072
+
1073
+
1074
+ <span class="md-ellipsis">
1075
+
1076
+
1077
+ MCP Integration
1078
+
1079
+
1080
+
1081
+ </span>
1082
+
1083
+
1084
+
1085
+ </a>
1086
+ </li>
1087
+
1088
+
1089
+
1090
+
1091
+
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+ <li class="md-nav__item">
1098
+ <a href="../../../guides/streaming/" class="md-nav__link">
1099
+
1100
+
1101
+
1102
+ <span class="md-ellipsis">
1103
+
1104
+
1105
+ Streaming Responses
1106
+
1107
+
1108
+
1109
+ </span>
1110
+
1111
+
1112
+
1113
+ </a>
1114
+ </li>
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+ <li class="md-nav__item">
1126
+ <a href="../../../guides/memory/" class="md-nav__link">
1127
+
1128
+
1129
+
1130
+ <span class="md-ellipsis">
1131
+
1132
+
1133
+ Memory System
1134
+
1135
+
1136
+
1137
+ </span>
1138
+
1139
+
1140
+
1141
+ </a>
1142
+ </li>
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+ <li class="md-nav__item">
1154
+ <a href="../../../guides/rails-integration/" class="md-nav__link">
1155
+
1156
+
1157
+
1158
+ <span class="md-ellipsis">
1159
+
1160
+
1161
+ Rails Integration
1162
+
1163
+
1164
+
1165
+ </span>
1166
+
1167
+
1168
+
1169
+ </a>
1170
+ </li>
1171
+
1172
+
1173
+
1174
+
1175
+ </ul>
1176
+ </nav>
1177
+
1178
+ </li>
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+
1185
+
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+
1192
+
1193
+
1194
+
1195
+
1196
+
1197
+
1198
+
1199
+
1200
+
1201
+
1202
+
1203
+
1204
+
1205
+
1206
+
1207
+
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+
1214
+
1215
+ <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
1216
+
1217
+
1218
+
1219
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1220
+
1221
+
1222
+ <div class="md-nav__link md-nav__container">
1223
+ <a href="../../" class="md-nav__link ">
1224
+
1225
+
1226
+
1227
+ <span class="md-ellipsis">
1228
+
1229
+
1230
+ API Reference
1231
+
1232
+
1233
+
1234
+ </span>
1235
+
1236
+
1237
+
1238
+ </a>
1239
+
1240
+
1241
+ <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
1242
+ <span class="md-nav__icon md-icon"></span>
1243
+ </label>
1244
+
1245
+ </div>
1246
+
1247
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1248
+ <label class="md-nav__title" for="__nav_5">
1249
+ <span class="md-nav__icon md-icon"></span>
1250
+
1251
+
1252
+ API Reference
1253
+
1254
+
1255
+ </label>
1256
+ <ul class="md-nav__list" data-md-scrollfix>
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+
1288
+
1289
+
1290
+ <li class="md-nav__item md-nav__item--nested">
1291
+
1292
+
1293
+
1294
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1295
+
1296
+
1297
+ <div class="md-nav__link md-nav__container">
1298
+ <a href="../../core/" class="md-nav__link ">
1299
+
1300
+
1301
+
1302
+ <span class="md-ellipsis">
1303
+
1304
+
1305
+ Core Classes
1306
+
1307
+
1308
+
1309
+ </span>
1310
+
1311
+
1312
+
1313
+ </a>
1314
+
1315
+
1316
+ <label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1317
+ <span class="md-nav__icon md-icon"></span>
1318
+ </label>
1319
+
1320
+ </div>
1321
+
1322
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1323
+ <label class="md-nav__title" for="__nav_5_2">
1324
+ <span class="md-nav__icon md-icon"></span>
1325
+
1326
+
1327
+ Core Classes
1328
+
1329
+
1330
+ </label>
1331
+ <ul class="md-nav__list" data-md-scrollfix>
1332
+
1333
+
1334
+
1335
+
1336
+
1337
+
1338
+
1339
+
1340
+
1341
+ <li class="md-nav__item">
1342
+ <a href="../../core/robot/" class="md-nav__link">
1343
+
1344
+
1345
+
1346
+ <span class="md-ellipsis">
1347
+
1348
+
1349
+ Robot
1350
+
1351
+
1352
+
1353
+ </span>
1354
+
1355
+
1356
+
1357
+ </a>
1358
+ </li>
1359
+
1360
+
1361
+
1362
+
1363
+
1364
+
1365
+
1366
+
1367
+
1368
+
1369
+ <li class="md-nav__item">
1370
+ <a href="../../core/network/" class="md-nav__link">
1371
+
1372
+
1373
+
1374
+ <span class="md-ellipsis">
1375
+
1376
+
1377
+ Network
1378
+
1379
+
1380
+
1381
+ </span>
1382
+
1383
+
1384
+
1385
+ </a>
1386
+ </li>
1387
+
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+
1397
+ <li class="md-nav__item">
1398
+ <a href="../../core/state/" class="md-nav__link">
1399
+
1400
+
1401
+
1402
+ <span class="md-ellipsis">
1403
+
1404
+
1405
+ State
1406
+
1407
+
1408
+
1409
+ </span>
1410
+
1411
+
1412
+
1413
+ </a>
1414
+ </li>
1415
+
1416
+
1417
+
1418
+
1419
+
1420
+
1421
+
1422
+
1423
+
1424
+
1425
+ <li class="md-nav__item">
1426
+ <a href="../../core/tool/" class="md-nav__link">
1427
+
1428
+
1429
+
1430
+ <span class="md-ellipsis">
1431
+
1432
+
1433
+ Tool
1434
+
1435
+
1436
+
1437
+ </span>
1438
+
1439
+
1440
+
1441
+ </a>
1442
+ </li>
1443
+
1444
+
1445
+
1446
+
1447
+
1448
+
1449
+
1450
+
1451
+
1452
+
1453
+ <li class="md-nav__item">
1454
+ <a href="../../core/memory/" class="md-nav__link">
1455
+
1456
+
1457
+
1458
+ <span class="md-ellipsis">
1459
+
1460
+
1461
+ Memory
1462
+
1463
+
1464
+
1465
+ </span>
1466
+
1467
+
1468
+
1469
+ </a>
1470
+ </li>
1471
+
1472
+
1473
+
1474
+
1475
+ </ul>
1476
+ </nav>
1477
+
1478
+ </li>
1479
+
1480
+
1481
+
1482
+
1483
+
1484
+
1485
+
1486
+
1487
+
1488
+
1489
+
1490
+
1491
+
1492
+
1493
+
1494
+
1495
+
1496
+
1497
+
1498
+
1499
+
1500
+
1501
+
1502
+
1503
+
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+
1510
+
1511
+ <li class="md-nav__item md-nav__item--nested">
1512
+
1513
+
1514
+
1515
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" >
1516
+
1517
+
1518
+ <div class="md-nav__link md-nav__container">
1519
+ <a href="../../messages/" class="md-nav__link ">
1520
+
1521
+
1522
+
1523
+ <span class="md-ellipsis">
1524
+
1525
+
1526
+ Messages
1527
+
1528
+
1529
+
1530
+ </span>
1531
+
1532
+
1533
+
1534
+ </a>
1535
+
1536
+
1537
+ <label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0">
1538
+ <span class="md-nav__icon md-icon"></span>
1539
+ </label>
1540
+
1541
+ </div>
1542
+
1543
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false">
1544
+ <label class="md-nav__title" for="__nav_5_3">
1545
+ <span class="md-nav__icon md-icon"></span>
1546
+
1547
+
1548
+ Messages
1549
+
1550
+
1551
+ </label>
1552
+ <ul class="md-nav__list" data-md-scrollfix>
1553
+
1554
+
1555
+
1556
+
1557
+
1558
+
1559
+
1560
+
1561
+
1562
+ <li class="md-nav__item">
1563
+ <a href="../../messages/user-message/" class="md-nav__link">
1564
+
1565
+
1566
+
1567
+ <span class="md-ellipsis">
1568
+
1569
+
1570
+ UserMessage
1571
+
1572
+
1573
+
1574
+ </span>
1575
+
1576
+
1577
+
1578
+ </a>
1579
+ </li>
1580
+
1581
+
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+
1589
+
1590
+ <li class="md-nav__item">
1591
+ <a href="../../messages/text-message/" class="md-nav__link">
1592
+
1593
+
1594
+
1595
+ <span class="md-ellipsis">
1596
+
1597
+
1598
+ TextMessage
1599
+
1600
+
1601
+
1602
+ </span>
1603
+
1604
+
1605
+
1606
+ </a>
1607
+ </li>
1608
+
1609
+
1610
+
1611
+
1612
+
1613
+
1614
+
1615
+
1616
+
1617
+
1618
+ <li class="md-nav__item">
1619
+ <a href="../../messages/tool-call-message/" class="md-nav__link">
1620
+
1621
+
1622
+
1623
+ <span class="md-ellipsis">
1624
+
1625
+
1626
+ ToolCallMessage
1627
+
1628
+
1629
+
1630
+ </span>
1631
+
1632
+
1633
+
1634
+ </a>
1635
+ </li>
1636
+
1637
+
1638
+
1639
+
1640
+
1641
+
1642
+
1643
+
1644
+
1645
+
1646
+ <li class="md-nav__item">
1647
+ <a href="../../messages/tool-result-message/" class="md-nav__link">
1648
+
1649
+
1650
+
1651
+ <span class="md-ellipsis">
1652
+
1653
+
1654
+ ToolResultMessage
1655
+
1656
+
1657
+
1658
+ </span>
1659
+
1660
+
1661
+
1662
+ </a>
1663
+ </li>
1664
+
1665
+
1666
+
1667
+
1668
+ </ul>
1669
+ </nav>
1670
+
1671
+ </li>
1672
+
1673
+
1674
+
1675
+
1676
+
1677
+
1678
+
1679
+
1680
+
1681
+
1682
+
1683
+
1684
+
1685
+
1686
+
1687
+
1688
+
1689
+
1690
+
1691
+
1692
+
1693
+
1694
+
1695
+
1696
+
1697
+
1698
+
1699
+
1700
+
1701
+
1702
+
1703
+
1704
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1705
+
1706
+
1707
+
1708
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" checked>
1709
+
1710
+
1711
+ <div class="md-nav__link md-nav__container">
1712
+ <a href="../" class="md-nav__link ">
1713
+
1714
+
1715
+
1716
+ <span class="md-ellipsis">
1717
+
1718
+
1719
+ MCP
1720
+
1721
+
1722
+
1723
+ </span>
1724
+
1725
+
1726
+
1727
+ </a>
1728
+
1729
+
1730
+ <label class="md-nav__link " for="__nav_5_4" id="__nav_5_4_label" tabindex="0">
1731
+ <span class="md-nav__icon md-icon"></span>
1732
+ </label>
1733
+
1734
+ </div>
1735
+
1736
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="true">
1737
+ <label class="md-nav__title" for="__nav_5_4">
1738
+ <span class="md-nav__icon md-icon"></span>
1739
+
1740
+
1741
+ MCP
1742
+
1743
+
1744
+ </label>
1745
+ <ul class="md-nav__list" data-md-scrollfix>
1746
+
1747
+
1748
+
1749
+
1750
+
1751
+
1752
+
1753
+
1754
+
1755
+ <li class="md-nav__item">
1756
+ <a href="../client/" class="md-nav__link">
1757
+
1758
+
1759
+
1760
+ <span class="md-ellipsis">
1761
+
1762
+
1763
+ Client
1764
+
1765
+
1766
+
1767
+ </span>
1768
+
1769
+
1770
+
1771
+ </a>
1772
+ </li>
1773
+
1774
+
1775
+
1776
+
1777
+
1778
+
1779
+
1780
+
1781
+
1782
+
1783
+ <li class="md-nav__item">
1784
+ <a href="../server/" class="md-nav__link">
1785
+
1786
+
1787
+
1788
+ <span class="md-ellipsis">
1789
+
1790
+
1791
+ Server
1792
+
1793
+
1794
+
1795
+ </span>
1796
+
1797
+
1798
+
1799
+ </a>
1800
+ </li>
1801
+
1802
+
1803
+
1804
+
1805
+
1806
+
1807
+
1808
+
1809
+
1810
+
1811
+
1812
+
1813
+ <li class="md-nav__item md-nav__item--active">
1814
+
1815
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1816
+
1817
+
1818
+
1819
+
1820
+
1821
+ <label class="md-nav__link md-nav__link--active" for="__toc">
1822
+
1823
+
1824
+
1825
+ <span class="md-ellipsis">
1826
+
1827
+
1828
+ Transports
1829
+
1830
+
1831
+
1832
+ </span>
1833
+
1834
+
1835
+
1836
+ <span class="md-nav__icon md-icon"></span>
1837
+ </label>
1838
+
1839
+ <a href="./" class="md-nav__link md-nav__link--active">
1840
+
1841
+
1842
+
1843
+ <span class="md-ellipsis">
1844
+
1845
+
1846
+ Transports
1847
+
1848
+
1849
+
1850
+ </span>
1851
+
1852
+
1853
+
1854
+ </a>
1855
+
1856
+
1857
+
1858
+
1859
+
1860
+ <nav class="md-nav md-nav--secondary" aria-label="On this page">
1861
+
1862
+
1863
+
1864
+
1865
+
1866
+
1867
+ <label class="md-nav__title" for="__toc">
1868
+ <span class="md-nav__icon md-icon"></span>
1869
+ On this page
1870
+ </label>
1871
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1872
+
1873
+ <li class="md-nav__item">
1874
+ <a href="#overview" class="md-nav__link">
1875
+ <span class="md-ellipsis">
1876
+
1877
+ Overview
1878
+
1879
+ </span>
1880
+ </a>
1881
+
1882
+ </li>
1883
+
1884
+ <li class="md-nav__item">
1885
+ <a href="#base-interface" class="md-nav__link">
1886
+ <span class="md-ellipsis">
1887
+
1888
+ Base Interface
1889
+
1890
+ </span>
1891
+ </a>
1892
+
1893
+ </li>
1894
+
1895
+ <li class="md-nav__item">
1896
+ <a href="#stdio-transport" class="md-nav__link">
1897
+ <span class="md-ellipsis">
1898
+
1899
+ Stdio Transport
1900
+
1901
+ </span>
1902
+ </a>
1903
+
1904
+ <nav class="md-nav" aria-label="Stdio Transport">
1905
+ <ul class="md-nav__list">
1906
+
1907
+ <li class="md-nav__item">
1908
+ <a href="#configuration" class="md-nav__link">
1909
+ <span class="md-ellipsis">
1910
+
1911
+ Configuration
1912
+
1913
+ </span>
1914
+ </a>
1915
+
1916
+ </li>
1917
+
1918
+ <li class="md-nav__item">
1919
+ <a href="#behavior" class="md-nav__link">
1920
+ <span class="md-ellipsis">
1921
+
1922
+ Behavior
1923
+
1924
+ </span>
1925
+ </a>
1926
+
1927
+ </li>
1928
+
1929
+ <li class="md-nav__item">
1930
+ <a href="#example" class="md-nav__link">
1931
+ <span class="md-ellipsis">
1932
+
1933
+ Example
1934
+
1935
+ </span>
1936
+ </a>
1937
+
1938
+ </li>
1939
+
1940
+ </ul>
1941
+ </nav>
1942
+
1943
+ </li>
1944
+
1945
+ <li class="md-nav__item">
1946
+ <a href="#websocket-transport" class="md-nav__link">
1947
+ <span class="md-ellipsis">
1948
+
1949
+ WebSocket Transport
1950
+
1951
+ </span>
1952
+ </a>
1953
+
1954
+ <nav class="md-nav" aria-label="WebSocket Transport">
1955
+ <ul class="md-nav__list">
1956
+
1957
+ <li class="md-nav__item">
1958
+ <a href="#configuration_1" class="md-nav__link">
1959
+ <span class="md-ellipsis">
1960
+
1961
+ Configuration
1962
+
1963
+ </span>
1964
+ </a>
1965
+
1966
+ </li>
1967
+
1968
+ <li class="md-nav__item">
1969
+ <a href="#behavior_1" class="md-nav__link">
1970
+ <span class="md-ellipsis">
1971
+
1972
+ Behavior
1973
+
1974
+ </span>
1975
+ </a>
1976
+
1977
+ </li>
1978
+
1979
+ <li class="md-nav__item">
1980
+ <a href="#example_1" class="md-nav__link">
1981
+ <span class="md-ellipsis">
1982
+
1983
+ Example
1984
+
1985
+ </span>
1986
+ </a>
1987
+
1988
+ </li>
1989
+
1990
+ </ul>
1991
+ </nav>
1992
+
1993
+ </li>
1994
+
1995
+ <li class="md-nav__item">
1996
+ <a href="#sse-transport" class="md-nav__link">
1997
+ <span class="md-ellipsis">
1998
+
1999
+ SSE Transport
2000
+
2001
+ </span>
2002
+ </a>
2003
+
2004
+ <nav class="md-nav" aria-label="SSE Transport">
2005
+ <ul class="md-nav__list">
2006
+
2007
+ <li class="md-nav__item">
2008
+ <a href="#configuration_2" class="md-nav__link">
2009
+ <span class="md-ellipsis">
2010
+
2011
+ Configuration
2012
+
2013
+ </span>
2014
+ </a>
2015
+
2016
+ </li>
2017
+
2018
+ <li class="md-nav__item">
2019
+ <a href="#behavior_2" class="md-nav__link">
2020
+ <span class="md-ellipsis">
2021
+
2022
+ Behavior
2023
+
2024
+ </span>
2025
+ </a>
2026
+
2027
+ </li>
2028
+
2029
+ <li class="md-nav__item">
2030
+ <a href="#example_2" class="md-nav__link">
2031
+ <span class="md-ellipsis">
2032
+
2033
+ Example
2034
+
2035
+ </span>
2036
+ </a>
2037
+
2038
+ </li>
2039
+
2040
+ </ul>
2041
+ </nav>
2042
+
2043
+ </li>
2044
+
2045
+ <li class="md-nav__item">
2046
+ <a href="#streamable-http-transport" class="md-nav__link">
2047
+ <span class="md-ellipsis">
2048
+
2049
+ Streamable HTTP Transport
2050
+
2051
+ </span>
2052
+ </a>
2053
+
2054
+ <nav class="md-nav" aria-label="Streamable HTTP Transport">
2055
+ <ul class="md-nav__list">
2056
+
2057
+ <li class="md-nav__item">
2058
+ <a href="#configuration_3" class="md-nav__link">
2059
+ <span class="md-ellipsis">
2060
+
2061
+ Configuration
2062
+
2063
+ </span>
2064
+ </a>
2065
+
2066
+ </li>
2067
+
2068
+ <li class="md-nav__item">
2069
+ <a href="#behavior_3" class="md-nav__link">
2070
+ <span class="md-ellipsis">
2071
+
2072
+ Behavior
2073
+
2074
+ </span>
2075
+ </a>
2076
+
2077
+ </li>
2078
+
2079
+ <li class="md-nav__item">
2080
+ <a href="#example_3" class="md-nav__link">
2081
+ <span class="md-ellipsis">
2082
+
2083
+ Example
2084
+
2085
+ </span>
2086
+ </a>
2087
+
2088
+ </li>
2089
+
2090
+ </ul>
2091
+ </nav>
2092
+
2093
+ </li>
2094
+
2095
+ <li class="md-nav__item">
2096
+ <a href="#connection-lifecycle" class="md-nav__link">
2097
+ <span class="md-ellipsis">
2098
+
2099
+ Connection Lifecycle
2100
+
2101
+ </span>
2102
+ </a>
2103
+
2104
+ </li>
2105
+
2106
+ <li class="md-nav__item">
2107
+ <a href="#error-handling" class="md-nav__link">
2108
+ <span class="md-ellipsis">
2109
+
2110
+ Error Handling
2111
+
2112
+ </span>
2113
+ </a>
2114
+
2115
+ </li>
2116
+
2117
+ <li class="md-nav__item">
2118
+ <a href="#see-also" class="md-nav__link">
2119
+ <span class="md-ellipsis">
2120
+
2121
+ See Also
2122
+
2123
+ </span>
2124
+ </a>
2125
+
2126
+ </li>
2127
+
2128
+ </ul>
2129
+
2130
+ </nav>
2131
+
2132
+ </li>
2133
+
2134
+
2135
+
2136
+
2137
+ </ul>
2138
+ </nav>
2139
+
2140
+ </li>
2141
+
2142
+
2143
+
2144
+
2145
+
2146
+
2147
+
2148
+
2149
+
2150
+
2151
+
2152
+
2153
+
2154
+
2155
+
2156
+
2157
+
2158
+
2159
+
2160
+
2161
+
2162
+
2163
+
2164
+
2165
+
2166
+
2167
+
2168
+
2169
+ <li class="md-nav__item md-nav__item--nested">
2170
+
2171
+
2172
+
2173
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" >
2174
+
2175
+
2176
+ <div class="md-nav__link md-nav__container">
2177
+ <a href="../../streaming/" class="md-nav__link ">
2178
+
2179
+
2180
+
2181
+ <span class="md-ellipsis">
2182
+
2183
+
2184
+ Streaming
2185
+
2186
+
2187
+
2188
+ </span>
2189
+
2190
+
2191
+
2192
+ </a>
2193
+
2194
+
2195
+ <label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
2196
+ <span class="md-nav__icon md-icon"></span>
2197
+ </label>
2198
+
2199
+ </div>
2200
+
2201
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
2202
+ <label class="md-nav__title" for="__nav_5_5">
2203
+ <span class="md-nav__icon md-icon"></span>
2204
+
2205
+
2206
+ Streaming
2207
+
2208
+
2209
+ </label>
2210
+ <ul class="md-nav__list" data-md-scrollfix>
2211
+
2212
+
2213
+
2214
+
2215
+
2216
+
2217
+
2218
+
2219
+
2220
+ <li class="md-nav__item">
2221
+ <a href="../../streaming/context/" class="md-nav__link">
2222
+
2223
+
2224
+
2225
+ <span class="md-ellipsis">
2226
+
2227
+
2228
+ Context
2229
+
2230
+
2231
+
2232
+ </span>
2233
+
2234
+
2235
+
2236
+ </a>
2237
+ </li>
2238
+
2239
+
2240
+
2241
+
2242
+
2243
+
2244
+
2245
+
2246
+
2247
+
2248
+ <li class="md-nav__item">
2249
+ <a href="../../streaming/events/" class="md-nav__link">
2250
+
2251
+
2252
+
2253
+ <span class="md-ellipsis">
2254
+
2255
+
2256
+ Events
2257
+
2258
+
2259
+
2260
+ </span>
2261
+
2262
+
2263
+
2264
+ </a>
2265
+ </li>
2266
+
2267
+
2268
+
2269
+
2270
+ </ul>
2271
+ </nav>
2272
+
2273
+ </li>
2274
+
2275
+
2276
+
2277
+
2278
+ </ul>
2279
+ </nav>
2280
+
2281
+ </li>
2282
+
2283
+
2284
+
2285
+
2286
+
2287
+
2288
+
2289
+
2290
+
2291
+
2292
+
2293
+
2294
+
2295
+
2296
+
2297
+
2298
+
2299
+
2300
+
2301
+
2302
+
2303
+
2304
+
2305
+
2306
+
2307
+
2308
+
2309
+
2310
+
2311
+
2312
+
2313
+
2314
+
2315
+ <li class="md-nav__item md-nav__item--nested">
2316
+
2317
+
2318
+
2319
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
2320
+
2321
+
2322
+ <div class="md-nav__link md-nav__container">
2323
+ <a href="../../../examples/" class="md-nav__link ">
2324
+
2325
+
2326
+
2327
+ <span class="md-ellipsis">
2328
+
2329
+
2330
+ Examples
2331
+
2332
+
2333
+
2334
+ </span>
2335
+
2336
+
2337
+
2338
+ </a>
2339
+
2340
+
2341
+ <label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
2342
+ <span class="md-nav__icon md-icon"></span>
2343
+ </label>
2344
+
2345
+ </div>
2346
+
2347
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
2348
+ <label class="md-nav__title" for="__nav_6">
2349
+ <span class="md-nav__icon md-icon"></span>
2350
+
2351
+
2352
+ Examples
2353
+
2354
+
2355
+ </label>
2356
+ <ul class="md-nav__list" data-md-scrollfix>
2357
+
2358
+
2359
+
2360
+
2361
+
2362
+
2363
+
2364
+
2365
+
2366
+ <li class="md-nav__item">
2367
+ <a href="../../../examples/basic-chat/" class="md-nav__link">
2368
+
2369
+
2370
+
2371
+ <span class="md-ellipsis">
2372
+
2373
+
2374
+ Basic Chat
2375
+
2376
+
2377
+
2378
+ </span>
2379
+
2380
+
2381
+
2382
+ </a>
2383
+ </li>
2384
+
2385
+
2386
+
2387
+
2388
+
2389
+
2390
+
2391
+
2392
+
2393
+
2394
+ <li class="md-nav__item">
2395
+ <a href="../../../examples/multi-robot-network/" class="md-nav__link">
2396
+
2397
+
2398
+
2399
+ <span class="md-ellipsis">
2400
+
2401
+
2402
+ Multi-Robot Network
2403
+
2404
+
2405
+
2406
+ </span>
2407
+
2408
+
2409
+
2410
+ </a>
2411
+ </li>
2412
+
2413
+
2414
+
2415
+
2416
+
2417
+
2418
+
2419
+
2420
+
2421
+
2422
+ <li class="md-nav__item">
2423
+ <a href="../../../examples/tool-usage/" class="md-nav__link">
2424
+
2425
+
2426
+
2427
+ <span class="md-ellipsis">
2428
+
2429
+
2430
+ Tool Usage
2431
+
2432
+
2433
+
2434
+ </span>
2435
+
2436
+
2437
+
2438
+ </a>
2439
+ </li>
2440
+
2441
+
2442
+
2443
+
2444
+
2445
+
2446
+
2447
+
2448
+
2449
+
2450
+ <li class="md-nav__item">
2451
+ <a href="../../../examples/mcp-server/" class="md-nav__link">
2452
+
2453
+
2454
+
2455
+ <span class="md-ellipsis">
2456
+
2457
+
2458
+ MCP Server
2459
+
2460
+
2461
+
2462
+ </span>
2463
+
2464
+
2465
+
2466
+ </a>
2467
+ </li>
2468
+
2469
+
2470
+
2471
+
2472
+
2473
+
2474
+
2475
+
2476
+
2477
+
2478
+ <li class="md-nav__item">
2479
+ <a href="../../../examples/rails-application/" class="md-nav__link">
2480
+
2481
+
2482
+
2483
+ <span class="md-ellipsis">
2484
+
2485
+
2486
+ Rails Application
2487
+
2488
+
2489
+
2490
+ </span>
2491
+
2492
+
2493
+
2494
+ </a>
2495
+ </li>
2496
+
2497
+
2498
+
2499
+
2500
+ </ul>
2501
+ </nav>
2502
+
2503
+ </li>
2504
+
2505
+
2506
+
2507
+ </ul>
2508
+ </nav>
2509
+ </div>
2510
+ </div>
2511
+ </div>
2512
+
2513
+
2514
+
2515
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2516
+ <div class="md-sidebar__scrollwrap">
2517
+ <div class="md-sidebar__inner">
2518
+
2519
+
2520
+
2521
+
2522
+ <nav class="md-nav md-nav--secondary" aria-label="On this page">
2523
+
2524
+
2525
+
2526
+
2527
+
2528
+
2529
+ <label class="md-nav__title" for="__toc">
2530
+ <span class="md-nav__icon md-icon"></span>
2531
+ On this page
2532
+ </label>
2533
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2534
+
2535
+ <li class="md-nav__item">
2536
+ <a href="#overview" class="md-nav__link">
2537
+ <span class="md-ellipsis">
2538
+
2539
+ Overview
2540
+
2541
+ </span>
2542
+ </a>
2543
+
2544
+ </li>
2545
+
2546
+ <li class="md-nav__item">
2547
+ <a href="#base-interface" class="md-nav__link">
2548
+ <span class="md-ellipsis">
2549
+
2550
+ Base Interface
2551
+
2552
+ </span>
2553
+ </a>
2554
+
2555
+ </li>
2556
+
2557
+ <li class="md-nav__item">
2558
+ <a href="#stdio-transport" class="md-nav__link">
2559
+ <span class="md-ellipsis">
2560
+
2561
+ Stdio Transport
2562
+
2563
+ </span>
2564
+ </a>
2565
+
2566
+ <nav class="md-nav" aria-label="Stdio Transport">
2567
+ <ul class="md-nav__list">
2568
+
2569
+ <li class="md-nav__item">
2570
+ <a href="#configuration" class="md-nav__link">
2571
+ <span class="md-ellipsis">
2572
+
2573
+ Configuration
2574
+
2575
+ </span>
2576
+ </a>
2577
+
2578
+ </li>
2579
+
2580
+ <li class="md-nav__item">
2581
+ <a href="#behavior" class="md-nav__link">
2582
+ <span class="md-ellipsis">
2583
+
2584
+ Behavior
2585
+
2586
+ </span>
2587
+ </a>
2588
+
2589
+ </li>
2590
+
2591
+ <li class="md-nav__item">
2592
+ <a href="#example" class="md-nav__link">
2593
+ <span class="md-ellipsis">
2594
+
2595
+ Example
2596
+
2597
+ </span>
2598
+ </a>
2599
+
2600
+ </li>
2601
+
2602
+ </ul>
2603
+ </nav>
2604
+
2605
+ </li>
2606
+
2607
+ <li class="md-nav__item">
2608
+ <a href="#websocket-transport" class="md-nav__link">
2609
+ <span class="md-ellipsis">
2610
+
2611
+ WebSocket Transport
2612
+
2613
+ </span>
2614
+ </a>
2615
+
2616
+ <nav class="md-nav" aria-label="WebSocket Transport">
2617
+ <ul class="md-nav__list">
2618
+
2619
+ <li class="md-nav__item">
2620
+ <a href="#configuration_1" class="md-nav__link">
2621
+ <span class="md-ellipsis">
2622
+
2623
+ Configuration
2624
+
2625
+ </span>
2626
+ </a>
2627
+
2628
+ </li>
2629
+
2630
+ <li class="md-nav__item">
2631
+ <a href="#behavior_1" class="md-nav__link">
2632
+ <span class="md-ellipsis">
2633
+
2634
+ Behavior
2635
+
2636
+ </span>
2637
+ </a>
2638
+
2639
+ </li>
2640
+
2641
+ <li class="md-nav__item">
2642
+ <a href="#example_1" class="md-nav__link">
2643
+ <span class="md-ellipsis">
2644
+
2645
+ Example
2646
+
2647
+ </span>
2648
+ </a>
2649
+
2650
+ </li>
2651
+
2652
+ </ul>
2653
+ </nav>
2654
+
2655
+ </li>
2656
+
2657
+ <li class="md-nav__item">
2658
+ <a href="#sse-transport" class="md-nav__link">
2659
+ <span class="md-ellipsis">
2660
+
2661
+ SSE Transport
2662
+
2663
+ </span>
2664
+ </a>
2665
+
2666
+ <nav class="md-nav" aria-label="SSE Transport">
2667
+ <ul class="md-nav__list">
2668
+
2669
+ <li class="md-nav__item">
2670
+ <a href="#configuration_2" class="md-nav__link">
2671
+ <span class="md-ellipsis">
2672
+
2673
+ Configuration
2674
+
2675
+ </span>
2676
+ </a>
2677
+
2678
+ </li>
2679
+
2680
+ <li class="md-nav__item">
2681
+ <a href="#behavior_2" class="md-nav__link">
2682
+ <span class="md-ellipsis">
2683
+
2684
+ Behavior
2685
+
2686
+ </span>
2687
+ </a>
2688
+
2689
+ </li>
2690
+
2691
+ <li class="md-nav__item">
2692
+ <a href="#example_2" class="md-nav__link">
2693
+ <span class="md-ellipsis">
2694
+
2695
+ Example
2696
+
2697
+ </span>
2698
+ </a>
2699
+
2700
+ </li>
2701
+
2702
+ </ul>
2703
+ </nav>
2704
+
2705
+ </li>
2706
+
2707
+ <li class="md-nav__item">
2708
+ <a href="#streamable-http-transport" class="md-nav__link">
2709
+ <span class="md-ellipsis">
2710
+
2711
+ Streamable HTTP Transport
2712
+
2713
+ </span>
2714
+ </a>
2715
+
2716
+ <nav class="md-nav" aria-label="Streamable HTTP Transport">
2717
+ <ul class="md-nav__list">
2718
+
2719
+ <li class="md-nav__item">
2720
+ <a href="#configuration_3" class="md-nav__link">
2721
+ <span class="md-ellipsis">
2722
+
2723
+ Configuration
2724
+
2725
+ </span>
2726
+ </a>
2727
+
2728
+ </li>
2729
+
2730
+ <li class="md-nav__item">
2731
+ <a href="#behavior_3" class="md-nav__link">
2732
+ <span class="md-ellipsis">
2733
+
2734
+ Behavior
2735
+
2736
+ </span>
2737
+ </a>
2738
+
2739
+ </li>
2740
+
2741
+ <li class="md-nav__item">
2742
+ <a href="#example_3" class="md-nav__link">
2743
+ <span class="md-ellipsis">
2744
+
2745
+ Example
2746
+
2747
+ </span>
2748
+ </a>
2749
+
2750
+ </li>
2751
+
2752
+ </ul>
2753
+ </nav>
2754
+
2755
+ </li>
2756
+
2757
+ <li class="md-nav__item">
2758
+ <a href="#connection-lifecycle" class="md-nav__link">
2759
+ <span class="md-ellipsis">
2760
+
2761
+ Connection Lifecycle
2762
+
2763
+ </span>
2764
+ </a>
2765
+
2766
+ </li>
2767
+
2768
+ <li class="md-nav__item">
2769
+ <a href="#error-handling" class="md-nav__link">
2770
+ <span class="md-ellipsis">
2771
+
2772
+ Error Handling
2773
+
2774
+ </span>
2775
+ </a>
2776
+
2777
+ </li>
2778
+
2779
+ <li class="md-nav__item">
2780
+ <a href="#see-also" class="md-nav__link">
2781
+ <span class="md-ellipsis">
2782
+
2783
+ See Also
2784
+
2785
+ </span>
2786
+ </a>
2787
+
2788
+ </li>
2789
+
2790
+ </ul>
2791
+
2792
+ </nav>
2793
+ </div>
2794
+ </div>
2795
+ </div>
2796
+
2797
+
2798
+
2799
+ <div class="md-content" data-md-component="content">
2800
+
2801
+
2802
+
2803
+
2804
+
2805
+
2806
+ <nav class="md-path" aria-label="Navigation" >
2807
+ <ol class="md-path__list">
2808
+
2809
+
2810
+
2811
+
2812
+
2813
+
2814
+
2815
+ <li class="md-path__item">
2816
+ <a href="../../" class="md-path__link">
2817
+
2818
+ <span class="md-ellipsis">
2819
+ API Reference
2820
+ </span>
2821
+
2822
+ </a>
2823
+ </li>
2824
+
2825
+
2826
+
2827
+
2828
+
2829
+
2830
+
2831
+
2832
+
2833
+ <li class="md-path__item">
2834
+ <a href="../" class="md-path__link">
2835
+
2836
+ <span class="md-ellipsis">
2837
+ MCP
2838
+ </span>
2839
+
2840
+ </a>
2841
+ </li>
2842
+
2843
+
2844
+
2845
+
2846
+ </ol>
2847
+ </nav>
2848
+
2849
+
2850
+ <article class="md-content__inner md-typeset">
2851
+
2852
+
2853
+
2854
+
2855
+
2856
+ <a href="https://github.com/madbomber/robot_lab/edit/main/docs/api/mcp/transports.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
2857
+
2858
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
2859
+ </a>
2860
+
2861
+
2862
+
2863
+
2864
+
2865
+ <a href="https://github.com/madbomber/robot_lab/raw/main/docs/api/mcp/transports.md" title="View source of this page" class="md-content__button md-icon">
2866
+
2867
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg>
2868
+ </a>
2869
+
2870
+
2871
+
2872
+ <h1 id="mcp-transports">MCP Transports<a class="headerlink" href="#mcp-transports" title="Permanent link">&para;</a></h1>
2873
+ <p>Communication methods for MCP client-server connections.</p>
2874
+ <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">&para;</a></h2>
2875
+ <p>Transports handle the low-level communication between <code>MCP::Client</code> and external MCP servers. All transports implement the same interface defined by <code>Transports::Base</code>, using JSON-RPC 2.0 for message exchange and the MCP protocol version <code>2024-11-05</code> for initialization.</p>
2876
+ <p>RobotLab provides four built-in transport types:</p>
2877
+ <table>
2878
+ <thead>
2879
+ <tr>
2880
+ <th>Transport</th>
2881
+ <th>Class</th>
2882
+ <th>Use Case</th>
2883
+ </tr>
2884
+ </thead>
2885
+ <tbody>
2886
+ <tr>
2887
+ <td>Stdio</td>
2888
+ <td><code>Transports::Stdio</code></td>
2889
+ <td>Local subprocess servers</td>
2890
+ </tr>
2891
+ <tr>
2892
+ <td>WebSocket</td>
2893
+ <td><code>Transports::WebSocket</code></td>
2894
+ <td>Real-time bidirectional</td>
2895
+ </tr>
2896
+ <tr>
2897
+ <td>SSE</td>
2898
+ <td><code>Transports::SSE</code></td>
2899
+ <td>Server-sent events</td>
2900
+ </tr>
2901
+ <tr>
2902
+ <td>Streamable HTTP</td>
2903
+ <td><code>Transports::StreamableHTTP</code></td>
2904
+ <td>HTTP with session support</td>
2905
+ </tr>
2906
+ </tbody>
2907
+ </table>
2908
+ <h2 id="base-interface">Base Interface<a class="headerlink" href="#base-interface" title="Permanent link">&para;</a></h2>
2909
+ <p>All transports inherit from <code>RobotLab::MCP::Transports::Base</code> and implement:</p>
2910
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Transports</span><span class="o">::</span><span class="no">Base</span>
2911
+ </span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:config</span><span class="w"> </span><span class="c1"># =&gt; Hash (symbolized keys)</span>
2912
+ </span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>
2913
+ </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">connect</span><span class="w"> </span><span class="c1"># Establish connection, returns self</span>
2914
+ </span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">send_request</span><span class="p">(</span><span class="n">message</span><span class="p">)</span><span class="w"> </span><span class="c1"># Send JSON-RPC message, returns Hash response</span>
2915
+ </span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">close</span><span class="w"> </span><span class="c1"># Close connection, returns self</span>
2916
+ </span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">connected?</span><span class="w"> </span><span class="c1"># Returns Boolean</span>
2917
+ </span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="k">end</span>
2918
+ </span></code></pre></div>
2919
+ <h2 id="stdio-transport">Stdio Transport<a class="headerlink" href="#stdio-transport" title="Permanent link">&para;</a></h2>
2920
+ <p><strong>Class:</strong> <code>RobotLab::MCP::Transports::Stdio</code></p>
2921
+ <p>Spawns a subprocess and communicates via stdin/stdout using JSON-RPC messages (one per line). Automatically sends MCP <code>initialize</code> and <code>notifications/initialized</code> on connect.</p>
2922
+ <h3 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">&para;</a></h3>
2923
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p">{</span>
2924
+ </span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;stdio&quot;</span><span class="p">,</span>
2925
+ </span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w"> </span><span class="ss">command</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;mcp-server-filesystem&quot;</span><span class="p">,</span><span class="w"> </span><span class="c1"># Required: executable command</span>
2926
+ </span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w"> </span><span class="ss">args</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="s2">&quot;--root&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;/data&quot;</span><span class="o">]</span><span class="p">,</span><span class="w"> </span><span class="c1"># Optional: command arguments</span>
2927
+ </span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w"> </span><span class="ss">env</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;DEBUG&quot;</span><span class="w"> </span><span class="o">=&gt;</span><span class="w"> </span><span class="s2">&quot;true&quot;</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="c1"># Optional: environment variables</span>
2928
+ </span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="p">}</span>
2929
+ </span></code></pre></div>
2930
+ <table>
2931
+ <thead>
2932
+ <tr>
2933
+ <th>Key</th>
2934
+ <th>Type</th>
2935
+ <th>Required</th>
2936
+ <th>Description</th>
2937
+ </tr>
2938
+ </thead>
2939
+ <tbody>
2940
+ <tr>
2941
+ <td><code>command</code></td>
2942
+ <td><code>String</code></td>
2943
+ <td>Yes</td>
2944
+ <td>Executable command to spawn</td>
2945
+ </tr>
2946
+ <tr>
2947
+ <td><code>args</code></td>
2948
+ <td><code>Array&lt;String&gt;</code></td>
2949
+ <td>No</td>
2950
+ <td>Command arguments</td>
2951
+ </tr>
2952
+ <tr>
2953
+ <td><code>env</code></td>
2954
+ <td><code>Hash</code></td>
2955
+ <td>No</td>
2956
+ <td>Environment variables (merged with current env)</td>
2957
+ </tr>
2958
+ </tbody>
2959
+ </table>
2960
+ <h3 id="behavior">Behavior<a class="headerlink" href="#behavior" title="Permanent link">&para;</a></h3>
2961
+ <ul>
2962
+ <li>Uses <code>Open3.popen3</code> to spawn the subprocess</li>
2963
+ <li>Writes JSON-RPC messages to stdin (one per line)</li>
2964
+ <li>Reads responses from stdout, skipping notifications (messages without <code>id</code>)</li>
2965
+ <li><code>connected?</code> returns <code>true</code> when the subprocess is alive</li>
2966
+ <li><code>close</code> terminates stdin, stdout, stderr, and kills the subprocess</li>
2967
+ </ul>
2968
+ <h3 id="example">Example<a class="headerlink" href="#example" title="Permanent link">&para;</a></h3>
2969
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="n">transport</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Transports</span><span class="o">::</span><span class="no">Stdio</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
2970
+ </span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span><span class="ss">command</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;mcp-server-filesystem&quot;</span><span class="p">,</span>
2971
+ </span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="ss">args</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="s2">&quot;--root&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;/data&quot;</span><span class="o">]</span><span class="p">,</span>
2972
+ </span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w"> </span><span class="ss">env</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;DEBUG&quot;</span><span class="w"> </span><span class="o">=&gt;</span><span class="w"> </span><span class="s2">&quot;true&quot;</span><span class="w"> </span><span class="p">}</span>
2973
+ </span><span id="__span-2-5"><a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="p">)</span>
2974
+ </span><span id="__span-2-6"><a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a>
2975
+ </span><span id="__span-2-7"><a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="n">transport</span><span class="o">.</span><span class="n">connect</span>
2976
+ </span><span id="__span-2-8"><a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="n">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">transport</span><span class="o">.</span><span class="n">send_request</span><span class="p">({</span><span class="w"> </span><span class="ss">jsonrpc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2.0&quot;</span><span class="p">,</span><span class="w"> </span><span class="nb">id</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="nb">method</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;tools/list&quot;</span><span class="w"> </span><span class="p">})</span>
2977
+ </span><span id="__span-2-9"><a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="n">transport</span><span class="o">.</span><span class="n">close</span>
2978
+ </span></code></pre></div>
2979
+ <h2 id="websocket-transport">WebSocket Transport<a class="headerlink" href="#websocket-transport" title="Permanent link">&para;</a></h2>
2980
+ <p><strong>Class:</strong> <code>RobotLab::MCP::Transports::WebSocket</code></p>
2981
+ <p>Uses <code>async-websocket</code> for non-blocking bidirectional communication. Requires the <code>async-websocket</code> gem.</p>
2982
+ <h3 id="configuration_1">Configuration<a class="headerlink" href="#configuration_1" title="Permanent link">&para;</a></h3>
2983
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="p">{</span>
2984
+ </span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ws&quot;</span><span class="p">,</span><span class="w"> </span><span class="c1"># or &quot;websocket&quot;</span>
2985
+ </span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;wss://mcp.example.com/ws&quot;</span><span class="w"> </span><span class="c1"># Required: WebSocket endpoint</span>
2986
+ </span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="p">}</span>
2987
+ </span></code></pre></div>
2988
+ <table>
2989
+ <thead>
2990
+ <tr>
2991
+ <th>Key</th>
2992
+ <th>Type</th>
2993
+ <th>Required</th>
2994
+ <th>Description</th>
2995
+ </tr>
2996
+ </thead>
2997
+ <tbody>
2998
+ <tr>
2999
+ <td><code>url</code></td>
3000
+ <td><code>String</code></td>
3001
+ <td>Yes</td>
3002
+ <td>WebSocket endpoint URL</td>
3003
+ </tr>
3004
+ </tbody>
3005
+ </table>
3006
+ <h3 id="behavior_1">Behavior<a class="headerlink" href="#behavior_1" title="Permanent link">&para;</a></h3>
3007
+ <ul>
3008
+ <li>Uses <code>Async::WebSocket::Client.connect</code> within an <code>Async</code> block</li>
3009
+ <li>Sends JSON-RPC messages as JSON strings</li>
3010
+ <li>Reads responses synchronously within the async context</li>
3011
+ <li>Raises <code>MCPError</code> if the <code>async-websocket</code> gem is not installed</li>
3012
+ </ul>
3013
+ <h3 id="example_1">Example<a class="headerlink" href="#example_1" title="Permanent link">&para;</a></h3>
3014
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="n">transport</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Transports</span><span class="o">::</span><span class="no">WebSocket</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
3015
+ </span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;ws://localhost:8080&quot;</span>
3016
+ </span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="p">)</span>
3017
+ </span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>
3018
+ </span><span id="__span-4-5"><a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="n">transport</span><span class="o">.</span><span class="n">connect</span>
3019
+ </span><span id="__span-4-6"><a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="n">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">transport</span><span class="o">.</span><span class="n">send_request</span><span class="p">({</span><span class="w"> </span><span class="ss">jsonrpc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2.0&quot;</span><span class="p">,</span><span class="w"> </span><span class="nb">id</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="nb">method</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;tools/list&quot;</span><span class="w"> </span><span class="p">})</span>
3020
+ </span><span id="__span-4-7"><a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="n">transport</span><span class="o">.</span><span class="n">close</span>
3021
+ </span></code></pre></div>
3022
+ <h2 id="sse-transport">SSE Transport<a class="headerlink" href="#sse-transport" title="Permanent link">&para;</a></h2>
3023
+ <p><strong>Class:</strong> <code>RobotLab::MCP::Transports::SSE</code></p>
3024
+ <p>Uses <code>async-http</code> for HTTP-based communication. Sends requests via HTTP POST and reads responses. Requires the <code>async-http</code> gem.</p>
3025
+ <h3 id="configuration_2">Configuration<a class="headerlink" href="#configuration_2" title="Permanent link">&para;</a></h3>
3026
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="p">{</span>
3027
+ </span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;sse&quot;</span><span class="p">,</span>
3028
+ </span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://localhost:8080/sse&quot;</span><span class="w"> </span><span class="c1"># Required: SSE endpoint</span>
3029
+ </span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="p">}</span>
3030
+ </span></code></pre></div>
3031
+ <table>
3032
+ <thead>
3033
+ <tr>
3034
+ <th>Key</th>
3035
+ <th>Type</th>
3036
+ <th>Required</th>
3037
+ <th>Description</th>
3038
+ </tr>
3039
+ </thead>
3040
+ <tbody>
3041
+ <tr>
3042
+ <td><code>url</code></td>
3043
+ <td><code>String</code></td>
3044
+ <td>Yes</td>
3045
+ <td>SSE/HTTP endpoint URL</td>
3046
+ </tr>
3047
+ </tbody>
3048
+ </table>
3049
+ <h3 id="behavior_2">Behavior<a class="headerlink" href="#behavior_2" title="Permanent link">&para;</a></h3>
3050
+ <ul>
3051
+ <li>Creates an <code>Async::HTTP::Client</code> on connect</li>
3052
+ <li>Sends JSON-RPC messages via HTTP POST with <code>Content-Type: application/json</code></li>
3053
+ <li>Reads and parses JSON response body</li>
3054
+ <li>Raises <code>MCPError</code> if the <code>async-http</code> gem is not installed</li>
3055
+ </ul>
3056
+ <h3 id="example_2">Example<a class="headerlink" href="#example_2" title="Permanent link">&para;</a></h3>
3057
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="n">transport</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Transports</span><span class="o">::</span><span class="no">SSE</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
3058
+ </span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="w"> </span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;http://localhost:8080/sse&quot;</span>
3059
+ </span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="p">)</span>
3060
+ </span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a>
3061
+ </span><span id="__span-6-5"><a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="n">transport</span><span class="o">.</span><span class="n">connect</span>
3062
+ </span><span id="__span-6-6"><a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="n">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">transport</span><span class="o">.</span><span class="n">send_request</span><span class="p">({</span><span class="w"> </span><span class="ss">jsonrpc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2.0&quot;</span><span class="p">,</span><span class="w"> </span><span class="nb">id</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="nb">method</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;tools/list&quot;</span><span class="w"> </span><span class="p">})</span>
3063
+ </span><span id="__span-6-7"><a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a><span class="n">transport</span><span class="o">.</span><span class="n">close</span>
3064
+ </span></code></pre></div>
3065
+ <h2 id="streamable-http-transport">Streamable HTTP Transport<a class="headerlink" href="#streamable-http-transport" title="Permanent link">&para;</a></h2>
3066
+ <p><strong>Class:</strong> <code>RobotLab::MCP::Transports::StreamableHTTP</code></p>
3067
+ <p>HTTP-based transport with session management and optional authentication. Supports session IDs for maintaining server-side state across requests. Requires the <code>async-http</code> gem.</p>
3068
+ <h3 id="configuration_3">Configuration<a class="headerlink" href="#configuration_3" title="Permanent link">&para;</a></h3>
3069
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="p">{</span>
3070
+ </span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;streamable-http&quot;</span><span class="p">,</span><span class="w"> </span><span class="c1"># or &quot;http&quot;</span>
3071
+ </span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://server.smithery.ai/neon/mcp&quot;</span><span class="p">,</span><span class="w"> </span><span class="c1"># Required: HTTP endpoint</span>
3072
+ </span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span><span class="ss">session_id</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;abc123&quot;</span><span class="p">,</span><span class="w"> </span><span class="c1"># Optional: session identifier</span>
3073
+ </span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span><span class="ss">auth_provider</span><span class="p">:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;Bearer </span><span class="si">#{</span><span class="n">token</span><span class="si">}</span><span class="s2">&quot;</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="c1"># Optional: auth callback</span>
3074
+ </span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="p">}</span>
3075
+ </span></code></pre></div>
3076
+ <table>
3077
+ <thead>
3078
+ <tr>
3079
+ <th>Key</th>
3080
+ <th>Type</th>
3081
+ <th>Required</th>
3082
+ <th>Description</th>
3083
+ </tr>
3084
+ </thead>
3085
+ <tbody>
3086
+ <tr>
3087
+ <td><code>url</code></td>
3088
+ <td><code>String</code></td>
3089
+ <td>Yes</td>
3090
+ <td>HTTP endpoint URL</td>
3091
+ </tr>
3092
+ <tr>
3093
+ <td><code>session_id</code></td>
3094
+ <td><code>String</code></td>
3095
+ <td>No</td>
3096
+ <td>Pre-existing session identifier</td>
3097
+ </tr>
3098
+ <tr>
3099
+ <td><code>auth_provider</code></td>
3100
+ <td><code>Proc</code></td>
3101
+ <td>No</td>
3102
+ <td>Callback returning Authorization header value</td>
3103
+ </tr>
3104
+ </tbody>
3105
+ </table>
3106
+ <h3 id="behavior_3">Behavior<a class="headerlink" href="#behavior_3" title="Permanent link">&para;</a></h3>
3107
+ <ul>
3108
+ <li>Creates an <code>Async::HTTP::Client</code> on connect</li>
3109
+ <li>Sends MCP <code>initialize</code> on connect; if no session ID was provided, extracts it from the server response (<code>serverInfo.sessionId</code>)</li>
3110
+ <li>Sends <code>X-Session-ID</code> header with each request when a session ID is available</li>
3111
+ <li>Calls <code>auth_provider</code> for each request to populate the <code>Authorization</code> header</li>
3112
+ <li>Exposes <code>session_id</code> reader for accessing the current session ID</li>
3113
+ <li>Raises <code>MCPError</code> if the <code>async-http</code> gem is not installed</li>
3114
+ </ul>
3115
+ <h3 id="example_3">Example<a class="headerlink" href="#example_3" title="Permanent link">&para;</a></h3>
3116
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="n">transport</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Transports</span><span class="o">::</span><span class="no">StreamableHTTP</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
3117
+ </span><span id="__span-8-2"><a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a><span class="w"> </span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;https://server.smithery.ai/neon/mcp&quot;</span><span class="p">,</span>
3118
+ </span><span id="__span-8-3"><a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a><span class="w"> </span><span class="ss">auth_provider</span><span class="p">:</span><span class="w"> </span><span class="o">-&gt;</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="s2">&quot;Bearer </span><span class="si">#{</span><span class="no">ENV</span><span class="o">[</span><span class="s1">&#39;MCP_TOKEN&#39;</span><span class="o">]</span><span class="si">}</span><span class="s2">&quot;</span><span class="w"> </span><span class="p">}</span>
3119
+ </span><span id="__span-8-4"><a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a><span class="p">)</span>
3120
+ </span><span id="__span-8-5"><a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a>
3121
+ </span><span id="__span-8-6"><a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a><span class="n">transport</span><span class="o">.</span><span class="n">connect</span>
3122
+ </span><span id="__span-8-7"><a id="__codelineno-8-7" name="__codelineno-8-7" href="#__codelineno-8-7"></a><span class="nb">puts</span><span class="w"> </span><span class="n">transport</span><span class="o">.</span><span class="n">session_id</span><span class="w"> </span><span class="c1"># =&gt; assigned by server or pre-configured</span>
3123
+ </span><span id="__span-8-8"><a id="__codelineno-8-8" name="__codelineno-8-8" href="#__codelineno-8-8"></a>
3124
+ </span><span id="__span-8-9"><a id="__codelineno-8-9" name="__codelineno-8-9" href="#__codelineno-8-9"></a><span class="n">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">transport</span><span class="o">.</span><span class="n">send_request</span><span class="p">({</span><span class="w"> </span><span class="ss">jsonrpc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2.0&quot;</span><span class="p">,</span><span class="w"> </span><span class="nb">id</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="nb">method</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;tools/list&quot;</span><span class="w"> </span><span class="p">})</span>
3125
+ </span><span id="__span-8-10"><a id="__codelineno-8-10" name="__codelineno-8-10" href="#__codelineno-8-10"></a><span class="n">transport</span><span class="o">.</span><span class="n">close</span>
3126
+ </span></code></pre></div>
3127
+ <h2 id="connection-lifecycle">Connection Lifecycle<a class="headerlink" href="#connection-lifecycle" title="Permanent link">&para;</a></h2>
3128
+ <p>All transports follow the same lifecycle:</p>
3129
+ <ol>
3130
+ <li><strong>Create</strong> -- instantiate with configuration hash</li>
3131
+ <li><strong>Connect</strong> -- establish connection and perform MCP protocol initialization</li>
3132
+ <li><strong>Request/Response</strong> -- send JSON-RPC requests, receive responses</li>
3133
+ <li><strong>Close</strong> -- tear down connection and release resources</li>
3134
+ </ol>
3135
+ <p>Each transport sends the MCP <code>initialize</code> message during connect:</p>
3136
+ <div class="language-json highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="p">{</span>
3137
+ </span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="w"> </span><span class="nt">&quot;jsonrpc&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2.0&quot;</span><span class="p">,</span>
3138
+ </span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="w"> </span><span class="nt">&quot;id&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span>
3139
+ </span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="w"> </span><span class="nt">&quot;method&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;initialize&quot;</span><span class="p">,</span>
3140
+ </span><span id="__span-9-5"><a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="w"> </span><span class="nt">&quot;params&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
3141
+ </span><span id="__span-9-6"><a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="w"> </span><span class="nt">&quot;protocolVersion&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;2024-11-05&quot;</span><span class="p">,</span>
3142
+ </span><span id="__span-9-7"><a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="w"> </span><span class="nt">&quot;capabilities&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span>
3143
+ </span><span id="__span-9-8"><a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a><span class="w"> </span><span class="nt">&quot;clientInfo&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
3144
+ </span><span id="__span-9-9"><a id="__codelineno-9-9" name="__codelineno-9-9" href="#__codelineno-9-9"></a><span class="w"> </span><span class="nt">&quot;name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;RobotLab&quot;</span><span class="p">,</span>
3145
+ </span><span id="__span-9-10"><a id="__codelineno-9-10" name="__codelineno-9-10" href="#__codelineno-9-10"></a><span class="w"> </span><span class="nt">&quot;version&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;&lt;current version&gt;&quot;</span>
3146
+ </span><span id="__span-9-11"><a id="__codelineno-9-11" name="__codelineno-9-11" href="#__codelineno-9-11"></a><span class="w"> </span><span class="p">}</span>
3147
+ </span><span id="__span-9-12"><a id="__codelineno-9-12" name="__codelineno-9-12" href="#__codelineno-9-12"></a><span class="w"> </span><span class="p">}</span>
3148
+ </span><span id="__span-9-13"><a id="__codelineno-9-13" name="__codelineno-9-13" href="#__codelineno-9-13"></a><span class="p">}</span>
3149
+ </span></code></pre></div>
3150
+ <h2 id="error-handling">Error Handling<a class="headerlink" href="#error-handling" title="Permanent link">&para;</a></h2>
3151
+ <p>All transports raise <code>RobotLab::MCPError</code> for connection and communication failures:</p>
3152
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="k">begin</span>
3153
+ </span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="w"> </span><span class="n">transport</span><span class="o">.</span><span class="n">connect</span>
3154
+ </span><span id="__span-10-3"><a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="w"> </span><span class="n">transport</span><span class="o">.</span><span class="n">send_request</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
3155
+ </span><span id="__span-10-4"><a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="k">rescue</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCPError</span><span class="w"> </span><span class="o">=&gt;</span><span class="w"> </span><span class="n">e</span>
3156
+ </span><span id="__span-10-5"><a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">&quot;Transport error: </span><span class="si">#{</span><span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="si">}</span><span class="s2">&quot;</span>
3157
+ </span><span id="__span-10-6"><a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a><span class="k">ensure</span>
3158
+ </span><span id="__span-10-7"><a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a><span class="w"> </span><span class="n">transport</span><span class="o">.</span><span class="n">close</span>
3159
+ </span><span id="__span-10-8"><a id="__codelineno-10-8" name="__codelineno-10-8" href="#__codelineno-10-8"></a><span class="k">end</span>
3160
+ </span></code></pre></div>
3161
+ <p>Specific error cases:
3162
+ - <strong>Not connected</strong> -- calling <code>send_request</code> before <code>connect</code> raises <code>MCPError</code>
3163
+ - <strong>Missing gem</strong> -- WebSocket, SSE, and HTTP transports raise <code>MCPError</code> with a <code>LoadError</code> message if required gems are not installed
3164
+ - <strong>No response</strong> -- Stdio transport raises <code>MCPError</code> if the subprocess produces no output</p>
3165
+ <h2 id="see-also">See Also<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h2>
3166
+ <ul>
3167
+ <li><a href="../">MCP Overview</a></li>
3168
+ <li><a href="../client/">MCP Client</a></li>
3169
+ <li><a href="../server/">Server Configuration</a></li>
3170
+ </ul>
3171
+
3172
+
3173
+
3174
+
3175
+
3176
+
3177
+
3178
+
3179
+
3180
+
3181
+
3182
+
3183
+
3184
+ <form class="md-feedback" name="feedback" hidden>
3185
+ <fieldset>
3186
+ <legend class="md-feedback__title">
3187
+ Was this page helpful?
3188
+ </legend>
3189
+ <div class="md-feedback__inner">
3190
+ <div class="md-feedback__list">
3191
+
3192
+ <button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
3193
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m7 0c0 .8-.7 1.5-1.5 1.5S14 10.3 14 9.5 14.7 8 15.5 8s1.5.7 1.5 1.5m-5 7.73c-1.75 0-3.29-.73-4.19-1.81L9.23 14c.45.72 1.52 1.23 2.77 1.23s2.32-.51 2.77-1.23l1.42 1.42c-.9 1.08-2.44 1.81-4.19 1.81"/></svg>
3194
+ </button>
3195
+
3196
+ <button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
3197
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10m-6.5-4c.8 0 1.5.7 1.5 1.5s-.7 1.5-1.5 1.5-1.5-.7-1.5-1.5.7-1.5 1.5-1.5M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m2 4.5c1.75 0 3.29.72 4.19 1.81l-1.42 1.42C14.32 16.5 13.25 16 12 16s-2.32.5-2.77 1.23l-1.42-1.42C8.71 14.72 10.25 14 12 14"/></svg>
3198
+ </button>
3199
+
3200
+ </div>
3201
+ <div class="md-feedback__note">
3202
+
3203
+ <div data-md-value="1" hidden>
3204
+
3205
+
3206
+
3207
+
3208
+
3209
+
3210
+
3211
+
3212
+
3213
+ Thanks for your feedback!
3214
+ </div>
3215
+
3216
+ <div data-md-value="0" hidden>
3217
+
3218
+
3219
+
3220
+
3221
+
3222
+
3223
+
3224
+
3225
+
3226
+ Thanks for your feedback! Help us improve by creating an issue.
3227
+ </div>
3228
+
3229
+ </div>
3230
+ </div>
3231
+ </fieldset>
3232
+ </form>
3233
+
3234
+
3235
+
3236
+ </article>
3237
+ </div>
3238
+
3239
+
3240
+ <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>
3241
+
3242
+ <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
3243
+ </div>
3244
+
3245
+ <button type="button" class="md-top md-icon" data-md-component="top" hidden>
3246
+
3247
+ <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>
3248
+ Back to top
3249
+ </button>
3250
+
3251
+ </main>
3252
+
3253
+ <footer class="md-footer">
3254
+
3255
+
3256
+
3257
+ <nav class="md-footer__inner md-grid" aria-label="Footer" >
3258
+
3259
+
3260
+ <a href="../server/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Server">
3261
+ <div class="md-footer__button md-icon">
3262
+
3263
+ <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>
3264
+ </div>
3265
+ <div class="md-footer__title">
3266
+ <span class="md-footer__direction">
3267
+ Previous
3268
+ </span>
3269
+ <div class="md-ellipsis">
3270
+ Server
3271
+ </div>
3272
+ </div>
3273
+ </a>
3274
+
3275
+
3276
+
3277
+ <a href="../../streaming/" class="md-footer__link md-footer__link--next" aria-label="Next: Streaming">
3278
+ <div class="md-footer__title">
3279
+ <span class="md-footer__direction">
3280
+ Next
3281
+ </span>
3282
+ <div class="md-ellipsis">
3283
+ Streaming
3284
+ </div>
3285
+ </div>
3286
+ <div class="md-footer__button md-icon">
3287
+
3288
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
3289
+ </div>
3290
+ </a>
3291
+
3292
+ </nav>
3293
+
3294
+
3295
+ <div class="md-footer-meta md-typeset">
3296
+ <div class="md-footer-meta__inner md-grid">
3297
+ <div class="md-copyright">
3298
+
3299
+ <div class="md-copyright__highlight">
3300
+ Copyright &copy; 2025 Dewayne VanHoozer
3301
+ </div>
3302
+
3303
+
3304
+ Made with
3305
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3306
+ Material for MkDocs
3307
+ </a>
3308
+
3309
+ </div>
3310
+
3311
+
3312
+ <div class="md-social">
3313
+
3314
+
3315
+
3316
+
3317
+
3318
+ <a href="https://github.com/madbomber/robot_lab" target="_blank" rel="noopener" title="RobotLab on GitHub" class="md-social__link">
3319
+ <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>
3320
+ </a>
3321
+
3322
+
3323
+
3324
+
3325
+
3326
+ <a href="https://rubygems.org/gems/robot_lab" target="_blank" rel="noopener" title="RobotLab on RubyGems" class="md-social__link">
3327
+ <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="M116.7 33.8c4.5-6.1 11.7-9.8 19.3-9.8h240c7.6 0 14.8 3.6 19.3 9.8l112 152c6.8 9.2 6.1 21.9-1.5 30.4l-232 256c-4.5 5-11 7.9-17.8 7.9s-13.2-2.9-17.8-7.9l-232-256c-7.7-8.5-8.3-21.2-1.5-30.4zm38.5 39.8c-3.3 2.5-4.2 7-2.1 10.5l57.4 95.7L63.3 192c-4.1.3-7.3 3.8-7.3 8s3.2 7.6 7.3 8l192 16h1.3l192-16c4.1-.3 7.3-3.8 7.3-8s-3.2-7.6-7.3-8l-147.2-12.3 57.4-95.6c2.1-3.5 1.2-8.1-2.1-10.5s-7.9-2-10.7 1l-90 97.6-90.1-97.6c-2.8-3-7.4-3.4-10.7-1"/></svg>
3328
+ </a>
3329
+
3330
+ </div>
3331
+
3332
+ </div>
3333
+ </div>
3334
+ </footer>
3335
+
3336
+ </div>
3337
+ <div class="md-dialog" data-md-component="dialog">
3338
+ <div class="md-dialog__inner md-typeset"></div>
3339
+ </div>
3340
+
3341
+
3342
+
3343
+
3344
+
3345
+ <script id="__config" type="application/json">{"annotate": null, "base": "../../..", "features": ["navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "navigation.path", "navigation.indexes", "navigation.top", "navigation.footer", "toc.follow", "search.suggest", "search.highlight", "search.share", "header.autohide", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.tooltips", "content.action.edit", "content.action.view"], "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>
3346
+
3347
+
3348
+ <script src="../../../assets/javascripts/bundle.79ae519e.min.js"></script>
3349
+
3350
+
3351
+ </body>
3352
+ </html>