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,2783 @@
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/">
16
+
17
+
18
+ <link rel="prev" href="../messages/tool-result-message/">
19
+
20
+
21
+ <link rel="next" href="client/">
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>MCP (Model Context Protocol) - 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-model-context-protocol" 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
+ MCP (Model Context Protocol)
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 md-nav__link--active">
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 md-nav__link--active" 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
+ <li class="md-nav__item">
1812
+ <a href="transports/" class="md-nav__link">
1813
+
1814
+
1815
+
1816
+ <span class="md-ellipsis">
1817
+
1818
+
1819
+ Transports
1820
+
1821
+
1822
+
1823
+ </span>
1824
+
1825
+
1826
+
1827
+ </a>
1828
+ </li>
1829
+
1830
+
1831
+
1832
+
1833
+ </ul>
1834
+ </nav>
1835
+
1836
+ </li>
1837
+
1838
+
1839
+
1840
+
1841
+
1842
+
1843
+
1844
+
1845
+
1846
+
1847
+
1848
+
1849
+
1850
+
1851
+
1852
+
1853
+
1854
+
1855
+
1856
+
1857
+
1858
+
1859
+
1860
+
1861
+
1862
+
1863
+
1864
+
1865
+ <li class="md-nav__item md-nav__item--nested">
1866
+
1867
+
1868
+
1869
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" >
1870
+
1871
+
1872
+ <div class="md-nav__link md-nav__container">
1873
+ <a href="../streaming/" class="md-nav__link ">
1874
+
1875
+
1876
+
1877
+ <span class="md-ellipsis">
1878
+
1879
+
1880
+ Streaming
1881
+
1882
+
1883
+
1884
+ </span>
1885
+
1886
+
1887
+
1888
+ </a>
1889
+
1890
+
1891
+ <label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
1892
+ <span class="md-nav__icon md-icon"></span>
1893
+ </label>
1894
+
1895
+ </div>
1896
+
1897
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
1898
+ <label class="md-nav__title" for="__nav_5_5">
1899
+ <span class="md-nav__icon md-icon"></span>
1900
+
1901
+
1902
+ Streaming
1903
+
1904
+
1905
+ </label>
1906
+ <ul class="md-nav__list" data-md-scrollfix>
1907
+
1908
+
1909
+
1910
+
1911
+
1912
+
1913
+
1914
+
1915
+
1916
+ <li class="md-nav__item">
1917
+ <a href="../streaming/context/" class="md-nav__link">
1918
+
1919
+
1920
+
1921
+ <span class="md-ellipsis">
1922
+
1923
+
1924
+ Context
1925
+
1926
+
1927
+
1928
+ </span>
1929
+
1930
+
1931
+
1932
+ </a>
1933
+ </li>
1934
+
1935
+
1936
+
1937
+
1938
+
1939
+
1940
+
1941
+
1942
+
1943
+
1944
+ <li class="md-nav__item">
1945
+ <a href="../streaming/events/" class="md-nav__link">
1946
+
1947
+
1948
+
1949
+ <span class="md-ellipsis">
1950
+
1951
+
1952
+ Events
1953
+
1954
+
1955
+
1956
+ </span>
1957
+
1958
+
1959
+
1960
+ </a>
1961
+ </li>
1962
+
1963
+
1964
+
1965
+
1966
+ </ul>
1967
+ </nav>
1968
+
1969
+ </li>
1970
+
1971
+
1972
+
1973
+
1974
+ </ul>
1975
+ </nav>
1976
+
1977
+ </li>
1978
+
1979
+
1980
+
1981
+
1982
+
1983
+
1984
+
1985
+
1986
+
1987
+
1988
+
1989
+
1990
+
1991
+
1992
+
1993
+
1994
+
1995
+
1996
+
1997
+
1998
+
1999
+
2000
+
2001
+
2002
+
2003
+
2004
+
2005
+
2006
+
2007
+
2008
+
2009
+
2010
+
2011
+ <li class="md-nav__item md-nav__item--nested">
2012
+
2013
+
2014
+
2015
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
2016
+
2017
+
2018
+ <div class="md-nav__link md-nav__container">
2019
+ <a href="../../examples/" class="md-nav__link ">
2020
+
2021
+
2022
+
2023
+ <span class="md-ellipsis">
2024
+
2025
+
2026
+ Examples
2027
+
2028
+
2029
+
2030
+ </span>
2031
+
2032
+
2033
+
2034
+ </a>
2035
+
2036
+
2037
+ <label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
2038
+ <span class="md-nav__icon md-icon"></span>
2039
+ </label>
2040
+
2041
+ </div>
2042
+
2043
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
2044
+ <label class="md-nav__title" for="__nav_6">
2045
+ <span class="md-nav__icon md-icon"></span>
2046
+
2047
+
2048
+ Examples
2049
+
2050
+
2051
+ </label>
2052
+ <ul class="md-nav__list" data-md-scrollfix>
2053
+
2054
+
2055
+
2056
+
2057
+
2058
+
2059
+
2060
+
2061
+
2062
+ <li class="md-nav__item">
2063
+ <a href="../../examples/basic-chat/" class="md-nav__link">
2064
+
2065
+
2066
+
2067
+ <span class="md-ellipsis">
2068
+
2069
+
2070
+ Basic Chat
2071
+
2072
+
2073
+
2074
+ </span>
2075
+
2076
+
2077
+
2078
+ </a>
2079
+ </li>
2080
+
2081
+
2082
+
2083
+
2084
+
2085
+
2086
+
2087
+
2088
+
2089
+
2090
+ <li class="md-nav__item">
2091
+ <a href="../../examples/multi-robot-network/" class="md-nav__link">
2092
+
2093
+
2094
+
2095
+ <span class="md-ellipsis">
2096
+
2097
+
2098
+ Multi-Robot Network
2099
+
2100
+
2101
+
2102
+ </span>
2103
+
2104
+
2105
+
2106
+ </a>
2107
+ </li>
2108
+
2109
+
2110
+
2111
+
2112
+
2113
+
2114
+
2115
+
2116
+
2117
+
2118
+ <li class="md-nav__item">
2119
+ <a href="../../examples/tool-usage/" class="md-nav__link">
2120
+
2121
+
2122
+
2123
+ <span class="md-ellipsis">
2124
+
2125
+
2126
+ Tool Usage
2127
+
2128
+
2129
+
2130
+ </span>
2131
+
2132
+
2133
+
2134
+ </a>
2135
+ </li>
2136
+
2137
+
2138
+
2139
+
2140
+
2141
+
2142
+
2143
+
2144
+
2145
+
2146
+ <li class="md-nav__item">
2147
+ <a href="../../examples/mcp-server/" class="md-nav__link">
2148
+
2149
+
2150
+
2151
+ <span class="md-ellipsis">
2152
+
2153
+
2154
+ MCP Server
2155
+
2156
+
2157
+
2158
+ </span>
2159
+
2160
+
2161
+
2162
+ </a>
2163
+ </li>
2164
+
2165
+
2166
+
2167
+
2168
+
2169
+
2170
+
2171
+
2172
+
2173
+
2174
+ <li class="md-nav__item">
2175
+ <a href="../../examples/rails-application/" class="md-nav__link">
2176
+
2177
+
2178
+
2179
+ <span class="md-ellipsis">
2180
+
2181
+
2182
+ Rails Application
2183
+
2184
+
2185
+
2186
+ </span>
2187
+
2188
+
2189
+
2190
+ </a>
2191
+ </li>
2192
+
2193
+
2194
+
2195
+
2196
+ </ul>
2197
+ </nav>
2198
+
2199
+ </li>
2200
+
2201
+
2202
+
2203
+ </ul>
2204
+ </nav>
2205
+ </div>
2206
+ </div>
2207
+ </div>
2208
+
2209
+
2210
+
2211
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2212
+ <div class="md-sidebar__scrollwrap">
2213
+ <div class="md-sidebar__inner">
2214
+
2215
+
2216
+
2217
+
2218
+ <nav class="md-nav md-nav--secondary" aria-label="On this page">
2219
+
2220
+
2221
+
2222
+
2223
+
2224
+
2225
+ <label class="md-nav__title" for="__toc">
2226
+ <span class="md-nav__icon md-icon"></span>
2227
+ On this page
2228
+ </label>
2229
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2230
+
2231
+ <li class="md-nav__item">
2232
+ <a href="#overview" class="md-nav__link">
2233
+ <span class="md-ellipsis">
2234
+
2235
+ Overview
2236
+
2237
+ </span>
2238
+ </a>
2239
+
2240
+ </li>
2241
+
2242
+ <li class="md-nav__item">
2243
+ <a href="#components" class="md-nav__link">
2244
+ <span class="md-ellipsis">
2245
+
2246
+ Components
2247
+
2248
+ </span>
2249
+ </a>
2250
+
2251
+ </li>
2252
+
2253
+ <li class="md-nav__item">
2254
+ <a href="#quick-start" class="md-nav__link">
2255
+ <span class="md-ellipsis">
2256
+
2257
+ Quick Start
2258
+
2259
+ </span>
2260
+ </a>
2261
+
2262
+ <nav class="md-nav" aria-label="Quick Start">
2263
+ <ul class="md-nav__list">
2264
+
2265
+ <li class="md-nav__item">
2266
+ <a href="#using-mcp-with-a-robot" class="md-nav__link">
2267
+ <span class="md-ellipsis">
2268
+
2269
+ Using MCP with a Robot
2270
+
2271
+ </span>
2272
+ </a>
2273
+
2274
+ </li>
2275
+
2276
+ <li class="md-nav__item">
2277
+ <a href="#mcp-in-networks" class="md-nav__link">
2278
+ <span class="md-ellipsis">
2279
+
2280
+ MCP in Networks
2281
+
2282
+ </span>
2283
+ </a>
2284
+
2285
+ </li>
2286
+
2287
+ <li class="md-nav__item">
2288
+ <a href="#direct-client-usage" class="md-nav__link">
2289
+ <span class="md-ellipsis">
2290
+
2291
+ Direct Client Usage
2292
+
2293
+ </span>
2294
+ </a>
2295
+
2296
+ </li>
2297
+
2298
+ </ul>
2299
+ </nav>
2300
+
2301
+ </li>
2302
+
2303
+ <li class="md-nav__item">
2304
+ <a href="#transport-types" class="md-nav__link">
2305
+ <span class="md-ellipsis">
2306
+
2307
+ Transport Types
2308
+
2309
+ </span>
2310
+ </a>
2311
+
2312
+ </li>
2313
+
2314
+ <li class="md-nav__item">
2315
+ <a href="#mcp-parameter-values" class="md-nav__link">
2316
+ <span class="md-ellipsis">
2317
+
2318
+ MCP Parameter Values
2319
+
2320
+ </span>
2321
+ </a>
2322
+
2323
+ </li>
2324
+
2325
+ <li class="md-nav__item">
2326
+ <a href="#error-handling" class="md-nav__link">
2327
+ <span class="md-ellipsis">
2328
+
2329
+ Error Handling
2330
+
2331
+ </span>
2332
+ </a>
2333
+
2334
+ </li>
2335
+
2336
+ <li class="md-nav__item">
2337
+ <a href="#see-also" class="md-nav__link">
2338
+ <span class="md-ellipsis">
2339
+
2340
+ See Also
2341
+
2342
+ </span>
2343
+ </a>
2344
+
2345
+ </li>
2346
+
2347
+ </ul>
2348
+
2349
+ </nav>
2350
+ </div>
2351
+ </div>
2352
+ </div>
2353
+
2354
+
2355
+
2356
+ <div class="md-content" data-md-component="content">
2357
+
2358
+
2359
+
2360
+
2361
+
2362
+
2363
+ <nav class="md-path" aria-label="Navigation" >
2364
+ <ol class="md-path__list">
2365
+
2366
+
2367
+
2368
+
2369
+
2370
+
2371
+
2372
+ <li class="md-path__item">
2373
+ <a href="../" class="md-path__link">
2374
+
2375
+ <span class="md-ellipsis">
2376
+ API Reference
2377
+ </span>
2378
+
2379
+ </a>
2380
+ </li>
2381
+
2382
+
2383
+
2384
+
2385
+
2386
+
2387
+
2388
+
2389
+
2390
+ <li class="md-path__item">
2391
+ <a href="./" class="md-path__link">
2392
+
2393
+ <span class="md-ellipsis">
2394
+ MCP
2395
+ </span>
2396
+
2397
+ </a>
2398
+ </li>
2399
+
2400
+
2401
+
2402
+
2403
+ </ol>
2404
+ </nav>
2405
+
2406
+
2407
+ <article class="md-content__inner md-typeset">
2408
+
2409
+
2410
+
2411
+
2412
+
2413
+ <a href="https://github.com/madbomber/robot_lab/edit/main/docs/api/mcp/index.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
2414
+
2415
+ <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>
2416
+ </a>
2417
+
2418
+
2419
+
2420
+
2421
+
2422
+ <a href="https://github.com/madbomber/robot_lab/raw/main/docs/api/mcp/index.md" title="View source of this page" class="md-content__button md-icon">
2423
+
2424
+ <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>
2425
+ </a>
2426
+
2427
+
2428
+
2429
+ <h1 id="mcp-model-context-protocol">MCP (Model Context Protocol)<a class="headerlink" href="#mcp-model-context-protocol" title="Permanent link">&para;</a></h1>
2430
+ <p>Integration with MCP servers for extended tool capabilities.</p>
2431
+ <h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">&para;</a></h2>
2432
+ <p>MCP allows robots to connect to external tool servers, extending their capabilities without modifying robot code. RobotLab provides an MCP client that communicates with MCP-compliant servers over multiple transport types.</p>
2433
+ <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="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Robot</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
2434
+ </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="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;developer&quot;</span><span class="p">,</span>
2435
+ </span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;You help with coding tasks.&quot;</span><span class="p">,</span>
2436
+ </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="ss">mcp</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
2437
+ </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="p">{</span>
2438
+ </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="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;filesystem&quot;</span><span class="p">,</span>
2439
+ </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="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><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><span class="w"> </span><span class="ss">command</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;npx @modelcontextprotocol/server-filesystem&quot;</span><span class="w"> </span><span class="p">}</span>
2440
+ </span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w"> </span><span class="p">}</span>
2441
+ </span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="w"> </span><span class="o">]</span>
2442
+ </span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="p">)</span>
2443
+ </span></code></pre></div>
2444
+ <h2 id="components">Components<a class="headerlink" href="#components" title="Permanent link">&para;</a></h2>
2445
+ <table>
2446
+ <thead>
2447
+ <tr>
2448
+ <th>Component</th>
2449
+ <th>Description</th>
2450
+ </tr>
2451
+ </thead>
2452
+ <tbody>
2453
+ <tr>
2454
+ <td><a href="client/">Client</a></td>
2455
+ <td>Connects to MCP servers, lists tools, calls tools</td>
2456
+ </tr>
2457
+ <tr>
2458
+ <td><a href="server/">Server</a></td>
2459
+ <td>Server configuration data structure</td>
2460
+ </tr>
2461
+ <tr>
2462
+ <td><a href="transports/">Transports</a></td>
2463
+ <td>Communication methods (stdio, WebSocket, SSE, HTTP)</td>
2464
+ </tr>
2465
+ </tbody>
2466
+ </table>
2467
+ <h2 id="quick-start">Quick Start<a class="headerlink" href="#quick-start" title="Permanent link">&para;</a></h2>
2468
+ <h3 id="using-mcp-with-a-robot">Using MCP with a Robot<a class="headerlink" href="#using-mcp-with-a-robot" title="Permanent link">&para;</a></h3>
2469
+ <p>Pass MCP server configurations via the <code>mcp:</code> parameter when creating a robot:</p>
2470
+ <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="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Robot</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
2471
+ </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="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;assistant&quot;</span><span class="p">,</span>
2472
+ </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">template</span><span class="p">:</span><span class="w"> </span><span class="ss">:assistant</span><span class="p">,</span>
2473
+ </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">mcp</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
2474
+ </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="p">{</span><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;github&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><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><span class="w"> </span><span class="ss">command</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;mcp-server-github&quot;</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">}</span>
2475
+ </span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="o">]</span>
2476
+ </span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="p">)</span>
2477
+ </span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>
2478
+ </span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">&quot;List my open pull requests&quot;</span><span class="p">)</span>
2479
+ </span><span id="__span-1-10"><a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="n">result</span><span class="o">.</span><span class="n">last_text_content</span>
2480
+ </span></code></pre></div>
2481
+ <h3 id="mcp-in-networks">MCP in Networks<a class="headerlink" href="#mcp-in-networks" title="Permanent link">&para;</a></h3>
2482
+ <p>Robots in a network can inherit MCP servers from the network or define their own:</p>
2483
+ <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">network_mcp</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span>
2484
+ </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="p">{</span><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;github&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><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><span class="w"> </span><span class="ss">command</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;mcp-server-github&quot;</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">}</span>
2485
+ </span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="o">]</span>
2486
+ </span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a>
2487
+ </span><span id="__span-2-5"><a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Robot</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
2488
+ </span><span id="__span-2-6"><a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;assistant&quot;</span><span class="p">,</span>
2489
+ </span><span id="__span-2-7"><a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="w"> </span><span class="ss">template</span><span class="p">:</span><span class="w"> </span><span class="ss">:assistant</span><span class="p">,</span>
2490
+ </span><span id="__span-2-8"><a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="w"> </span><span class="ss">mcp</span><span class="p">:</span><span class="w"> </span><span class="ss">:inherit</span><span class="w"> </span><span class="c1"># Use network&#39;s MCP servers</span>
2491
+ </span><span id="__span-2-9"><a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="p">)</span>
2492
+ </span></code></pre></div>
2493
+ <h3 id="direct-client-usage">Direct Client Usage<a class="headerlink" href="#direct-client-usage" title="Permanent link">&para;</a></h3>
2494
+ <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="n">client</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">Client</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
2495
+ </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="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;filesystem&quot;</span><span class="p">,</span>
2496
+ </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">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><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><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="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="w"> </span><span class="p">}</span>
2497
+ </span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a><span class="p">)</span>
2498
+ </span><span id="__span-3-5"><a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a>
2499
+ </span><span id="__span-3-6"><a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a><span class="n">client</span><span class="o">.</span><span class="n">connect</span>
2500
+ </span><span id="__span-3-7"><a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="n">tools</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">client</span><span class="o">.</span><span class="n">list_tools</span>
2501
+ </span><span id="__span-3-8"><a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">client</span><span class="o">.</span><span class="n">call_tool</span><span class="p">(</span><span class="s2">&quot;readFile&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">path</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;/data/config.yml&quot;</span><span class="w"> </span><span class="p">})</span>
2502
+ </span><span id="__span-3-9"><a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a><span class="n">client</span><span class="o">.</span><span class="n">disconnect</span>
2503
+ </span></code></pre></div>
2504
+ <h2 id="transport-types">Transport Types<a class="headerlink" href="#transport-types" title="Permanent link">&para;</a></h2>
2505
+ <table>
2506
+ <thead>
2507
+ <tr>
2508
+ <th>Type</th>
2509
+ <th>Config Key</th>
2510
+ <th>Use Case</th>
2511
+ </tr>
2512
+ </thead>
2513
+ <tbody>
2514
+ <tr>
2515
+ <td><code>stdio</code></td>
2516
+ <td><code>"stdio"</code></td>
2517
+ <td>Local command/subprocess execution</td>
2518
+ </tr>
2519
+ <tr>
2520
+ <td><code>websocket</code></td>
2521
+ <td><code>"ws"</code> or <code>"websocket"</code></td>
2522
+ <td>Real-time bidirectional communication</td>
2523
+ </tr>
2524
+ <tr>
2525
+ <td><code>sse</code></td>
2526
+ <td><code>"sse"</code></td>
2527
+ <td>Server-sent events streaming</td>
2528
+ </tr>
2529
+ <tr>
2530
+ <td><code>streamable-http</code></td>
2531
+ <td><code>"streamable-http"</code> or <code>"http"</code></td>
2532
+ <td>HTTP request/response with session support</td>
2533
+ </tr>
2534
+ </tbody>
2535
+ </table>
2536
+ <h2 id="mcp-parameter-values">MCP Parameter Values<a class="headerlink" href="#mcp-parameter-values" title="Permanent link">&para;</a></h2>
2537
+ <p>The <code>mcp:</code> parameter on a Robot accepts three types of values:</p>
2538
+ <table>
2539
+ <thead>
2540
+ <tr>
2541
+ <th>Value</th>
2542
+ <th>Meaning</th>
2543
+ </tr>
2544
+ </thead>
2545
+ <tbody>
2546
+ <tr>
2547
+ <td><code>:none</code></td>
2548
+ <td>No MCP servers (explicitly disabled)</td>
2549
+ </tr>
2550
+ <tr>
2551
+ <td><code>:inherit</code></td>
2552
+ <td>Use the network's MCP servers</td>
2553
+ </tr>
2554
+ <tr>
2555
+ <td><code>Array&lt;Hash&gt;</code></td>
2556
+ <td>Explicit list of server configurations</td>
2557
+ </tr>
2558
+ </tbody>
2559
+ </table>
2560
+ <p>Each server configuration hash requires:</p>
2561
+ <table>
2562
+ <thead>
2563
+ <tr>
2564
+ <th>Key</th>
2565
+ <th>Type</th>
2566
+ <th>Description</th>
2567
+ </tr>
2568
+ </thead>
2569
+ <tbody>
2570
+ <tr>
2571
+ <td><code>name</code></td>
2572
+ <td><code>String</code></td>
2573
+ <td>Unique server identifier</td>
2574
+ </tr>
2575
+ <tr>
2576
+ <td><code>transport</code></td>
2577
+ <td><code>Hash</code></td>
2578
+ <td>Transport configuration (must include <code>type</code>)</td>
2579
+ </tr>
2580
+ </tbody>
2581
+ </table>
2582
+ <h2 id="error-handling">Error Handling<a class="headerlink" href="#error-handling" title="Permanent link">&para;</a></h2>
2583
+ <p>MCP operations raise <code>RobotLab::MCPError</code> when:</p>
2584
+ <ul>
2585
+ <li>Connection to a server fails</li>
2586
+ <li>A request is made without an active connection</li>
2587
+ <li>An unsupported transport type is specified</li>
2588
+ </ul>
2589
+ <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="k">begin</span>
2590
+ </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="n">client</span><span class="o">.</span><span class="n">connect</span>
2591
+ </span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span><span class="n">client</span><span class="o">.</span><span class="n">call_tool</span><span class="p">(</span><span class="s2">&quot;unknown_tool&quot;</span><span class="p">,</span><span class="w"> </span><span class="p">{})</span>
2592
+ </span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-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>
2593
+ </span><span id="__span-4-5"><a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">&quot;MCP 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>
2594
+ </span><span id="__span-4-6"><a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="k">end</span>
2595
+ </span></code></pre></div>
2596
+ <h2 id="see-also">See Also<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h2>
2597
+ <ul>
2598
+ <li><a href="client/">MCP Client</a></li>
2599
+ <li><a href="server/">MCP Server</a></li>
2600
+ <li><a href="transports/">Transports</a></li>
2601
+ </ul>
2602
+
2603
+
2604
+
2605
+
2606
+
2607
+
2608
+
2609
+
2610
+
2611
+
2612
+
2613
+
2614
+
2615
+ <form class="md-feedback" name="feedback" hidden>
2616
+ <fieldset>
2617
+ <legend class="md-feedback__title">
2618
+ Was this page helpful?
2619
+ </legend>
2620
+ <div class="md-feedback__inner">
2621
+ <div class="md-feedback__list">
2622
+
2623
+ <button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
2624
+ <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>
2625
+ </button>
2626
+
2627
+ <button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
2628
+ <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>
2629
+ </button>
2630
+
2631
+ </div>
2632
+ <div class="md-feedback__note">
2633
+
2634
+ <div data-md-value="1" hidden>
2635
+
2636
+
2637
+
2638
+
2639
+
2640
+
2641
+
2642
+
2643
+
2644
+ Thanks for your feedback!
2645
+ </div>
2646
+
2647
+ <div data-md-value="0" hidden>
2648
+
2649
+
2650
+
2651
+
2652
+
2653
+
2654
+
2655
+
2656
+
2657
+ Thanks for your feedback! Help us improve by creating an issue.
2658
+ </div>
2659
+
2660
+ </div>
2661
+ </div>
2662
+ </fieldset>
2663
+ </form>
2664
+
2665
+
2666
+
2667
+ </article>
2668
+ </div>
2669
+
2670
+
2671
+ <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>
2672
+
2673
+ <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
2674
+ </div>
2675
+
2676
+ <button type="button" class="md-top md-icon" data-md-component="top" hidden>
2677
+
2678
+ <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>
2679
+ Back to top
2680
+ </button>
2681
+
2682
+ </main>
2683
+
2684
+ <footer class="md-footer">
2685
+
2686
+
2687
+
2688
+ <nav class="md-footer__inner md-grid" aria-label="Footer" >
2689
+
2690
+
2691
+ <a href="../messages/tool-result-message/" class="md-footer__link md-footer__link--prev" aria-label="Previous: ToolResultMessage">
2692
+ <div class="md-footer__button md-icon">
2693
+
2694
+ <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>
2695
+ </div>
2696
+ <div class="md-footer__title">
2697
+ <span class="md-footer__direction">
2698
+ Previous
2699
+ </span>
2700
+ <div class="md-ellipsis">
2701
+ ToolResultMessage
2702
+ </div>
2703
+ </div>
2704
+ </a>
2705
+
2706
+
2707
+
2708
+ <a href="client/" class="md-footer__link md-footer__link--next" aria-label="Next: Client">
2709
+ <div class="md-footer__title">
2710
+ <span class="md-footer__direction">
2711
+ Next
2712
+ </span>
2713
+ <div class="md-ellipsis">
2714
+ Client
2715
+ </div>
2716
+ </div>
2717
+ <div class="md-footer__button md-icon">
2718
+
2719
+ <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>
2720
+ </div>
2721
+ </a>
2722
+
2723
+ </nav>
2724
+
2725
+
2726
+ <div class="md-footer-meta md-typeset">
2727
+ <div class="md-footer-meta__inner md-grid">
2728
+ <div class="md-copyright">
2729
+
2730
+ <div class="md-copyright__highlight">
2731
+ Copyright &copy; 2025 Dewayne VanHoozer
2732
+ </div>
2733
+
2734
+
2735
+ Made with
2736
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
2737
+ Material for MkDocs
2738
+ </a>
2739
+
2740
+ </div>
2741
+
2742
+
2743
+ <div class="md-social">
2744
+
2745
+
2746
+
2747
+
2748
+
2749
+ <a href="https://github.com/madbomber/robot_lab" target="_blank" rel="noopener" title="RobotLab on GitHub" class="md-social__link">
2750
+ <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>
2751
+ </a>
2752
+
2753
+
2754
+
2755
+
2756
+
2757
+ <a href="https://rubygems.org/gems/robot_lab" target="_blank" rel="noopener" title="RobotLab on RubyGems" class="md-social__link">
2758
+ <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>
2759
+ </a>
2760
+
2761
+ </div>
2762
+
2763
+ </div>
2764
+ </div>
2765
+ </footer>
2766
+
2767
+ </div>
2768
+ <div class="md-dialog" data-md-component="dialog">
2769
+ <div class="md-dialog__inner md-typeset"></div>
2770
+ </div>
2771
+
2772
+
2773
+
2774
+
2775
+
2776
+ <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>
2777
+
2778
+
2779
+ <script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
2780
+
2781
+
2782
+ </body>
2783
+ </html>