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,3843 @@
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/core/tool/">
16
+
17
+
18
+ <link rel="prev" href="../state/">
19
+
20
+
21
+ <link rel="next" href="../memory/">
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>Tool - 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="#tool" 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
+ Tool
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
+
1291
+
1292
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1293
+
1294
+
1295
+
1296
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" checked>
1297
+
1298
+
1299
+ <div class="md-nav__link md-nav__container">
1300
+ <a href="../" class="md-nav__link ">
1301
+
1302
+
1303
+
1304
+ <span class="md-ellipsis">
1305
+
1306
+
1307
+ Core Classes
1308
+
1309
+
1310
+
1311
+ </span>
1312
+
1313
+
1314
+
1315
+ </a>
1316
+
1317
+
1318
+ <label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1319
+ <span class="md-nav__icon md-icon"></span>
1320
+ </label>
1321
+
1322
+ </div>
1323
+
1324
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="true">
1325
+ <label class="md-nav__title" for="__nav_5_2">
1326
+ <span class="md-nav__icon md-icon"></span>
1327
+
1328
+
1329
+ Core Classes
1330
+
1331
+
1332
+ </label>
1333
+ <ul class="md-nav__list" data-md-scrollfix>
1334
+
1335
+
1336
+
1337
+
1338
+
1339
+
1340
+
1341
+
1342
+
1343
+ <li class="md-nav__item">
1344
+ <a href="../robot/" class="md-nav__link">
1345
+
1346
+
1347
+
1348
+ <span class="md-ellipsis">
1349
+
1350
+
1351
+ Robot
1352
+
1353
+
1354
+
1355
+ </span>
1356
+
1357
+
1358
+
1359
+ </a>
1360
+ </li>
1361
+
1362
+
1363
+
1364
+
1365
+
1366
+
1367
+
1368
+
1369
+
1370
+
1371
+ <li class="md-nav__item">
1372
+ <a href="../network/" class="md-nav__link">
1373
+
1374
+
1375
+
1376
+ <span class="md-ellipsis">
1377
+
1378
+
1379
+ Network
1380
+
1381
+
1382
+
1383
+ </span>
1384
+
1385
+
1386
+
1387
+ </a>
1388
+ </li>
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+
1397
+
1398
+
1399
+ <li class="md-nav__item">
1400
+ <a href="../state/" class="md-nav__link">
1401
+
1402
+
1403
+
1404
+ <span class="md-ellipsis">
1405
+
1406
+
1407
+ State
1408
+
1409
+
1410
+
1411
+ </span>
1412
+
1413
+
1414
+
1415
+ </a>
1416
+ </li>
1417
+
1418
+
1419
+
1420
+
1421
+
1422
+
1423
+
1424
+
1425
+
1426
+
1427
+
1428
+
1429
+ <li class="md-nav__item md-nav__item--active">
1430
+
1431
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1432
+
1433
+
1434
+
1435
+
1436
+
1437
+ <label class="md-nav__link md-nav__link--active" for="__toc">
1438
+
1439
+
1440
+
1441
+ <span class="md-ellipsis">
1442
+
1443
+
1444
+ Tool
1445
+
1446
+
1447
+
1448
+ </span>
1449
+
1450
+
1451
+
1452
+ <span class="md-nav__icon md-icon"></span>
1453
+ </label>
1454
+
1455
+ <a href="./" class="md-nav__link md-nav__link--active">
1456
+
1457
+
1458
+
1459
+ <span class="md-ellipsis">
1460
+
1461
+
1462
+ Tool
1463
+
1464
+
1465
+
1466
+ </span>
1467
+
1468
+
1469
+
1470
+ </a>
1471
+
1472
+
1473
+
1474
+
1475
+
1476
+ <nav class="md-nav md-nav--secondary" aria-label="On this page">
1477
+
1478
+
1479
+
1480
+
1481
+
1482
+
1483
+ <label class="md-nav__title" for="__toc">
1484
+ <span class="md-nav__icon md-icon"></span>
1485
+ On this page
1486
+ </label>
1487
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1488
+
1489
+ <li class="md-nav__item">
1490
+ <a href="#class-robotlabtool-rubyllmtool" class="md-nav__link">
1491
+ <span class="md-ellipsis">
1492
+
1493
+ Class: RobotLab::Tool &lt; RubyLLM::Tool
1494
+
1495
+ </span>
1496
+ </a>
1497
+
1498
+ <nav class="md-nav" aria-label="Class: RobotLab::Tool &lt; RubyLLM::Tool">
1499
+ <ul class="md-nav__list">
1500
+
1501
+ <li class="md-nav__item">
1502
+ <a href="#subclass-pattern" class="md-nav__link">
1503
+ <span class="md-ellipsis">
1504
+
1505
+ Subclass Pattern
1506
+
1507
+ </span>
1508
+ </a>
1509
+
1510
+ </li>
1511
+
1512
+ <li class="md-nav__item">
1513
+ <a href="#factory-pattern" class="md-nav__link">
1514
+ <span class="md-ellipsis">
1515
+
1516
+ Factory Pattern
1517
+
1518
+ </span>
1519
+ </a>
1520
+
1521
+ </li>
1522
+
1523
+ </ul>
1524
+ </nav>
1525
+
1526
+ </li>
1527
+
1528
+ <li class="md-nav__item">
1529
+ <a href="#constructor" class="md-nav__link">
1530
+ <span class="md-ellipsis">
1531
+
1532
+ Constructor
1533
+
1534
+ </span>
1535
+ </a>
1536
+
1537
+ </li>
1538
+
1539
+ <li class="md-nav__item">
1540
+ <a href="#class-methods" class="md-nav__link">
1541
+ <span class="md-ellipsis">
1542
+
1543
+ Class Methods
1544
+
1545
+ </span>
1546
+ </a>
1547
+
1548
+ <nav class="md-nav" aria-label="Class Methods">
1549
+ <ul class="md-nav__list">
1550
+
1551
+ <li class="md-nav__item">
1552
+ <a href="#raise_on_error-raise_on_error" class="md-nav__link">
1553
+ <span class="md-ellipsis">
1554
+
1555
+ raise_on_error / raise_on_error?
1556
+
1557
+ </span>
1558
+ </a>
1559
+
1560
+ </li>
1561
+
1562
+ <li class="md-nav__item">
1563
+ <a href="#toolcreate" class="md-nav__link">
1564
+ <span class="md-ellipsis">
1565
+
1566
+ Tool.create
1567
+
1568
+ </span>
1569
+ </a>
1570
+
1571
+ </li>
1572
+
1573
+ </ul>
1574
+ </nav>
1575
+
1576
+ </li>
1577
+
1578
+ <li class="md-nav__item">
1579
+ <a href="#inherited-dsl-from-rubyllmtool" class="md-nav__link">
1580
+ <span class="md-ellipsis">
1581
+
1582
+ Inherited DSL (from RubyLLM::Tool)
1583
+
1584
+ </span>
1585
+ </a>
1586
+
1587
+ <nav class="md-nav" aria-label="Inherited DSL (from RubyLLM::Tool)">
1588
+ <ul class="md-nav__list">
1589
+
1590
+ <li class="md-nav__item">
1591
+ <a href="#description" class="md-nav__link">
1592
+ <span class="md-ellipsis">
1593
+
1594
+ description
1595
+
1596
+ </span>
1597
+ </a>
1598
+
1599
+ </li>
1600
+
1601
+ <li class="md-nav__item">
1602
+ <a href="#param" class="md-nav__link">
1603
+ <span class="md-ellipsis">
1604
+
1605
+ param
1606
+
1607
+ </span>
1608
+ </a>
1609
+
1610
+ </li>
1611
+
1612
+ <li class="md-nav__item">
1613
+ <a href="#execute" class="md-nav__link">
1614
+ <span class="md-ellipsis">
1615
+
1616
+ execute
1617
+
1618
+ </span>
1619
+ </a>
1620
+
1621
+ </li>
1622
+
1623
+ <li class="md-nav__item">
1624
+ <a href="#halt" class="md-nav__link">
1625
+ <span class="md-ellipsis">
1626
+
1627
+ halt
1628
+
1629
+ </span>
1630
+ </a>
1631
+
1632
+ </li>
1633
+
1634
+ <li class="md-nav__item">
1635
+ <a href="#with_params" class="md-nav__link">
1636
+ <span class="md-ellipsis">
1637
+
1638
+ with_params
1639
+
1640
+ </span>
1641
+ </a>
1642
+
1643
+ </li>
1644
+
1645
+ </ul>
1646
+ </nav>
1647
+
1648
+ </li>
1649
+
1650
+ <li class="md-nav__item">
1651
+ <a href="#attributes" class="md-nav__link">
1652
+ <span class="md-ellipsis">
1653
+
1654
+ Attributes
1655
+
1656
+ </span>
1657
+ </a>
1658
+
1659
+ <nav class="md-nav" aria-label="Attributes">
1660
+ <ul class="md-nav__list">
1661
+
1662
+ <li class="md-nav__item">
1663
+ <a href="#robot" class="md-nav__link">
1664
+ <span class="md-ellipsis">
1665
+
1666
+ robot
1667
+
1668
+ </span>
1669
+ </a>
1670
+
1671
+ </li>
1672
+
1673
+ <li class="md-nav__item">
1674
+ <a href="#mcp" class="md-nav__link">
1675
+ <span class="md-ellipsis">
1676
+
1677
+ mcp
1678
+
1679
+ </span>
1680
+ </a>
1681
+
1682
+ </li>
1683
+
1684
+ </ul>
1685
+ </nav>
1686
+
1687
+ </li>
1688
+
1689
+ <li class="md-nav__item">
1690
+ <a href="#methods" class="md-nav__link">
1691
+ <span class="md-ellipsis">
1692
+
1693
+ Methods
1694
+
1695
+ </span>
1696
+ </a>
1697
+
1698
+ <nav class="md-nav" aria-label="Methods">
1699
+ <ul class="md-nav__list">
1700
+
1701
+ <li class="md-nav__item">
1702
+ <a href="#name" class="md-nav__link">
1703
+ <span class="md-ellipsis">
1704
+
1705
+ name
1706
+
1707
+ </span>
1708
+ </a>
1709
+
1710
+ </li>
1711
+
1712
+ <li class="md-nav__item">
1713
+ <a href="#mcp_1" class="md-nav__link">
1714
+ <span class="md-ellipsis">
1715
+
1716
+ mcp?
1717
+
1718
+ </span>
1719
+ </a>
1720
+
1721
+ </li>
1722
+
1723
+ <li class="md-nav__item">
1724
+ <a href="#call" class="md-nav__link">
1725
+ <span class="md-ellipsis">
1726
+
1727
+ call
1728
+
1729
+ </span>
1730
+ </a>
1731
+
1732
+ </li>
1733
+
1734
+ <li class="md-nav__item">
1735
+ <a href="#params_schema" class="md-nav__link">
1736
+ <span class="md-ellipsis">
1737
+
1738
+ params_schema
1739
+
1740
+ </span>
1741
+ </a>
1742
+
1743
+ </li>
1744
+
1745
+ <li class="md-nav__item">
1746
+ <a href="#provider_params" class="md-nav__link">
1747
+ <span class="md-ellipsis">
1748
+
1749
+ provider_params
1750
+
1751
+ </span>
1752
+ </a>
1753
+
1754
+ </li>
1755
+
1756
+ <li class="md-nav__item">
1757
+ <a href="#to_h" class="md-nav__link">
1758
+ <span class="md-ellipsis">
1759
+
1760
+ to_h
1761
+
1762
+ </span>
1763
+ </a>
1764
+
1765
+ </li>
1766
+
1767
+ <li class="md-nav__item">
1768
+ <a href="#to_json" class="md-nav__link">
1769
+ <span class="md-ellipsis">
1770
+
1771
+ to_json
1772
+
1773
+ </span>
1774
+ </a>
1775
+
1776
+ </li>
1777
+
1778
+ <li class="md-nav__item">
1779
+ <a href="#to_json_schema" class="md-nav__link">
1780
+ <span class="md-ellipsis">
1781
+
1782
+ to_json_schema
1783
+
1784
+ </span>
1785
+ </a>
1786
+
1787
+ </li>
1788
+
1789
+ </ul>
1790
+ </nav>
1791
+
1792
+ </li>
1793
+
1794
+ <li class="md-nav__item">
1795
+ <a href="#robot-aware-tools" class="md-nav__link">
1796
+ <span class="md-ellipsis">
1797
+
1798
+ Robot-Aware Tools
1799
+
1800
+ </span>
1801
+ </a>
1802
+
1803
+ </li>
1804
+
1805
+ <li class="md-nav__item">
1806
+ <a href="#parameter-types" class="md-nav__link">
1807
+ <span class="md-ellipsis">
1808
+
1809
+ Parameter Types
1810
+
1811
+ </span>
1812
+ </a>
1813
+
1814
+ <nav class="md-nav" aria-label="Parameter Types">
1815
+ <ul class="md-nav__list">
1816
+
1817
+ <li class="md-nav__item">
1818
+ <a href="#string" class="md-nav__link">
1819
+ <span class="md-ellipsis">
1820
+
1821
+ String
1822
+
1823
+ </span>
1824
+ </a>
1825
+
1826
+ </li>
1827
+
1828
+ <li class="md-nav__item">
1829
+ <a href="#integer" class="md-nav__link">
1830
+ <span class="md-ellipsis">
1831
+
1832
+ Integer
1833
+
1834
+ </span>
1835
+ </a>
1836
+
1837
+ </li>
1838
+
1839
+ <li class="md-nav__item">
1840
+ <a href="#number-float" class="md-nav__link">
1841
+ <span class="md-ellipsis">
1842
+
1843
+ Number (Float)
1844
+
1845
+ </span>
1846
+ </a>
1847
+
1848
+ </li>
1849
+
1850
+ <li class="md-nav__item">
1851
+ <a href="#boolean" class="md-nav__link">
1852
+ <span class="md-ellipsis">
1853
+
1854
+ Boolean
1855
+
1856
+ </span>
1857
+ </a>
1858
+
1859
+ </li>
1860
+
1861
+ <li class="md-nav__item">
1862
+ <a href="#required-vs-optional" class="md-nav__link">
1863
+ <span class="md-ellipsis">
1864
+
1865
+ Required vs Optional
1866
+
1867
+ </span>
1868
+ </a>
1869
+
1870
+ </li>
1871
+
1872
+ </ul>
1873
+ </nav>
1874
+
1875
+ </li>
1876
+
1877
+ <li class="md-nav__item">
1878
+ <a href="#built-in-askuser" class="md-nav__link">
1879
+ <span class="md-ellipsis">
1880
+
1881
+ Built-in: AskUser
1882
+
1883
+ </span>
1884
+ </a>
1885
+
1886
+ <nav class="md-nav" aria-label="Built-in: AskUser">
1887
+ <ul class="md-nav__list">
1888
+
1889
+ <li class="md-nav__item">
1890
+ <a href="#class-robotlabaskuser-robotlabtool" class="md-nav__link">
1891
+ <span class="md-ellipsis">
1892
+
1893
+ Class: RobotLab::AskUser &lt; RobotLab::Tool
1894
+
1895
+ </span>
1896
+ </a>
1897
+
1898
+ </li>
1899
+
1900
+ <li class="md-nav__item">
1901
+ <a href="#parameters" class="md-nav__link">
1902
+ <span class="md-ellipsis">
1903
+
1904
+ Parameters
1905
+
1906
+ </span>
1907
+ </a>
1908
+
1909
+ </li>
1910
+
1911
+ <li class="md-nav__item">
1912
+ <a href="#io-resolution" class="md-nav__link">
1913
+ <span class="md-ellipsis">
1914
+
1915
+ IO Resolution
1916
+
1917
+ </span>
1918
+ </a>
1919
+
1920
+ </li>
1921
+
1922
+ <li class="md-nav__item">
1923
+ <a href="#terminal-output" class="md-nav__link">
1924
+ <span class="md-ellipsis">
1925
+
1926
+ Terminal Output
1927
+
1928
+ </span>
1929
+ </a>
1930
+
1931
+ </li>
1932
+
1933
+ <li class="md-nav__item">
1934
+ <a href="#usage" class="md-nav__link">
1935
+ <span class="md-ellipsis">
1936
+
1937
+ Usage
1938
+
1939
+ </span>
1940
+ </a>
1941
+
1942
+ </li>
1943
+
1944
+ <li class="md-nav__item">
1945
+ <a href="#testing-with-stringio" class="md-nav__link">
1946
+ <span class="md-ellipsis">
1947
+
1948
+ Testing with StringIO
1949
+
1950
+ </span>
1951
+ </a>
1952
+
1953
+ </li>
1954
+
1955
+ <li class="md-nav__item">
1956
+ <a href="#choice-mapping" class="md-nav__link">
1957
+ <span class="md-ellipsis">
1958
+
1959
+ Choice Mapping
1960
+
1961
+ </span>
1962
+ </a>
1963
+
1964
+ </li>
1965
+
1966
+ </ul>
1967
+ </nav>
1968
+
1969
+ </li>
1970
+
1971
+ <li class="md-nav__item">
1972
+ <a href="#see-also" class="md-nav__link">
1973
+ <span class="md-ellipsis">
1974
+
1975
+ See Also
1976
+
1977
+ </span>
1978
+ </a>
1979
+
1980
+ </li>
1981
+
1982
+ </ul>
1983
+
1984
+ </nav>
1985
+
1986
+ </li>
1987
+
1988
+
1989
+
1990
+
1991
+
1992
+
1993
+
1994
+
1995
+
1996
+
1997
+ <li class="md-nav__item">
1998
+ <a href="../memory/" class="md-nav__link">
1999
+
2000
+
2001
+
2002
+ <span class="md-ellipsis">
2003
+
2004
+
2005
+ Memory
2006
+
2007
+
2008
+
2009
+ </span>
2010
+
2011
+
2012
+
2013
+ </a>
2014
+ </li>
2015
+
2016
+
2017
+
2018
+
2019
+ </ul>
2020
+ </nav>
2021
+
2022
+ </li>
2023
+
2024
+
2025
+
2026
+
2027
+
2028
+
2029
+
2030
+
2031
+
2032
+
2033
+
2034
+
2035
+
2036
+
2037
+
2038
+
2039
+
2040
+
2041
+
2042
+
2043
+
2044
+
2045
+
2046
+
2047
+
2048
+
2049
+
2050
+
2051
+
2052
+
2053
+
2054
+
2055
+ <li class="md-nav__item md-nav__item--nested">
2056
+
2057
+
2058
+
2059
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" >
2060
+
2061
+
2062
+ <div class="md-nav__link md-nav__container">
2063
+ <a href="../../messages/" class="md-nav__link ">
2064
+
2065
+
2066
+
2067
+ <span class="md-ellipsis">
2068
+
2069
+
2070
+ Messages
2071
+
2072
+
2073
+
2074
+ </span>
2075
+
2076
+
2077
+
2078
+ </a>
2079
+
2080
+
2081
+ <label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0">
2082
+ <span class="md-nav__icon md-icon"></span>
2083
+ </label>
2084
+
2085
+ </div>
2086
+
2087
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false">
2088
+ <label class="md-nav__title" for="__nav_5_3">
2089
+ <span class="md-nav__icon md-icon"></span>
2090
+
2091
+
2092
+ Messages
2093
+
2094
+
2095
+ </label>
2096
+ <ul class="md-nav__list" data-md-scrollfix>
2097
+
2098
+
2099
+
2100
+
2101
+
2102
+
2103
+
2104
+
2105
+
2106
+ <li class="md-nav__item">
2107
+ <a href="../../messages/user-message/" class="md-nav__link">
2108
+
2109
+
2110
+
2111
+ <span class="md-ellipsis">
2112
+
2113
+
2114
+ UserMessage
2115
+
2116
+
2117
+
2118
+ </span>
2119
+
2120
+
2121
+
2122
+ </a>
2123
+ </li>
2124
+
2125
+
2126
+
2127
+
2128
+
2129
+
2130
+
2131
+
2132
+
2133
+
2134
+ <li class="md-nav__item">
2135
+ <a href="../../messages/text-message/" class="md-nav__link">
2136
+
2137
+
2138
+
2139
+ <span class="md-ellipsis">
2140
+
2141
+
2142
+ TextMessage
2143
+
2144
+
2145
+
2146
+ </span>
2147
+
2148
+
2149
+
2150
+ </a>
2151
+ </li>
2152
+
2153
+
2154
+
2155
+
2156
+
2157
+
2158
+
2159
+
2160
+
2161
+
2162
+ <li class="md-nav__item">
2163
+ <a href="../../messages/tool-call-message/" class="md-nav__link">
2164
+
2165
+
2166
+
2167
+ <span class="md-ellipsis">
2168
+
2169
+
2170
+ ToolCallMessage
2171
+
2172
+
2173
+
2174
+ </span>
2175
+
2176
+
2177
+
2178
+ </a>
2179
+ </li>
2180
+
2181
+
2182
+
2183
+
2184
+
2185
+
2186
+
2187
+
2188
+
2189
+
2190
+ <li class="md-nav__item">
2191
+ <a href="../../messages/tool-result-message/" class="md-nav__link">
2192
+
2193
+
2194
+
2195
+ <span class="md-ellipsis">
2196
+
2197
+
2198
+ ToolResultMessage
2199
+
2200
+
2201
+
2202
+ </span>
2203
+
2204
+
2205
+
2206
+ </a>
2207
+ </li>
2208
+
2209
+
2210
+
2211
+
2212
+ </ul>
2213
+ </nav>
2214
+
2215
+ </li>
2216
+
2217
+
2218
+
2219
+
2220
+
2221
+
2222
+
2223
+
2224
+
2225
+
2226
+
2227
+
2228
+
2229
+
2230
+
2231
+
2232
+
2233
+
2234
+
2235
+
2236
+
2237
+
2238
+
2239
+
2240
+
2241
+
2242
+
2243
+
2244
+
2245
+
2246
+ <li class="md-nav__item md-nav__item--nested">
2247
+
2248
+
2249
+
2250
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" >
2251
+
2252
+
2253
+ <div class="md-nav__link md-nav__container">
2254
+ <a href="../../mcp/" class="md-nav__link ">
2255
+
2256
+
2257
+
2258
+ <span class="md-ellipsis">
2259
+
2260
+
2261
+ MCP
2262
+
2263
+
2264
+
2265
+ </span>
2266
+
2267
+
2268
+
2269
+ </a>
2270
+
2271
+
2272
+ <label class="md-nav__link " for="__nav_5_4" id="__nav_5_4_label" tabindex="0">
2273
+ <span class="md-nav__icon md-icon"></span>
2274
+ </label>
2275
+
2276
+ </div>
2277
+
2278
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="false">
2279
+ <label class="md-nav__title" for="__nav_5_4">
2280
+ <span class="md-nav__icon md-icon"></span>
2281
+
2282
+
2283
+ MCP
2284
+
2285
+
2286
+ </label>
2287
+ <ul class="md-nav__list" data-md-scrollfix>
2288
+
2289
+
2290
+
2291
+
2292
+
2293
+
2294
+
2295
+
2296
+
2297
+ <li class="md-nav__item">
2298
+ <a href="../../mcp/client/" class="md-nav__link">
2299
+
2300
+
2301
+
2302
+ <span class="md-ellipsis">
2303
+
2304
+
2305
+ Client
2306
+
2307
+
2308
+
2309
+ </span>
2310
+
2311
+
2312
+
2313
+ </a>
2314
+ </li>
2315
+
2316
+
2317
+
2318
+
2319
+
2320
+
2321
+
2322
+
2323
+
2324
+
2325
+ <li class="md-nav__item">
2326
+ <a href="../../mcp/server/" class="md-nav__link">
2327
+
2328
+
2329
+
2330
+ <span class="md-ellipsis">
2331
+
2332
+
2333
+ Server
2334
+
2335
+
2336
+
2337
+ </span>
2338
+
2339
+
2340
+
2341
+ </a>
2342
+ </li>
2343
+
2344
+
2345
+
2346
+
2347
+
2348
+
2349
+
2350
+
2351
+
2352
+
2353
+ <li class="md-nav__item">
2354
+ <a href="../../mcp/transports/" class="md-nav__link">
2355
+
2356
+
2357
+
2358
+ <span class="md-ellipsis">
2359
+
2360
+
2361
+ Transports
2362
+
2363
+
2364
+
2365
+ </span>
2366
+
2367
+
2368
+
2369
+ </a>
2370
+ </li>
2371
+
2372
+
2373
+
2374
+
2375
+ </ul>
2376
+ </nav>
2377
+
2378
+ </li>
2379
+
2380
+
2381
+
2382
+
2383
+
2384
+
2385
+
2386
+
2387
+
2388
+
2389
+
2390
+
2391
+
2392
+
2393
+
2394
+
2395
+
2396
+
2397
+
2398
+
2399
+
2400
+
2401
+
2402
+
2403
+
2404
+
2405
+
2406
+
2407
+ <li class="md-nav__item md-nav__item--nested">
2408
+
2409
+
2410
+
2411
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" >
2412
+
2413
+
2414
+ <div class="md-nav__link md-nav__container">
2415
+ <a href="../../streaming/" class="md-nav__link ">
2416
+
2417
+
2418
+
2419
+ <span class="md-ellipsis">
2420
+
2421
+
2422
+ Streaming
2423
+
2424
+
2425
+
2426
+ </span>
2427
+
2428
+
2429
+
2430
+ </a>
2431
+
2432
+
2433
+ <label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
2434
+ <span class="md-nav__icon md-icon"></span>
2435
+ </label>
2436
+
2437
+ </div>
2438
+
2439
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
2440
+ <label class="md-nav__title" for="__nav_5_5">
2441
+ <span class="md-nav__icon md-icon"></span>
2442
+
2443
+
2444
+ Streaming
2445
+
2446
+
2447
+ </label>
2448
+ <ul class="md-nav__list" data-md-scrollfix>
2449
+
2450
+
2451
+
2452
+
2453
+
2454
+
2455
+
2456
+
2457
+
2458
+ <li class="md-nav__item">
2459
+ <a href="../../streaming/context/" class="md-nav__link">
2460
+
2461
+
2462
+
2463
+ <span class="md-ellipsis">
2464
+
2465
+
2466
+ Context
2467
+
2468
+
2469
+
2470
+ </span>
2471
+
2472
+
2473
+
2474
+ </a>
2475
+ </li>
2476
+
2477
+
2478
+
2479
+
2480
+
2481
+
2482
+
2483
+
2484
+
2485
+
2486
+ <li class="md-nav__item">
2487
+ <a href="../../streaming/events/" class="md-nav__link">
2488
+
2489
+
2490
+
2491
+ <span class="md-ellipsis">
2492
+
2493
+
2494
+ Events
2495
+
2496
+
2497
+
2498
+ </span>
2499
+
2500
+
2501
+
2502
+ </a>
2503
+ </li>
2504
+
2505
+
2506
+
2507
+
2508
+ </ul>
2509
+ </nav>
2510
+
2511
+ </li>
2512
+
2513
+
2514
+
2515
+
2516
+ </ul>
2517
+ </nav>
2518
+
2519
+ </li>
2520
+
2521
+
2522
+
2523
+
2524
+
2525
+
2526
+
2527
+
2528
+
2529
+
2530
+
2531
+
2532
+
2533
+
2534
+
2535
+
2536
+
2537
+
2538
+
2539
+
2540
+
2541
+
2542
+
2543
+
2544
+
2545
+
2546
+
2547
+
2548
+
2549
+
2550
+
2551
+
2552
+
2553
+ <li class="md-nav__item md-nav__item--nested">
2554
+
2555
+
2556
+
2557
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
2558
+
2559
+
2560
+ <div class="md-nav__link md-nav__container">
2561
+ <a href="../../../examples/" class="md-nav__link ">
2562
+
2563
+
2564
+
2565
+ <span class="md-ellipsis">
2566
+
2567
+
2568
+ Examples
2569
+
2570
+
2571
+
2572
+ </span>
2573
+
2574
+
2575
+
2576
+ </a>
2577
+
2578
+
2579
+ <label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
2580
+ <span class="md-nav__icon md-icon"></span>
2581
+ </label>
2582
+
2583
+ </div>
2584
+
2585
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
2586
+ <label class="md-nav__title" for="__nav_6">
2587
+ <span class="md-nav__icon md-icon"></span>
2588
+
2589
+
2590
+ Examples
2591
+
2592
+
2593
+ </label>
2594
+ <ul class="md-nav__list" data-md-scrollfix>
2595
+
2596
+
2597
+
2598
+
2599
+
2600
+
2601
+
2602
+
2603
+
2604
+ <li class="md-nav__item">
2605
+ <a href="../../../examples/basic-chat/" class="md-nav__link">
2606
+
2607
+
2608
+
2609
+ <span class="md-ellipsis">
2610
+
2611
+
2612
+ Basic Chat
2613
+
2614
+
2615
+
2616
+ </span>
2617
+
2618
+
2619
+
2620
+ </a>
2621
+ </li>
2622
+
2623
+
2624
+
2625
+
2626
+
2627
+
2628
+
2629
+
2630
+
2631
+
2632
+ <li class="md-nav__item">
2633
+ <a href="../../../examples/multi-robot-network/" class="md-nav__link">
2634
+
2635
+
2636
+
2637
+ <span class="md-ellipsis">
2638
+
2639
+
2640
+ Multi-Robot Network
2641
+
2642
+
2643
+
2644
+ </span>
2645
+
2646
+
2647
+
2648
+ </a>
2649
+ </li>
2650
+
2651
+
2652
+
2653
+
2654
+
2655
+
2656
+
2657
+
2658
+
2659
+
2660
+ <li class="md-nav__item">
2661
+ <a href="../../../examples/tool-usage/" class="md-nav__link">
2662
+
2663
+
2664
+
2665
+ <span class="md-ellipsis">
2666
+
2667
+
2668
+ Tool Usage
2669
+
2670
+
2671
+
2672
+ </span>
2673
+
2674
+
2675
+
2676
+ </a>
2677
+ </li>
2678
+
2679
+
2680
+
2681
+
2682
+
2683
+
2684
+
2685
+
2686
+
2687
+
2688
+ <li class="md-nav__item">
2689
+ <a href="../../../examples/mcp-server/" class="md-nav__link">
2690
+
2691
+
2692
+
2693
+ <span class="md-ellipsis">
2694
+
2695
+
2696
+ MCP Server
2697
+
2698
+
2699
+
2700
+ </span>
2701
+
2702
+
2703
+
2704
+ </a>
2705
+ </li>
2706
+
2707
+
2708
+
2709
+
2710
+
2711
+
2712
+
2713
+
2714
+
2715
+
2716
+ <li class="md-nav__item">
2717
+ <a href="../../../examples/rails-application/" class="md-nav__link">
2718
+
2719
+
2720
+
2721
+ <span class="md-ellipsis">
2722
+
2723
+
2724
+ Rails Application
2725
+
2726
+
2727
+
2728
+ </span>
2729
+
2730
+
2731
+
2732
+ </a>
2733
+ </li>
2734
+
2735
+
2736
+
2737
+
2738
+ </ul>
2739
+ </nav>
2740
+
2741
+ </li>
2742
+
2743
+
2744
+
2745
+ </ul>
2746
+ </nav>
2747
+ </div>
2748
+ </div>
2749
+ </div>
2750
+
2751
+
2752
+
2753
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2754
+ <div class="md-sidebar__scrollwrap">
2755
+ <div class="md-sidebar__inner">
2756
+
2757
+
2758
+
2759
+
2760
+ <nav class="md-nav md-nav--secondary" aria-label="On this page">
2761
+
2762
+
2763
+
2764
+
2765
+
2766
+
2767
+ <label class="md-nav__title" for="__toc">
2768
+ <span class="md-nav__icon md-icon"></span>
2769
+ On this page
2770
+ </label>
2771
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2772
+
2773
+ <li class="md-nav__item">
2774
+ <a href="#class-robotlabtool-rubyllmtool" class="md-nav__link">
2775
+ <span class="md-ellipsis">
2776
+
2777
+ Class: RobotLab::Tool &lt; RubyLLM::Tool
2778
+
2779
+ </span>
2780
+ </a>
2781
+
2782
+ <nav class="md-nav" aria-label="Class: RobotLab::Tool &lt; RubyLLM::Tool">
2783
+ <ul class="md-nav__list">
2784
+
2785
+ <li class="md-nav__item">
2786
+ <a href="#subclass-pattern" class="md-nav__link">
2787
+ <span class="md-ellipsis">
2788
+
2789
+ Subclass Pattern
2790
+
2791
+ </span>
2792
+ </a>
2793
+
2794
+ </li>
2795
+
2796
+ <li class="md-nav__item">
2797
+ <a href="#factory-pattern" class="md-nav__link">
2798
+ <span class="md-ellipsis">
2799
+
2800
+ Factory Pattern
2801
+
2802
+ </span>
2803
+ </a>
2804
+
2805
+ </li>
2806
+
2807
+ </ul>
2808
+ </nav>
2809
+
2810
+ </li>
2811
+
2812
+ <li class="md-nav__item">
2813
+ <a href="#constructor" class="md-nav__link">
2814
+ <span class="md-ellipsis">
2815
+
2816
+ Constructor
2817
+
2818
+ </span>
2819
+ </a>
2820
+
2821
+ </li>
2822
+
2823
+ <li class="md-nav__item">
2824
+ <a href="#class-methods" class="md-nav__link">
2825
+ <span class="md-ellipsis">
2826
+
2827
+ Class Methods
2828
+
2829
+ </span>
2830
+ </a>
2831
+
2832
+ <nav class="md-nav" aria-label="Class Methods">
2833
+ <ul class="md-nav__list">
2834
+
2835
+ <li class="md-nav__item">
2836
+ <a href="#raise_on_error-raise_on_error" class="md-nav__link">
2837
+ <span class="md-ellipsis">
2838
+
2839
+ raise_on_error / raise_on_error?
2840
+
2841
+ </span>
2842
+ </a>
2843
+
2844
+ </li>
2845
+
2846
+ <li class="md-nav__item">
2847
+ <a href="#toolcreate" class="md-nav__link">
2848
+ <span class="md-ellipsis">
2849
+
2850
+ Tool.create
2851
+
2852
+ </span>
2853
+ </a>
2854
+
2855
+ </li>
2856
+
2857
+ </ul>
2858
+ </nav>
2859
+
2860
+ </li>
2861
+
2862
+ <li class="md-nav__item">
2863
+ <a href="#inherited-dsl-from-rubyllmtool" class="md-nav__link">
2864
+ <span class="md-ellipsis">
2865
+
2866
+ Inherited DSL (from RubyLLM::Tool)
2867
+
2868
+ </span>
2869
+ </a>
2870
+
2871
+ <nav class="md-nav" aria-label="Inherited DSL (from RubyLLM::Tool)">
2872
+ <ul class="md-nav__list">
2873
+
2874
+ <li class="md-nav__item">
2875
+ <a href="#description" class="md-nav__link">
2876
+ <span class="md-ellipsis">
2877
+
2878
+ description
2879
+
2880
+ </span>
2881
+ </a>
2882
+
2883
+ </li>
2884
+
2885
+ <li class="md-nav__item">
2886
+ <a href="#param" class="md-nav__link">
2887
+ <span class="md-ellipsis">
2888
+
2889
+ param
2890
+
2891
+ </span>
2892
+ </a>
2893
+
2894
+ </li>
2895
+
2896
+ <li class="md-nav__item">
2897
+ <a href="#execute" class="md-nav__link">
2898
+ <span class="md-ellipsis">
2899
+
2900
+ execute
2901
+
2902
+ </span>
2903
+ </a>
2904
+
2905
+ </li>
2906
+
2907
+ <li class="md-nav__item">
2908
+ <a href="#halt" class="md-nav__link">
2909
+ <span class="md-ellipsis">
2910
+
2911
+ halt
2912
+
2913
+ </span>
2914
+ </a>
2915
+
2916
+ </li>
2917
+
2918
+ <li class="md-nav__item">
2919
+ <a href="#with_params" class="md-nav__link">
2920
+ <span class="md-ellipsis">
2921
+
2922
+ with_params
2923
+
2924
+ </span>
2925
+ </a>
2926
+
2927
+ </li>
2928
+
2929
+ </ul>
2930
+ </nav>
2931
+
2932
+ </li>
2933
+
2934
+ <li class="md-nav__item">
2935
+ <a href="#attributes" class="md-nav__link">
2936
+ <span class="md-ellipsis">
2937
+
2938
+ Attributes
2939
+
2940
+ </span>
2941
+ </a>
2942
+
2943
+ <nav class="md-nav" aria-label="Attributes">
2944
+ <ul class="md-nav__list">
2945
+
2946
+ <li class="md-nav__item">
2947
+ <a href="#robot" class="md-nav__link">
2948
+ <span class="md-ellipsis">
2949
+
2950
+ robot
2951
+
2952
+ </span>
2953
+ </a>
2954
+
2955
+ </li>
2956
+
2957
+ <li class="md-nav__item">
2958
+ <a href="#mcp" class="md-nav__link">
2959
+ <span class="md-ellipsis">
2960
+
2961
+ mcp
2962
+
2963
+ </span>
2964
+ </a>
2965
+
2966
+ </li>
2967
+
2968
+ </ul>
2969
+ </nav>
2970
+
2971
+ </li>
2972
+
2973
+ <li class="md-nav__item">
2974
+ <a href="#methods" class="md-nav__link">
2975
+ <span class="md-ellipsis">
2976
+
2977
+ Methods
2978
+
2979
+ </span>
2980
+ </a>
2981
+
2982
+ <nav class="md-nav" aria-label="Methods">
2983
+ <ul class="md-nav__list">
2984
+
2985
+ <li class="md-nav__item">
2986
+ <a href="#name" class="md-nav__link">
2987
+ <span class="md-ellipsis">
2988
+
2989
+ name
2990
+
2991
+ </span>
2992
+ </a>
2993
+
2994
+ </li>
2995
+
2996
+ <li class="md-nav__item">
2997
+ <a href="#mcp_1" class="md-nav__link">
2998
+ <span class="md-ellipsis">
2999
+
3000
+ mcp?
3001
+
3002
+ </span>
3003
+ </a>
3004
+
3005
+ </li>
3006
+
3007
+ <li class="md-nav__item">
3008
+ <a href="#call" class="md-nav__link">
3009
+ <span class="md-ellipsis">
3010
+
3011
+ call
3012
+
3013
+ </span>
3014
+ </a>
3015
+
3016
+ </li>
3017
+
3018
+ <li class="md-nav__item">
3019
+ <a href="#params_schema" class="md-nav__link">
3020
+ <span class="md-ellipsis">
3021
+
3022
+ params_schema
3023
+
3024
+ </span>
3025
+ </a>
3026
+
3027
+ </li>
3028
+
3029
+ <li class="md-nav__item">
3030
+ <a href="#provider_params" class="md-nav__link">
3031
+ <span class="md-ellipsis">
3032
+
3033
+ provider_params
3034
+
3035
+ </span>
3036
+ </a>
3037
+
3038
+ </li>
3039
+
3040
+ <li class="md-nav__item">
3041
+ <a href="#to_h" class="md-nav__link">
3042
+ <span class="md-ellipsis">
3043
+
3044
+ to_h
3045
+
3046
+ </span>
3047
+ </a>
3048
+
3049
+ </li>
3050
+
3051
+ <li class="md-nav__item">
3052
+ <a href="#to_json" class="md-nav__link">
3053
+ <span class="md-ellipsis">
3054
+
3055
+ to_json
3056
+
3057
+ </span>
3058
+ </a>
3059
+
3060
+ </li>
3061
+
3062
+ <li class="md-nav__item">
3063
+ <a href="#to_json_schema" class="md-nav__link">
3064
+ <span class="md-ellipsis">
3065
+
3066
+ to_json_schema
3067
+
3068
+ </span>
3069
+ </a>
3070
+
3071
+ </li>
3072
+
3073
+ </ul>
3074
+ </nav>
3075
+
3076
+ </li>
3077
+
3078
+ <li class="md-nav__item">
3079
+ <a href="#robot-aware-tools" class="md-nav__link">
3080
+ <span class="md-ellipsis">
3081
+
3082
+ Robot-Aware Tools
3083
+
3084
+ </span>
3085
+ </a>
3086
+
3087
+ </li>
3088
+
3089
+ <li class="md-nav__item">
3090
+ <a href="#parameter-types" class="md-nav__link">
3091
+ <span class="md-ellipsis">
3092
+
3093
+ Parameter Types
3094
+
3095
+ </span>
3096
+ </a>
3097
+
3098
+ <nav class="md-nav" aria-label="Parameter Types">
3099
+ <ul class="md-nav__list">
3100
+
3101
+ <li class="md-nav__item">
3102
+ <a href="#string" class="md-nav__link">
3103
+ <span class="md-ellipsis">
3104
+
3105
+ String
3106
+
3107
+ </span>
3108
+ </a>
3109
+
3110
+ </li>
3111
+
3112
+ <li class="md-nav__item">
3113
+ <a href="#integer" class="md-nav__link">
3114
+ <span class="md-ellipsis">
3115
+
3116
+ Integer
3117
+
3118
+ </span>
3119
+ </a>
3120
+
3121
+ </li>
3122
+
3123
+ <li class="md-nav__item">
3124
+ <a href="#number-float" class="md-nav__link">
3125
+ <span class="md-ellipsis">
3126
+
3127
+ Number (Float)
3128
+
3129
+ </span>
3130
+ </a>
3131
+
3132
+ </li>
3133
+
3134
+ <li class="md-nav__item">
3135
+ <a href="#boolean" class="md-nav__link">
3136
+ <span class="md-ellipsis">
3137
+
3138
+ Boolean
3139
+
3140
+ </span>
3141
+ </a>
3142
+
3143
+ </li>
3144
+
3145
+ <li class="md-nav__item">
3146
+ <a href="#required-vs-optional" class="md-nav__link">
3147
+ <span class="md-ellipsis">
3148
+
3149
+ Required vs Optional
3150
+
3151
+ </span>
3152
+ </a>
3153
+
3154
+ </li>
3155
+
3156
+ </ul>
3157
+ </nav>
3158
+
3159
+ </li>
3160
+
3161
+ <li class="md-nav__item">
3162
+ <a href="#built-in-askuser" class="md-nav__link">
3163
+ <span class="md-ellipsis">
3164
+
3165
+ Built-in: AskUser
3166
+
3167
+ </span>
3168
+ </a>
3169
+
3170
+ <nav class="md-nav" aria-label="Built-in: AskUser">
3171
+ <ul class="md-nav__list">
3172
+
3173
+ <li class="md-nav__item">
3174
+ <a href="#class-robotlabaskuser-robotlabtool" class="md-nav__link">
3175
+ <span class="md-ellipsis">
3176
+
3177
+ Class: RobotLab::AskUser &lt; RobotLab::Tool
3178
+
3179
+ </span>
3180
+ </a>
3181
+
3182
+ </li>
3183
+
3184
+ <li class="md-nav__item">
3185
+ <a href="#parameters" class="md-nav__link">
3186
+ <span class="md-ellipsis">
3187
+
3188
+ Parameters
3189
+
3190
+ </span>
3191
+ </a>
3192
+
3193
+ </li>
3194
+
3195
+ <li class="md-nav__item">
3196
+ <a href="#io-resolution" class="md-nav__link">
3197
+ <span class="md-ellipsis">
3198
+
3199
+ IO Resolution
3200
+
3201
+ </span>
3202
+ </a>
3203
+
3204
+ </li>
3205
+
3206
+ <li class="md-nav__item">
3207
+ <a href="#terminal-output" class="md-nav__link">
3208
+ <span class="md-ellipsis">
3209
+
3210
+ Terminal Output
3211
+
3212
+ </span>
3213
+ </a>
3214
+
3215
+ </li>
3216
+
3217
+ <li class="md-nav__item">
3218
+ <a href="#usage" class="md-nav__link">
3219
+ <span class="md-ellipsis">
3220
+
3221
+ Usage
3222
+
3223
+ </span>
3224
+ </a>
3225
+
3226
+ </li>
3227
+
3228
+ <li class="md-nav__item">
3229
+ <a href="#testing-with-stringio" class="md-nav__link">
3230
+ <span class="md-ellipsis">
3231
+
3232
+ Testing with StringIO
3233
+
3234
+ </span>
3235
+ </a>
3236
+
3237
+ </li>
3238
+
3239
+ <li class="md-nav__item">
3240
+ <a href="#choice-mapping" class="md-nav__link">
3241
+ <span class="md-ellipsis">
3242
+
3243
+ Choice Mapping
3244
+
3245
+ </span>
3246
+ </a>
3247
+
3248
+ </li>
3249
+
3250
+ </ul>
3251
+ </nav>
3252
+
3253
+ </li>
3254
+
3255
+ <li class="md-nav__item">
3256
+ <a href="#see-also" class="md-nav__link">
3257
+ <span class="md-ellipsis">
3258
+
3259
+ See Also
3260
+
3261
+ </span>
3262
+ </a>
3263
+
3264
+ </li>
3265
+
3266
+ </ul>
3267
+
3268
+ </nav>
3269
+ </div>
3270
+ </div>
3271
+ </div>
3272
+
3273
+
3274
+
3275
+ <div class="md-content" data-md-component="content">
3276
+
3277
+
3278
+
3279
+
3280
+
3281
+
3282
+ <nav class="md-path" aria-label="Navigation" >
3283
+ <ol class="md-path__list">
3284
+
3285
+
3286
+
3287
+
3288
+
3289
+
3290
+
3291
+ <li class="md-path__item">
3292
+ <a href="../../" class="md-path__link">
3293
+
3294
+ <span class="md-ellipsis">
3295
+ API Reference
3296
+ </span>
3297
+
3298
+ </a>
3299
+ </li>
3300
+
3301
+
3302
+
3303
+
3304
+
3305
+
3306
+
3307
+
3308
+
3309
+ <li class="md-path__item">
3310
+ <a href="../" class="md-path__link">
3311
+
3312
+ <span class="md-ellipsis">
3313
+ Core Classes
3314
+ </span>
3315
+
3316
+ </a>
3317
+ </li>
3318
+
3319
+
3320
+
3321
+
3322
+ </ol>
3323
+ </nav>
3324
+
3325
+
3326
+ <article class="md-content__inner md-typeset">
3327
+
3328
+
3329
+
3330
+
3331
+
3332
+ <a href="https://github.com/madbomber/robot_lab/edit/main/docs/api/core/tool.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
3333
+
3334
+ <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>
3335
+ </a>
3336
+
3337
+
3338
+
3339
+
3340
+
3341
+ <a href="https://github.com/madbomber/robot_lab/raw/main/docs/api/core/tool.md" title="View source of this page" class="md-content__button md-icon">
3342
+
3343
+ <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>
3344
+ </a>
3345
+
3346
+
3347
+
3348
+ <h1 id="tool">Tool<a class="headerlink" href="#tool" title="Permanent link">&para;</a></h1>
3349
+ <p>Callable function that robots can use to interact with external systems.</p>
3350
+ <h2 id="class-robotlabtool-rubyllmtool">Class: <code>RobotLab::Tool &lt; RubyLLM::Tool</code><a class="headerlink" href="#class-robotlabtool-rubyllmtool" title="Permanent link">&para;</a></h2>
3351
+ <p>RobotLab::Tool inherits from RubyLLM::Tool, adding a <code>robot:</code> constructor parameter, a <code>Tool.create</code> factory for dynamic tools, and graceful error handling that returns plain-text errors to the LLM instead of crashing the run.</p>
3352
+ <h3 id="subclass-pattern">Subclass Pattern<a class="headerlink" href="#subclass-pattern" title="Permanent link">&para;</a></h3>
3353
+ <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">GetWeather</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">Tool</span>
3354
+ </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="n">description</span><span class="w"> </span><span class="s2">&quot;Get weather for a location&quot;</span>
3355
+ </span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>
3356
+ </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="n">param</span><span class="w"> </span><span class="ss">:location</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;string&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;City name or zip code&quot;</span>
3357
+ </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="n">param</span><span class="w"> </span><span class="ss">:unit</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;string&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Temperature unit&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">required</span><span class="p">:</span><span class="w"> </span><span class="kp">false</span>
3358
+ </span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>
3359
+ </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">execute</span><span class="p">(</span><span class="ss">location</span><span class="p">:,</span><span class="w"> </span><span class="ss">unit</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;celsius&quot;</span><span class="p">)</span>
3360
+ </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="no">WeatherService</span><span class="o">.</span><span class="n">current</span><span class="p">(</span><span class="n">location</span><span class="p">,</span><span class="w"> </span><span class="ss">unit</span><span class="p">:</span><span class="w"> </span><span class="n">unit</span><span class="p">)</span>
3361
+ </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="k">end</span>
3362
+ </span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="k">end</span>
3363
+ </span></code></pre></div>
3364
+ <h3 id="factory-pattern">Factory Pattern<a class="headerlink" href="#factory-pattern" title="Permanent link">&para;</a></h3>
3365
+ <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">tool</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">Tool</span><span class="o">.</span><span class="n">create</span><span class="p">(</span>
3366
+ </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;get_weather&quot;</span><span class="p">,</span>
3367
+ </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">description</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Get current weather for a location&quot;</span><span class="p">,</span>
3368
+ </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">parameters</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
3369
+ </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">type</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;object&quot;</span><span class="p">,</span>
3370
+ </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="ss">properties</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
3371
+ </span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="ss">location</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;string&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">description</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;City name&quot;</span><span class="w"> </span><span class="p">}</span>
3372
+ </span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w"> </span><span class="p">},</span>
3373
+ </span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w"> </span><span class="ss">required</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="s2">&quot;location&quot;</span><span class="o">]</span>
3374
+ </span><span id="__span-1-10"><a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w"> </span><span class="p">}</span>
3375
+ </span><span id="__span-1-11"><a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">args</span><span class="o">|</span><span class="w"> </span><span class="no">WeatherService</span><span class="o">.</span><span class="n">current</span><span class="p">(</span><span class="n">args</span><span class="o">[</span><span class="ss">:location</span><span class="o">]</span><span class="p">)</span><span class="w"> </span><span class="p">}</span>
3376
+ </span></code></pre></div>
3377
+ <h2 id="constructor">Constructor<a class="headerlink" href="#constructor" title="Permanent link">&para;</a></h2>
3378
+ <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="no">Tool</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="ss">robot</span><span class="p">:</span><span class="w"> </span><span class="kp">nil</span><span class="p">)</span>
3379
+ </span></code></pre></div>
3380
+ <p><strong>Parameters:</strong></p>
3381
+ <table>
3382
+ <thead>
3383
+ <tr>
3384
+ <th>Name</th>
3385
+ <th>Type</th>
3386
+ <th>Description</th>
3387
+ </tr>
3388
+ </thead>
3389
+ <tbody>
3390
+ <tr>
3391
+ <td><code>robot</code></td>
3392
+ <td><code>Robot, nil</code></td>
3393
+ <td>The owning robot instance</td>
3394
+ </tr>
3395
+ </tbody>
3396
+ </table>
3397
+ <h2 id="class-methods">Class Methods<a class="headerlink" href="#class-methods" title="Permanent link">&para;</a></h2>
3398
+ <h3 id="raise_on_error-raise_on_error">raise_on_error / raise_on_error?<a class="headerlink" href="#raise_on_error-raise_on_error" title="Permanent link">&para;</a></h3>
3399
+ <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="no">MyTool</span><span class="o">.</span><span class="n">raise_on_error</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">true</span>
3400
+ </span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="no">MyTool</span><span class="o">.</span><span class="n">raise_on_error?</span><span class="w"> </span><span class="c1"># =&gt; true</span>
3401
+ </span></code></pre></div>
3402
+ <p>Per-class flag controlling whether <code>call</code> propagates exceptions from <code>execute</code> instead of catching them. Defaults to <code>false</code>. Does not affect other tool classes.</p>
3403
+ <h3 id="toolcreate">Tool.create<a class="headerlink" href="#toolcreate" title="Permanent link">&para;</a></h3>
3404
+ <p>Factory for dynamic tools (MCP wrappers, inline tools).</p>
3405
+ <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="no">Tool</span><span class="o">.</span><span class="n">create</span><span class="p">(</span>
3406
+ </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="nb">name</span><span class="p">:,</span>
3407
+ </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="ss">description</span><span class="p">:</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span>
3408
+ </span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w"> </span><span class="ss">parameters</span><span class="p">:</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span>
3409
+ </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="ss">mcp</span><span class="p">:</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span>
3410
+ </span><span id="__span-4-6"><a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="w"> </span><span class="ss">robot</span><span class="p">:</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span>
3411
+ </span><span id="__span-4-7"><a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="w"> </span><span class="o">&amp;</span><span class="n">handler</span>
3412
+ </span><span id="__span-4-8"><a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="p">)</span>
3413
+ </span></code></pre></div>
3414
+ <p><strong>Parameters:</strong></p>
3415
+ <table>
3416
+ <thead>
3417
+ <tr>
3418
+ <th>Name</th>
3419
+ <th>Type</th>
3420
+ <th>Description</th>
3421
+ </tr>
3422
+ </thead>
3423
+ <tbody>
3424
+ <tr>
3425
+ <td><code>name</code></td>
3426
+ <td><code>String, Symbol</code></td>
3427
+ <td>Tool identifier</td>
3428
+ </tr>
3429
+ <tr>
3430
+ <td><code>description</code></td>
3431
+ <td><code>String</code></td>
3432
+ <td>What the tool does</td>
3433
+ </tr>
3434
+ <tr>
3435
+ <td><code>parameters</code></td>
3436
+ <td><code>Hash</code></td>
3437
+ <td>JSON Schema parameter definition</td>
3438
+ </tr>
3439
+ <tr>
3440
+ <td><code>mcp</code></td>
3441
+ <td><code>String</code></td>
3442
+ <td>MCP server name</td>
3443
+ </tr>
3444
+ <tr>
3445
+ <td><code>robot</code></td>
3446
+ <td><code>Robot</code></td>
3447
+ <td>Owning robot instance</td>
3448
+ </tr>
3449
+ <tr>
3450
+ <td><code>&amp;handler</code></td>
3451
+ <td><code>Block</code></td>
3452
+ <td>Receives <code>args</code> hash, returns result</td>
3453
+ </tr>
3454
+ </tbody>
3455
+ </table>
3456
+ <h2 id="inherited-dsl-from-rubyllmtool">Inherited DSL (from RubyLLM::Tool)<a class="headerlink" href="#inherited-dsl-from-rubyllmtool" title="Permanent link">&para;</a></h2>
3457
+ <h3 id="description">description<a class="headerlink" href="#description" title="Permanent link">&para;</a></h3>
3458
+ <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="k">class</span><span class="w"> </span><span class="nc">MyTool</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">Tool</span>
3459
+ </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="n">description</span><span class="w"> </span><span class="s2">&quot;What this tool does&quot;</span>
3460
+ </span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="k">end</span>
3461
+ </span></code></pre></div>
3462
+ <h3 id="param">param<a class="headerlink" href="#param" title="Permanent link">&para;</a></h3>
3463
+ <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="k">class</span><span class="w"> </span><span class="nc">MyTool</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">Tool</span>
3464
+ </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="n">param</span><span class="w"> </span><span class="ss">:name</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;string&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;User&#39;s name&quot;</span>
3465
+ </span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:age</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;integer&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;User&#39;s age&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">required</span><span class="p">:</span><span class="w"> </span><span class="kp">false</span>
3466
+ </span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="k">end</span>
3467
+ </span></code></pre></div>
3468
+ <h3 id="execute">execute<a class="headerlink" href="#execute" title="Permanent link">&para;</a></h3>
3469
+ <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="k">class</span><span class="w"> </span><span class="nc">MyTool</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">Tool</span>
3470
+ </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="k">def</span><span class="w"> </span><span class="nf">execute</span><span class="p">(</span><span class="nb">name</span><span class="p">:,</span><span class="w"> </span><span class="ss">age</span><span class="p">:</span><span class="w"> </span><span class="kp">nil</span><span class="p">)</span>
3471
+ </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="c1"># Implementation</span>
3472
+ </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="k">end</span>
3473
+ </span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="k">end</span>
3474
+ </span></code></pre></div>
3475
+ <h3 id="halt">halt<a class="headerlink" href="#halt" title="Permanent link">&para;</a></h3>
3476
+ <p>Stop the tool use loop from within execute:</p>
3477
+ <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="k">def</span><span class="w"> </span><span class="nf">execute</span><span class="p">(</span><span class="o">**</span><span class="p">)</span>
3478
+ </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="n">halt</span><span class="p">(</span><span class="s2">&quot;Done processing&quot;</span><span class="p">)</span>
3479
+ </span><span id="__span-8-3"><a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a><span class="k">end</span>
3480
+ </span></code></pre></div>
3481
+ <h3 id="with_params">with_params<a class="headerlink" href="#with_params" title="Permanent link">&para;</a></h3>
3482
+ <p>Set provider-specific parameters:</p>
3483
+ <div class="language-ruby 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="k">class</span><span class="w"> </span><span class="nc">MyTool</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">Tool</span>
3484
+ </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="n">with_params</span><span class="p">(</span><span class="ss">strict</span><span class="p">:</span><span class="w"> </span><span class="kp">true</span><span class="p">)</span>
3485
+ </span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="k">end</span>
3486
+ </span></code></pre></div>
3487
+ <h2 id="attributes">Attributes<a class="headerlink" href="#attributes" title="Permanent link">&para;</a></h2>
3488
+ <h3 id="robot">robot<a class="headerlink" href="#robot" title="Permanent link">&para;</a></h3>
3489
+ <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="n">tool</span><span class="o">.</span><span class="n">robot</span><span class="w"> </span><span class="c1"># =&gt; Robot or nil</span>
3490
+ </span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="n">tool</span><span class="o">.</span><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">some_robot</span>
3491
+ </span></code></pre></div>
3492
+ <p>Read/write accessor for the owning robot. Set via constructor or assigned later.</p>
3493
+ <h3 id="mcp">mcp<a class="headerlink" href="#mcp" title="Permanent link">&para;</a></h3>
3494
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="n">tool</span><span class="o">.</span><span class="n">mcp</span><span class="w"> </span><span class="c1"># =&gt; String or nil</span>
3495
+ </span></code></pre></div>
3496
+ <p>The MCP server name, set via <code>Tool.create(mcp: "server_name")</code>.</p>
3497
+ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">&para;</a></h2>
3498
+ <h3 id="name">name<a class="headerlink" href="#name" title="Permanent link">&para;</a></h3>
3499
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="n">tool</span><span class="o">.</span><span class="n">name</span><span class="w"> </span><span class="c1"># =&gt; String</span>
3500
+ </span></code></pre></div>
3501
+ <p>Returns the tool name. For subclasses, derived from the class name (CamelCase to snake_case). For <code>create</code>d tools, returns the explicit name.</p>
3502
+ <h3 id="mcp_1">mcp?<a class="headerlink" href="#mcp_1" title="Permanent link">&para;</a></h3>
3503
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="n">tool</span><span class="o">.</span><span class="n">mcp?</span><span class="w"> </span><span class="c1"># =&gt; Boolean</span>
3504
+ </span></code></pre></div>
3505
+ <p>Whether this is an MCP-provided tool.</p>
3506
+ <h3 id="call">call<a class="headerlink" href="#call" title="Permanent link">&para;</a></h3>
3507
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tool</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">args_hash</span><span class="p">)</span>
3508
+ </span></code></pre></div>
3509
+ <p>Overrides <code>RubyLLM::Tool#call</code> with graceful error handling. Converts string keys to symbols and calls <code>execute(**args)</code>. If <code>execute</code> raises a <code>StandardError</code>, the error is caught and returned as a plain-text string the LLM can reason about:</p>
3510
+ <div class="language-text highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>Error (tool_name): exception message
3511
+ </span></code></pre></div>
3512
+ <p>The error is also logged via <code>RobotLab.config.logger</code> at <code>:warn</code> level.</p>
3513
+ <p>To propagate exceptions instead of catching them (for critical tools), set <code>raise_on_error</code> on the class:</p>
3514
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-16-1"><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">CriticalTool</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">Tool</span>
3515
+ </span><span id="__span-16-2"><a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a><span class="w"> </span><span class="nb">self</span><span class="o">.</span><span class="n">raise_on_error</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="kp">true</span>
3516
+ </span><span id="__span-16-3"><a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a><span class="w"> </span><span class="c1"># ...</span>
3517
+ </span><span id="__span-16-4"><a id="__codelineno-16-4" name="__codelineno-16-4" href="#__codelineno-16-4"></a><span class="k">end</span>
3518
+ </span></code></pre></div>
3519
+ <p><code>raise_on_error</code> is per-class (defaults to <code>false</code>) and does not affect other tool classes.</p>
3520
+ <h3 id="params_schema">params_schema<a class="headerlink" href="#params_schema" title="Permanent link">&para;</a></h3>
3521
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="n">tool</span><span class="o">.</span><span class="n">params_schema</span><span class="w"> </span><span class="c1"># =&gt; Hash or nil</span>
3522
+ </span></code></pre></div>
3523
+ <p>Inherited. Returns the JSON Schema for tool parameters.</p>
3524
+ <h3 id="provider_params">provider_params<a class="headerlink" href="#provider_params" title="Permanent link">&para;</a></h3>
3525
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-18-1"><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="n">tool</span><span class="o">.</span><span class="n">provider_params</span><span class="w"> </span><span class="c1"># =&gt; Hash</span>
3526
+ </span></code></pre></div>
3527
+ <p>Inherited. Returns provider-specific parameters (e.g., <code>{ strict: true }</code>).</p>
3528
+ <h3 id="to_h">to_h<a class="headerlink" href="#to_h" title="Permanent link">&para;</a></h3>
3529
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="n">tool</span><span class="o">.</span><span class="n">to_h</span><span class="w"> </span><span class="c1"># =&gt; Hash</span>
3530
+ </span></code></pre></div>
3531
+ <p>Hash representation with <code>:name</code>, <code>:description</code>, <code>:mcp</code>.</p>
3532
+ <h3 id="to_json">to_json<a class="headerlink" href="#to_json" title="Permanent link">&para;</a></h3>
3533
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-20-1"><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="n">tool</span><span class="o">.</span><span class="n">to_json</span><span class="w"> </span><span class="c1"># =&gt; String</span>
3534
+ </span></code></pre></div>
3535
+ <p>JSON representation.</p>
3536
+ <h3 id="to_json_schema">to_json_schema<a class="headerlink" href="#to_json_schema" title="Permanent link">&para;</a></h3>
3537
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-21-1"><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="n">tool</span><span class="o">.</span><span class="n">to_json_schema</span><span class="w"> </span><span class="c1"># =&gt; Hash</span>
3538
+ </span></code></pre></div>
3539
+ <p>JSON Schema representation for LLM function calling. Returns <code>{ name:, description:, parameters: }</code>.</p>
3540
+ <h2 id="robot-aware-tools">Robot-Aware Tools<a class="headerlink" href="#robot-aware-tools" title="Permanent link">&para;</a></h2>
3541
+ <p>Tools that modify their owning robot use the <code>robot</code> accessor:</p>
3542
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-22-1"><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">AdjustTemperature</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">Tool</span>
3543
+ </span><span id="__span-22-2"><a id="__codelineno-22-2" name="__codelineno-22-2" href="#__codelineno-22-2"></a><span class="w"> </span><span class="n">description</span><span class="w"> </span><span class="s2">&quot;Adjust the robot&#39;s creativity level&quot;</span>
3544
+ </span><span id="__span-22-3"><a id="__codelineno-22-3" name="__codelineno-22-3" href="#__codelineno-22-3"></a>
3545
+ </span><span id="__span-22-4"><a id="__codelineno-22-4" name="__codelineno-22-4" href="#__codelineno-22-4"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:level</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;number&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Temperature from 0.0 to 1.0&quot;</span>
3546
+ </span><span id="__span-22-5"><a id="__codelineno-22-5" name="__codelineno-22-5" href="#__codelineno-22-5"></a>
3547
+ </span><span id="__span-22-6"><a id="__codelineno-22-6" name="__codelineno-22-6" href="#__codelineno-22-6"></a><span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">execute</span><span class="p">(</span><span class="ss">level</span><span class="p">:)</span>
3548
+ </span><span id="__span-22-7"><a id="__codelineno-22-7" name="__codelineno-22-7" href="#__codelineno-22-7"></a><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">with_temperature</span><span class="p">(</span><span class="n">level</span><span class="p">)</span>
3549
+ </span><span id="__span-22-8"><a id="__codelineno-22-8" name="__codelineno-22-8" href="#__codelineno-22-8"></a><span class="w"> </span><span class="s2">&quot;Temperature adjusted to </span><span class="si">#{</span><span class="n">level</span><span class="si">}</span><span class="s2">&quot;</span>
3550
+ </span><span id="__span-22-9"><a id="__codelineno-22-9" name="__codelineno-22-9" href="#__codelineno-22-9"></a><span class="w"> </span><span class="k">end</span>
3551
+ </span><span id="__span-22-10"><a id="__codelineno-22-10" name="__codelineno-22-10" href="#__codelineno-22-10"></a><span class="k">end</span>
3552
+ </span><span id="__span-22-11"><a id="__codelineno-22-11" name="__codelineno-22-11" href="#__codelineno-22-11"></a>
3553
+ </span><span id="__span-22-12"><a id="__codelineno-22-12" name="__codelineno-22-12" href="#__codelineno-22-12"></a><span class="c1"># Pass robot: self when constructing</span>
3554
+ </span><span id="__span-22-13"><a id="__codelineno-22-13" name="__codelineno-22-13" href="#__codelineno-22-13"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
3555
+ </span><span id="__span-22-14"><a id="__codelineno-22-14" name="__codelineno-22-14" href="#__codelineno-22-14"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;creative_bot&quot;</span><span class="p">,</span>
3556
+ </span><span id="__span-22-15"><a id="__codelineno-22-15" name="__codelineno-22-15" href="#__codelineno-22-15"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;You are creative.&quot;</span><span class="p">,</span>
3557
+ </span><span id="__span-22-16"><a id="__codelineno-22-16" name="__codelineno-22-16" href="#__codelineno-22-16"></a><span class="w"> </span><span class="ss">local_tools</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="no">AdjustTemperature</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="ss">robot</span><span class="p">:</span><span class="w"> </span><span class="nb">self</span><span class="p">)</span><span class="o">]</span>
3558
+ </span><span id="__span-22-17"><a id="__codelineno-22-17" name="__codelineno-22-17" href="#__codelineno-22-17"></a><span class="p">)</span>
3559
+ </span></code></pre></div>
3560
+ <h2 id="parameter-types">Parameter Types<a class="headerlink" href="#parameter-types" title="Permanent link">&para;</a></h2>
3561
+ <h3 id="string">String<a class="headerlink" href="#string" title="Permanent link">&para;</a></h3>
3562
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-23-1"><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a><span class="n">param</span><span class="w"> </span><span class="ss">:name</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;string&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;User&#39;s full name&quot;</span>
3563
+ </span></code></pre></div>
3564
+ <h3 id="integer">Integer<a class="headerlink" href="#integer" title="Permanent link">&para;</a></h3>
3565
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-24-1"><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a><span class="n">param</span><span class="w"> </span><span class="ss">:count</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;integer&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Number of results&quot;</span>
3566
+ </span></code></pre></div>
3567
+ <h3 id="number-float">Number (Float)<a class="headerlink" href="#number-float" title="Permanent link">&para;</a></h3>
3568
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-25-1"><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a><span class="n">param</span><span class="w"> </span><span class="ss">:price</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;number&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Price in dollars&quot;</span>
3569
+ </span></code></pre></div>
3570
+ <h3 id="boolean">Boolean<a class="headerlink" href="#boolean" title="Permanent link">&para;</a></h3>
3571
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-26-1"><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a><span class="n">param</span><span class="w"> </span><span class="ss">:active</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;boolean&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Whether the user is active&quot;</span>
3572
+ </span></code></pre></div>
3573
+ <h3 id="required-vs-optional">Required vs Optional<a class="headerlink" href="#required-vs-optional" title="Permanent link">&para;</a></h3>
3574
+ <p>Parameters are required by default. Mark optional with <code>required: false</code>:</p>
3575
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-27-1"><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a><span class="n">param</span><span class="w"> </span><span class="ss">:query</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;string&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Search query&quot;</span><span class="w"> </span><span class="c1"># required</span>
3576
+ </span><span id="__span-27-2"><a id="__codelineno-27-2" name="__codelineno-27-2" href="#__codelineno-27-2"></a><span class="n">param</span><span class="w"> </span><span class="ss">:limit</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;integer&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Max results&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">required</span><span class="p">:</span><span class="w"> </span><span class="kp">false</span><span class="w"> </span><span class="c1"># optional</span>
3577
+ </span></code></pre></div>
3578
+ <h2 id="built-in-askuser">Built-in: AskUser<a class="headerlink" href="#built-in-askuser" title="Permanent link">&para;</a></h2>
3579
+ <p><code>RobotLab::AskUser</code> is a built-in tool that lets a robot ask the user a question via the terminal. The LLM decides when human input is needed and calls this tool.</p>
3580
+ <h3 id="class-robotlabaskuser-robotlabtool">Class: <code>RobotLab::AskUser &lt; RobotLab::Tool</code><a class="headerlink" href="#class-robotlabaskuser-robotlabtool" title="Permanent link">&para;</a></h3>
3581
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-28-1"><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">RobotLab</span><span class="o">::</span><span class="no">AskUser</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">Tool</span>
3582
+ </span><span id="__span-28-2"><a id="__codelineno-28-2" name="__codelineno-28-2" href="#__codelineno-28-2"></a><span class="w"> </span><span class="n">description</span><span class="w"> </span><span class="s2">&quot;Ask the user a question and wait for their typed response&quot;</span>
3583
+ </span><span id="__span-28-3"><a id="__codelineno-28-3" name="__codelineno-28-3" href="#__codelineno-28-3"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:question</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;string&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;The question to ask the user&quot;</span>
3584
+ </span><span id="__span-28-4"><a id="__codelineno-28-4" name="__codelineno-28-4" href="#__codelineno-28-4"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:choices</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;array&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Optional list of choices to present&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">required</span><span class="p">:</span><span class="w"> </span><span class="kp">false</span>
3585
+ </span><span id="__span-28-5"><a id="__codelineno-28-5" name="__codelineno-28-5" href="#__codelineno-28-5"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:default</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;string&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Default value if user presses Enter&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">required</span><span class="p">:</span><span class="w"> </span><span class="kp">false</span>
3586
+ </span><span id="__span-28-6"><a id="__codelineno-28-6" name="__codelineno-28-6" href="#__codelineno-28-6"></a><span class="k">end</span>
3587
+ </span></code></pre></div>
3588
+ <h3 id="parameters">Parameters<a class="headerlink" href="#parameters" title="Permanent link">&para;</a></h3>
3589
+ <table>
3590
+ <thead>
3591
+ <tr>
3592
+ <th>Name</th>
3593
+ <th>Type</th>
3594
+ <th>Required</th>
3595
+ <th>Description</th>
3596
+ </tr>
3597
+ </thead>
3598
+ <tbody>
3599
+ <tr>
3600
+ <td><code>question</code></td>
3601
+ <td><code>String</code></td>
3602
+ <td>Yes</td>
3603
+ <td>The question to display</td>
3604
+ </tr>
3605
+ <tr>
3606
+ <td><code>choices</code></td>
3607
+ <td><code>Array</code></td>
3608
+ <td>No</td>
3609
+ <td>Numbered choices to present</td>
3610
+ </tr>
3611
+ <tr>
3612
+ <td><code>default</code></td>
3613
+ <td><code>String</code></td>
3614
+ <td>No</td>
3615
+ <td>Value returned when user presses Enter without typing</td>
3616
+ </tr>
3617
+ </tbody>
3618
+ </table>
3619
+ <h3 id="io-resolution">IO Resolution<a class="headerlink" href="#io-resolution" title="Permanent link">&para;</a></h3>
3620
+ <p>The tool reads input and writes output using the owning robot's <code>input</code>/<code>output</code> accessors:</p>
3621
+ <ol>
3622
+ <li><code>robot.input</code> / <code>robot.output</code> if set</li>
3623
+ <li>Falls back to <code>$stdin</code> / <code>$stdout</code></li>
3624
+ </ol>
3625
+ <h3 id="terminal-output">Terminal Output<a class="headerlink" href="#terminal-output" title="Permanent link">&para;</a></h3>
3626
+ <div class="language-text highlight"><pre><span></span><code><span id="__span-29-1"><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a>[robot_name] What programming language do you want to learn?
3627
+ </span><span id="__span-29-2"><a id="__codelineno-29-2" name="__codelineno-29-2" href="#__codelineno-29-2"></a> 1. Ruby
3628
+ </span><span id="__span-29-3"><a id="__codelineno-29-3" name="__codelineno-29-3" href="#__codelineno-29-3"></a> 2. Python
3629
+ </span><span id="__span-29-4"><a id="__codelineno-29-4" name="__codelineno-29-4" href="#__codelineno-29-4"></a> 3. Go
3630
+ </span><span id="__span-29-5"><a id="__codelineno-29-5" name="__codelineno-29-5" href="#__codelineno-29-5"></a>&gt; [Ruby]
3631
+ </span></code></pre></div>
3632
+ <h3 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">&para;</a></h3>
3633
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-30-1"><a id="__codelineno-30-1" name="__codelineno-30-1" href="#__codelineno-30-1"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
3634
+ </span><span id="__span-30-2"><a id="__codelineno-30-2" name="__codelineno-30-2" href="#__codelineno-30-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;interviewer&quot;</span><span class="p">,</span>
3635
+ </span><span id="__span-30-3"><a id="__codelineno-30-3" name="__codelineno-30-3" href="#__codelineno-30-3"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Interview the user about their project needs. Use ask_user to gather information.&quot;</span><span class="p">,</span>
3636
+ </span><span id="__span-30-4"><a id="__codelineno-30-4" name="__codelineno-30-4" href="#__codelineno-30-4"></a><span class="w"> </span><span class="ss">local_tools</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="no">RobotLab</span><span class="o">::</span><span class="no">AskUser</span><span class="o">]</span>
3637
+ </span><span id="__span-30-5"><a id="__codelineno-30-5" name="__codelineno-30-5" href="#__codelineno-30-5"></a><span class="p">)</span>
3638
+ </span><span id="__span-30-6"><a id="__codelineno-30-6" name="__codelineno-30-6" href="#__codelineno-30-6"></a><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">&quot;Find out what the user wants to build&quot;</span><span class="p">)</span>
3639
+ </span></code></pre></div>
3640
+ <h3 id="testing-with-stringio">Testing with StringIO<a class="headerlink" href="#testing-with-stringio" title="Permanent link">&para;</a></h3>
3641
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-31-1"><a id="__codelineno-31-1" name="__codelineno-31-1" href="#__codelineno-31-1"></a><span class="n">robot</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">Robot</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;bot&quot;</span><span class="p">,</span><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>
3642
+ </span><span id="__span-31-2"><a id="__codelineno-31-2" name="__codelineno-31-2" href="#__codelineno-31-2"></a><span class="n">robot</span><span class="o">.</span><span class="n">input</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">StringIO</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="s2">&quot;Ruby</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
3643
+ </span><span id="__span-31-3"><a id="__codelineno-31-3" name="__codelineno-31-3" href="#__codelineno-31-3"></a><span class="n">robot</span><span class="o">.</span><span class="n">output</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">StringIO</span><span class="o">.</span><span class="n">new</span>
3644
+ </span><span id="__span-31-4"><a id="__codelineno-31-4" name="__codelineno-31-4" href="#__codelineno-31-4"></a>
3645
+ </span><span id="__span-31-5"><a id="__codelineno-31-5" name="__codelineno-31-5" href="#__codelineno-31-5"></a><span class="n">tool</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">AskUser</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="ss">robot</span><span class="p">:</span><span class="w"> </span><span class="n">robot</span><span class="p">)</span>
3646
+ </span><span id="__span-31-6"><a id="__codelineno-31-6" name="__codelineno-31-6" href="#__codelineno-31-6"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tool</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="s2">&quot;question&quot;</span><span class="w"> </span><span class="o">=&gt;</span><span class="w"> </span><span class="s2">&quot;Pick a language:&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;choices&quot;</span><span class="w"> </span><span class="o">=&gt;</span><span class="w"> </span><span class="o">[</span><span class="s2">&quot;Ruby&quot;</span><span class="p">,</span><span class="w"> </span><span class="s2">&quot;Python&quot;</span><span class="o">]</span><span class="p">)</span>
3647
+ </span><span id="__span-31-7"><a id="__codelineno-31-7" name="__codelineno-31-7" href="#__codelineno-31-7"></a><span class="c1"># =&gt; &quot;Ruby&quot;</span>
3648
+ </span></code></pre></div>
3649
+ <h3 id="choice-mapping">Choice Mapping<a class="headerlink" href="#choice-mapping" title="Permanent link">&para;</a></h3>
3650
+ <p>When <code>choices</code> are provided, the user can type either:</p>
3651
+ <ul>
3652
+ <li>A <strong>number</strong> (e.g., <code>2</code>) — mapped to the corresponding choice text</li>
3653
+ <li><strong>Text</strong> (e.g., <code>Python</code>) — returned as-is</li>
3654
+ </ul>
3655
+ <p>Out-of-range numbers are returned as-is (the LLM can re-ask if needed).</p>
3656
+ <h2 id="see-also">See Also<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h2>
3657
+ <ul>
3658
+ <li><a href="../../../guides/using-tools/">Using Tools Guide</a></li>
3659
+ <li><a href="../robot/">Robot</a></li>
3660
+ <li><a href="../../../guides/mcp-integration/">MCP Integration</a></li>
3661
+ </ul>
3662
+
3663
+
3664
+
3665
+
3666
+
3667
+
3668
+
3669
+
3670
+
3671
+
3672
+
3673
+
3674
+
3675
+ <form class="md-feedback" name="feedback" hidden>
3676
+ <fieldset>
3677
+ <legend class="md-feedback__title">
3678
+ Was this page helpful?
3679
+ </legend>
3680
+ <div class="md-feedback__inner">
3681
+ <div class="md-feedback__list">
3682
+
3683
+ <button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
3684
+ <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>
3685
+ </button>
3686
+
3687
+ <button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
3688
+ <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>
3689
+ </button>
3690
+
3691
+ </div>
3692
+ <div class="md-feedback__note">
3693
+
3694
+ <div data-md-value="1" hidden>
3695
+
3696
+
3697
+
3698
+
3699
+
3700
+
3701
+
3702
+
3703
+
3704
+ Thanks for your feedback!
3705
+ </div>
3706
+
3707
+ <div data-md-value="0" hidden>
3708
+
3709
+
3710
+
3711
+
3712
+
3713
+
3714
+
3715
+
3716
+
3717
+ Thanks for your feedback! Help us improve by creating an issue.
3718
+ </div>
3719
+
3720
+ </div>
3721
+ </div>
3722
+ </fieldset>
3723
+ </form>
3724
+
3725
+
3726
+
3727
+ </article>
3728
+ </div>
3729
+
3730
+
3731
+ <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>
3732
+
3733
+ <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
3734
+ </div>
3735
+
3736
+ <button type="button" class="md-top md-icon" data-md-component="top" hidden>
3737
+
3738
+ <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>
3739
+ Back to top
3740
+ </button>
3741
+
3742
+ </main>
3743
+
3744
+ <footer class="md-footer">
3745
+
3746
+
3747
+
3748
+ <nav class="md-footer__inner md-grid" aria-label="Footer" >
3749
+
3750
+
3751
+ <a href="../state/" class="md-footer__link md-footer__link--prev" aria-label="Previous: State">
3752
+ <div class="md-footer__button md-icon">
3753
+
3754
+ <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>
3755
+ </div>
3756
+ <div class="md-footer__title">
3757
+ <span class="md-footer__direction">
3758
+ Previous
3759
+ </span>
3760
+ <div class="md-ellipsis">
3761
+ State
3762
+ </div>
3763
+ </div>
3764
+ </a>
3765
+
3766
+
3767
+
3768
+ <a href="../memory/" class="md-footer__link md-footer__link--next" aria-label="Next: Memory">
3769
+ <div class="md-footer__title">
3770
+ <span class="md-footer__direction">
3771
+ Next
3772
+ </span>
3773
+ <div class="md-ellipsis">
3774
+ Memory
3775
+ </div>
3776
+ </div>
3777
+ <div class="md-footer__button md-icon">
3778
+
3779
+ <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>
3780
+ </div>
3781
+ </a>
3782
+
3783
+ </nav>
3784
+
3785
+
3786
+ <div class="md-footer-meta md-typeset">
3787
+ <div class="md-footer-meta__inner md-grid">
3788
+ <div class="md-copyright">
3789
+
3790
+ <div class="md-copyright__highlight">
3791
+ Copyright &copy; 2025 Dewayne VanHoozer
3792
+ </div>
3793
+
3794
+
3795
+ Made with
3796
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3797
+ Material for MkDocs
3798
+ </a>
3799
+
3800
+ </div>
3801
+
3802
+
3803
+ <div class="md-social">
3804
+
3805
+
3806
+
3807
+
3808
+
3809
+ <a href="https://github.com/madbomber/robot_lab" target="_blank" rel="noopener" title="RobotLab on GitHub" class="md-social__link">
3810
+ <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>
3811
+ </a>
3812
+
3813
+
3814
+
3815
+
3816
+
3817
+ <a href="https://rubygems.org/gems/robot_lab" target="_blank" rel="noopener" title="RobotLab on RubyGems" class="md-social__link">
3818
+ <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>
3819
+ </a>
3820
+
3821
+ </div>
3822
+
3823
+ </div>
3824
+ </div>
3825
+ </footer>
3826
+
3827
+ </div>
3828
+ <div class="md-dialog" data-md-component="dialog">
3829
+ <div class="md-dialog__inner md-typeset"></div>
3830
+ </div>
3831
+
3832
+
3833
+
3834
+
3835
+
3836
+ <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>
3837
+
3838
+
3839
+ <script src="../../../assets/javascripts/bundle.79ae519e.min.js"></script>
3840
+
3841
+
3842
+ </body>
3843
+ </html>