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.
- checksums.yaml +4 -4
- data/.architecture/AGENTS.md +32 -0
- data/.architecture/config.yml +8 -0
- data/.architecture/members.yml +60 -0
- data/.architecture/reviews/feature-free-will.md +490 -0
- data/.architecture/reviews/overall-codebase.md +427 -0
- data/.claude/settings.local.json +57 -0
- data/.codex/config.toml +2 -0
- data/.irbrc +2 -2
- data/.rubocop.yml +172 -0
- data/CHANGELOG.md +72 -0
- data/CLAUDE.md +139 -0
- data/README.md +91 -95
- data/Rakefile +109 -3
- data/agent2agent_review.md +192 -0
- data/agentf_improvements.md +253 -0
- data/agents.md +14 -0
- data/docs/examples/index.md +37 -2
- data/docs/getting-started/configuration.md +20 -7
- data/docs/guides/index.md +16 -16
- data/docs/guides/knowledge.md +7 -1
- data/docs/guides/observability.md +132 -0
- data/docs/index.md +30 -3
- data/docs/superpowers/plans/2026-05-06-agentskills.md +1303 -0
- data/docs/superpowers/specs/2026-05-06-agentskills-design.md +247 -0
- data/examples/.envrc +1 -0
- data/examples/01_simple_robot.rb +5 -9
- data/examples/02_tools.rb +5 -9
- data/examples/03_network.rb +8 -9
- data/examples/04_mcp.rb +21 -29
- data/examples/05_streaming.rb +12 -18
- data/examples/06_prompt_templates.rb +11 -19
- data/examples/07_network_memory.rb +16 -31
- data/examples/08_llm_config.rb +10 -22
- data/examples/09_chaining.rb +16 -27
- data/examples/10_memory.rb +12 -28
- data/examples/11_network_introspection.rb +15 -29
- data/examples/12_message_bus.rb +5 -12
- data/examples/13_spawn.rb +5 -10
- data/examples/14_rusty_circuit/.envrc +1 -0
- data/examples/14_rusty_circuit/comic.rb +2 -0
- data/examples/14_rusty_circuit/heckler.rb +1 -1
- data/examples/14_rusty_circuit/open_mic.rb +1 -3
- data/examples/14_rusty_circuit/scout.rb +2 -0
- data/examples/15_memory_network_and_bus/.envrc +1 -0
- data/examples/15_memory_network_and_bus/editorial_pipeline.rb +6 -3
- data/examples/15_memory_network_and_bus/linux_writer.rb +1 -1
- data/examples/15_memory_network_and_bus/output/combined_article.md +6 -6
- data/examples/15_memory_network_and_bus/output/final_article.md +6 -8
- data/examples/15_memory_network_and_bus/output/linux_draft.md +4 -2
- data/examples/15_memory_network_and_bus/output/mac_draft.md +3 -3
- data/examples/15_memory_network_and_bus/output/memory.json +6 -6
- data/examples/15_memory_network_and_bus/output/revision_1.md +10 -11
- data/examples/15_memory_network_and_bus/output/revision_2.md +6 -8
- data/examples/15_memory_network_and_bus/output/windows_draft.md +3 -3
- data/examples/16_writers_room/.envrc +1 -0
- data/examples/16_writers_room/writers_room.rb +2 -4
- data/examples/17_skills.rb +8 -17
- data/examples/18_rails/Gemfile +1 -0
- data/examples/19_token_tracking.rb +9 -15
- data/examples/20_circuit_breaker.rb +10 -19
- data/examples/21_learning_loop.rb +11 -20
- data/examples/22_context_compression.rb +6 -13
- data/examples/23_convergence.rb +6 -17
- data/examples/24_structured_delegation.rb +11 -15
- data/examples/25_history_search.rb +5 -12
- data/examples/26_document_store.rb +6 -13
- data/examples/27_incident_response/incident_response.rb +4 -5
- data/examples/28_mcp_discovery.rb +8 -11
- data/examples/29_ractor_tools.rb +4 -9
- data/examples/30_ractor_network.rb +10 -19
- data/examples/31_launch_assessment.rb +10 -23
- data/examples/32_newsletter_reader.rb +188 -0
- data/examples/33_stock_generator.rb +80 -0
- data/examples/33_stock_predictor.rb +306 -0
- data/examples/34_agentskills.rb +72 -0
- data/examples/README.md +1 -1
- data/examples/common.rb +76 -0
- data/examples/ruboruby.md +423 -0
- data/examples/temp.md +51 -0
- data/lib/robot_lab/agent_skill.rb +63 -0
- data/lib/robot_lab/agent_skill_catalog.rb +74 -0
- data/lib/robot_lab/ask_user.rb +2 -2
- data/lib/robot_lab/bus_poller.rb +12 -5
- data/lib/robot_lab/config.rb +1 -12
- data/lib/robot_lab/delegation_future.rb +1 -1
- data/lib/robot_lab/doom_loop_detector.rb +98 -0
- data/lib/robot_lab/history_compressor.rb +4 -10
- data/lib/robot_lab/mcp/client.rb +1 -2
- data/lib/robot_lab/mcp/connection_poller.rb +3 -3
- data/lib/robot_lab/mcp/server.rb +1 -1
- data/lib/robot_lab/mcp/server_discovery.rb +0 -2
- data/lib/robot_lab/memory.rb +32 -27
- data/lib/robot_lab/memory_change.rb +2 -2
- data/lib/robot_lab/message.rb +4 -4
- data/lib/robot_lab/network.rb +11 -6
- data/lib/robot_lab/robot/agent_skill_matching.rb +99 -0
- data/lib/robot_lab/robot/bus_messaging.rb +9 -27
- data/lib/robot_lab/robot/history_search.rb +4 -1
- data/lib/robot_lab/robot/mcp_management.rb +5 -11
- data/lib/robot_lab/robot/template_rendering.rb +60 -40
- data/lib/robot_lab/robot.rb +323 -206
- data/lib/robot_lab/robot_result.rb +6 -5
- data/lib/robot_lab/run_config.rb +5 -11
- data/lib/robot_lab/script_tool.rb +76 -0
- data/lib/robot_lab/state_proxy.rb +7 -5
- data/lib/robot_lab/tool.rb +3 -3
- data/lib/robot_lab/tool_config.rb +1 -1
- data/lib/robot_lab/tool_manifest.rb +5 -7
- data/lib/robot_lab/user_message.rb +2 -2
- data/lib/robot_lab/version.rb +1 -1
- data/lib/robot_lab/waiter.rb +1 -1
- data/lib/robot_lab.rb +41 -52
- data/logfile +8 -0
- data/mkdocs.yml +2 -3
- data/robot_concurrency.md +38 -0
- data/simple_acp_review.md +298 -0
- data/site/404.html +2300 -0
- data/site/api/core/index.html +2706 -0
- data/site/api/core/memory/index.html +3793 -0
- data/site/api/core/network/index.html +3500 -0
- data/site/api/core/robot/index.html +4566 -0
- data/site/api/core/state/index.html +3390 -0
- data/site/api/core/tool/index.html +3843 -0
- data/site/api/index.html +2635 -0
- data/site/api/mcp/client/index.html +3435 -0
- data/site/api/mcp/index.html +2783 -0
- data/site/api/mcp/server/index.html +3252 -0
- data/site/api/mcp/transports/index.html +3352 -0
- data/site/api/messages/index.html +2641 -0
- data/site/api/messages/text-message/index.html +3087 -0
- data/site/api/messages/tool-call-message/index.html +3159 -0
- data/site/api/messages/tool-result-message/index.html +3252 -0
- data/site/api/messages/user-message/index.html +3212 -0
- data/site/api/streaming/context/index.html +3282 -0
- data/site/api/streaming/events/index.html +3347 -0
- data/site/api/streaming/index.html +2738 -0
- data/site/architecture/core-concepts/index.html +3757 -0
- data/site/architecture/index.html +2797 -0
- data/site/architecture/message-flow/index.html +3238 -0
- data/site/architecture/network-orchestration/index.html +3433 -0
- data/site/architecture/robot-execution/index.html +3140 -0
- data/site/architecture/state-management/index.html +3498 -0
- data/site/assets/css/custom.css +56 -0
- data/site/assets/images/favicon.png +0 -0
- data/site/assets/images/robot_lab.jpg +0 -0
- data/site/assets/javascripts/bundle.79ae519e.min.js +16 -0
- data/site/assets/javascripts/bundle.79ae519e.min.js.map +7 -0
- data/site/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.el.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.he.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.hi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.hy.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.kn.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.ko.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.sa.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ta.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.te.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.th.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.zh.min.js +1 -0
- data/site/assets/javascripts/lunr/tinyseg.js +206 -0
- data/site/assets/javascripts/lunr/wordcut.js +6708 -0
- data/site/assets/javascripts/workers/search.2c215733.min.js +42 -0
- data/site/assets/javascripts/workers/search.2c215733.min.js.map +7 -0
- data/site/assets/stylesheets/main.484c7ddc.min.css +1 -0
- data/site/assets/stylesheets/main.484c7ddc.min.css.map +1 -0
- data/site/assets/stylesheets/palette.ab4e12ef.min.css +1 -0
- data/site/assets/stylesheets/palette.ab4e12ef.min.css.map +1 -0
- data/site/concepts/index.html +3455 -0
- data/site/examples/basic-chat/index.html +2880 -0
- data/site/examples/index.html +2907 -0
- data/site/examples/mcp-server/index.html +3018 -0
- data/site/examples/multi-robot-network/index.html +3131 -0
- data/site/examples/rails-application/index.html +3329 -0
- data/site/examples/tool-usage/index.html +3085 -0
- data/site/getting-started/configuration/index.html +3745 -0
- data/site/getting-started/index.html +2572 -0
- data/site/getting-started/installation/index.html +2981 -0
- data/site/getting-started/quick-start/index.html +2942 -0
- data/site/guides/building-robots/index.html +4290 -0
- data/site/guides/creating-networks/index.html +3858 -0
- data/site/guides/index.html +2586 -0
- data/site/guides/mcp-integration/index.html +3581 -0
- data/site/guides/memory/index.html +3586 -0
- data/site/guides/rails-integration/index.html +4019 -0
- data/site/guides/streaming/index.html +3157 -0
- data/site/guides/using-tools/index.html +3802 -0
- data/site/index.html +2671 -0
- data/site/search/search_index.json +1 -0
- data/site/sitemap.xml +183 -0
- data/site/sitemap.xml.gz +0 -0
- data/site/tags.json +1 -0
- data/temp.md +6 -0
- data/tool_manifest_plan.md +155 -0
- metadata +154 -92
- data/docs/examples/rails-application.md +0 -419
- data/docs/guides/ractor-parallelism.md +0 -364
- data/docs/guides/rails-integration.md +0 -681
- data/docs/superpowers/plans/2026-04-14-ractor-integration.md +0 -1538
- data/docs/superpowers/specs/2026-04-14-ractor-integration-design.md +0 -258
- data/lib/generators/robot_lab/install_generator.rb +0 -90
- data/lib/generators/robot_lab/job_generator.rb +0 -40
- data/lib/generators/robot_lab/robot_generator.rb +0 -55
- data/lib/generators/robot_lab/templates/initializer.rb.tt +0 -42
- data/lib/generators/robot_lab/templates/job.rb.tt +0 -21
- data/lib/generators/robot_lab/templates/migration.rb.tt +0 -32
- data/lib/generators/robot_lab/templates/result_model.rb.tt +0 -52
- data/lib/generators/robot_lab/templates/robot.rb.tt +0 -31
- data/lib/generators/robot_lab/templates/robot_job.rb.tt +0 -18
- data/lib/generators/robot_lab/templates/robot_test.rb.tt +0 -34
- data/lib/generators/robot_lab/templates/routing_robot.rb.tt +0 -59
- data/lib/generators/robot_lab/templates/thread_model.rb.tt +0 -40
- data/lib/robot_lab/document_store.rb +0 -155
- data/lib/robot_lab/ractor_boundary.rb +0 -42
- data/lib/robot_lab/ractor_job.rb +0 -37
- data/lib/robot_lab/ractor_memory_proxy.rb +0 -85
- data/lib/robot_lab/ractor_network_scheduler.rb +0 -154
- data/lib/robot_lab/ractor_worker_pool.rb +0 -117
- data/lib/robot_lab/rails_integration/engine.rb +0 -29
- data/lib/robot_lab/rails_integration/job.rb +0 -158
- data/lib/robot_lab/rails_integration/railtie.rb +0 -51
- data/lib/robot_lab/rails_integration/turbo_stream_callbacks.rb +0 -72
|
@@ -0,0 +1,3802 @@
|
|
|
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/guides/using-tools/">
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<link rel="prev" href="../creating-networks/">
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<link rel="next" href="../mcp-integration/">
|
|
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>Using Tools - 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="#using-tools" 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
|
+
Using Tools
|
|
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
|
+
|
|
303
|
+
|
|
304
|
+
<li class="md-tabs__item md-tabs__item--active">
|
|
305
|
+
<a href="../" class="md-tabs__link">
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
Guides
|
|
312
|
+
|
|
313
|
+
</a>
|
|
314
|
+
</li>
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<li class="md-tabs__item">
|
|
327
|
+
<a href="../../api/" 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
|
+
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
<div class="md-nav__link md-nav__container">
|
|
947
|
+
<a href="../" class="md-nav__link ">
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
<span class="md-ellipsis">
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
Guides
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
</span>
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
</a>
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
|
|
966
|
+
<span class="md-nav__icon md-icon"></span>
|
|
967
|
+
</label>
|
|
968
|
+
|
|
969
|
+
</div>
|
|
970
|
+
|
|
971
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
|
|
972
|
+
<label class="md-nav__title" for="__nav_4">
|
|
973
|
+
<span class="md-nav__icon md-icon"></span>
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
Guides
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
</label>
|
|
980
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
<li class="md-nav__item">
|
|
991
|
+
<a href="../building-robots/" class="md-nav__link">
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
<span class="md-ellipsis">
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
Building Robots
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
</span>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
</a>
|
|
1007
|
+
</li>
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
<li class="md-nav__item">
|
|
1019
|
+
<a href="../creating-networks/" class="md-nav__link">
|
|
1020
|
+
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
<span class="md-ellipsis">
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
Creating Networks
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
</span>
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
</a>
|
|
1035
|
+
</li>
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
<li class="md-nav__item md-nav__item--active">
|
|
1049
|
+
|
|
1050
|
+
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
<span class="md-ellipsis">
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
Using Tools
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
</span>
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1072
|
+
</label>
|
|
1073
|
+
|
|
1074
|
+
<a href="./" class="md-nav__link md-nav__link--active">
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
<span class="md-ellipsis">
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
Using Tools
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
</span>
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
</a>
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
<label class="md-nav__title" for="__toc">
|
|
1103
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1104
|
+
On this page
|
|
1105
|
+
</label>
|
|
1106
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
1107
|
+
|
|
1108
|
+
<li class="md-nav__item">
|
|
1109
|
+
<a href="#defining-tools" class="md-nav__link">
|
|
1110
|
+
<span class="md-ellipsis">
|
|
1111
|
+
|
|
1112
|
+
Defining Tools
|
|
1113
|
+
|
|
1114
|
+
</span>
|
|
1115
|
+
</a>
|
|
1116
|
+
|
|
1117
|
+
<nav class="md-nav" aria-label="Defining Tools">
|
|
1118
|
+
<ul class="md-nav__list">
|
|
1119
|
+
|
|
1120
|
+
<li class="md-nav__item">
|
|
1121
|
+
<a href="#rubyllmtool-subclass" class="md-nav__link">
|
|
1122
|
+
<span class="md-ellipsis">
|
|
1123
|
+
|
|
1124
|
+
RubyLLM::Tool Subclass
|
|
1125
|
+
|
|
1126
|
+
</span>
|
|
1127
|
+
</a>
|
|
1128
|
+
|
|
1129
|
+
</li>
|
|
1130
|
+
|
|
1131
|
+
<li class="md-nav__item">
|
|
1132
|
+
<a href="#robotlabtool-subclass" class="md-nav__link">
|
|
1133
|
+
<span class="md-ellipsis">
|
|
1134
|
+
|
|
1135
|
+
RobotLab::Tool Subclass
|
|
1136
|
+
|
|
1137
|
+
</span>
|
|
1138
|
+
</a>
|
|
1139
|
+
|
|
1140
|
+
</li>
|
|
1141
|
+
|
|
1142
|
+
<li class="md-nav__item">
|
|
1143
|
+
<a href="#robotlabtoolcreate-dynamic-tools" class="md-nav__link">
|
|
1144
|
+
<span class="md-ellipsis">
|
|
1145
|
+
|
|
1146
|
+
RobotLab::Tool.create (Dynamic Tools)
|
|
1147
|
+
|
|
1148
|
+
</span>
|
|
1149
|
+
</a>
|
|
1150
|
+
|
|
1151
|
+
</li>
|
|
1152
|
+
|
|
1153
|
+
</ul>
|
|
1154
|
+
</nav>
|
|
1155
|
+
|
|
1156
|
+
</li>
|
|
1157
|
+
|
|
1158
|
+
<li class="md-nav__item">
|
|
1159
|
+
<a href="#built-in-tools" class="md-nav__link">
|
|
1160
|
+
<span class="md-ellipsis">
|
|
1161
|
+
|
|
1162
|
+
Built-in Tools
|
|
1163
|
+
|
|
1164
|
+
</span>
|
|
1165
|
+
</a>
|
|
1166
|
+
|
|
1167
|
+
<nav class="md-nav" aria-label="Built-in Tools">
|
|
1168
|
+
<ul class="md-nav__list">
|
|
1169
|
+
|
|
1170
|
+
<li class="md-nav__item">
|
|
1171
|
+
<a href="#askuser" class="md-nav__link">
|
|
1172
|
+
<span class="md-ellipsis">
|
|
1173
|
+
|
|
1174
|
+
AskUser
|
|
1175
|
+
|
|
1176
|
+
</span>
|
|
1177
|
+
</a>
|
|
1178
|
+
|
|
1179
|
+
</li>
|
|
1180
|
+
|
|
1181
|
+
</ul>
|
|
1182
|
+
</nav>
|
|
1183
|
+
|
|
1184
|
+
</li>
|
|
1185
|
+
|
|
1186
|
+
<li class="md-nav__item">
|
|
1187
|
+
<a href="#attaching-tools-to-robots" class="md-nav__link">
|
|
1188
|
+
<span class="md-ellipsis">
|
|
1189
|
+
|
|
1190
|
+
Attaching Tools to Robots
|
|
1191
|
+
|
|
1192
|
+
</span>
|
|
1193
|
+
</a>
|
|
1194
|
+
|
|
1195
|
+
<nav class="md-nav" aria-label="Attaching Tools to Robots">
|
|
1196
|
+
<ul class="md-nav__list">
|
|
1197
|
+
|
|
1198
|
+
<li class="md-nav__item">
|
|
1199
|
+
<a href="#via-constructor" class="md-nav__link">
|
|
1200
|
+
<span class="md-ellipsis">
|
|
1201
|
+
|
|
1202
|
+
Via Constructor
|
|
1203
|
+
|
|
1204
|
+
</span>
|
|
1205
|
+
</a>
|
|
1206
|
+
|
|
1207
|
+
</li>
|
|
1208
|
+
|
|
1209
|
+
<li class="md-nav__item">
|
|
1210
|
+
<a href="#via-template-front-matter" class="md-nav__link">
|
|
1211
|
+
<span class="md-ellipsis">
|
|
1212
|
+
|
|
1213
|
+
Via Template Front Matter
|
|
1214
|
+
|
|
1215
|
+
</span>
|
|
1216
|
+
</a>
|
|
1217
|
+
|
|
1218
|
+
</li>
|
|
1219
|
+
|
|
1220
|
+
<li class="md-nav__item">
|
|
1221
|
+
<a href="#via-chaining" class="md-nav__link">
|
|
1222
|
+
<span class="md-ellipsis">
|
|
1223
|
+
|
|
1224
|
+
Via Chaining
|
|
1225
|
+
|
|
1226
|
+
</span>
|
|
1227
|
+
</a>
|
|
1228
|
+
|
|
1229
|
+
</li>
|
|
1230
|
+
|
|
1231
|
+
</ul>
|
|
1232
|
+
</nav>
|
|
1233
|
+
|
|
1234
|
+
</li>
|
|
1235
|
+
|
|
1236
|
+
<li class="md-nav__item">
|
|
1237
|
+
<a href="#parameter-types" class="md-nav__link">
|
|
1238
|
+
<span class="md-ellipsis">
|
|
1239
|
+
|
|
1240
|
+
Parameter Types
|
|
1241
|
+
|
|
1242
|
+
</span>
|
|
1243
|
+
</a>
|
|
1244
|
+
|
|
1245
|
+
<nav class="md-nav" aria-label="Parameter Types">
|
|
1246
|
+
<ul class="md-nav__list">
|
|
1247
|
+
|
|
1248
|
+
<li class="md-nav__item">
|
|
1249
|
+
<a href="#string" class="md-nav__link">
|
|
1250
|
+
<span class="md-ellipsis">
|
|
1251
|
+
|
|
1252
|
+
String
|
|
1253
|
+
|
|
1254
|
+
</span>
|
|
1255
|
+
</a>
|
|
1256
|
+
|
|
1257
|
+
</li>
|
|
1258
|
+
|
|
1259
|
+
<li class="md-nav__item">
|
|
1260
|
+
<a href="#integer" class="md-nav__link">
|
|
1261
|
+
<span class="md-ellipsis">
|
|
1262
|
+
|
|
1263
|
+
Integer
|
|
1264
|
+
|
|
1265
|
+
</span>
|
|
1266
|
+
</a>
|
|
1267
|
+
|
|
1268
|
+
</li>
|
|
1269
|
+
|
|
1270
|
+
<li class="md-nav__item">
|
|
1271
|
+
<a href="#number-float" class="md-nav__link">
|
|
1272
|
+
<span class="md-ellipsis">
|
|
1273
|
+
|
|
1274
|
+
Number (Float)
|
|
1275
|
+
|
|
1276
|
+
</span>
|
|
1277
|
+
</a>
|
|
1278
|
+
|
|
1279
|
+
</li>
|
|
1280
|
+
|
|
1281
|
+
<li class="md-nav__item">
|
|
1282
|
+
<a href="#boolean" class="md-nav__link">
|
|
1283
|
+
<span class="md-ellipsis">
|
|
1284
|
+
|
|
1285
|
+
Boolean
|
|
1286
|
+
|
|
1287
|
+
</span>
|
|
1288
|
+
</a>
|
|
1289
|
+
|
|
1290
|
+
</li>
|
|
1291
|
+
|
|
1292
|
+
<li class="md-nav__item">
|
|
1293
|
+
<a href="#array" class="md-nav__link">
|
|
1294
|
+
<span class="md-ellipsis">
|
|
1295
|
+
|
|
1296
|
+
Array
|
|
1297
|
+
|
|
1298
|
+
</span>
|
|
1299
|
+
</a>
|
|
1300
|
+
|
|
1301
|
+
</li>
|
|
1302
|
+
|
|
1303
|
+
<li class="md-nav__item">
|
|
1304
|
+
<a href="#enum" class="md-nav__link">
|
|
1305
|
+
<span class="md-ellipsis">
|
|
1306
|
+
|
|
1307
|
+
Enum
|
|
1308
|
+
|
|
1309
|
+
</span>
|
|
1310
|
+
</a>
|
|
1311
|
+
|
|
1312
|
+
</li>
|
|
1313
|
+
|
|
1314
|
+
<li class="md-nav__item">
|
|
1315
|
+
<a href="#required-vs-optional" class="md-nav__link">
|
|
1316
|
+
<span class="md-ellipsis">
|
|
1317
|
+
|
|
1318
|
+
Required vs Optional
|
|
1319
|
+
|
|
1320
|
+
</span>
|
|
1321
|
+
</a>
|
|
1322
|
+
|
|
1323
|
+
</li>
|
|
1324
|
+
|
|
1325
|
+
</ul>
|
|
1326
|
+
</nav>
|
|
1327
|
+
|
|
1328
|
+
</li>
|
|
1329
|
+
|
|
1330
|
+
<li class="md-nav__item">
|
|
1331
|
+
<a href="#tool-patterns" class="md-nav__link">
|
|
1332
|
+
<span class="md-ellipsis">
|
|
1333
|
+
|
|
1334
|
+
Tool Patterns
|
|
1335
|
+
|
|
1336
|
+
</span>
|
|
1337
|
+
</a>
|
|
1338
|
+
|
|
1339
|
+
<nav class="md-nav" aria-label="Tool Patterns">
|
|
1340
|
+
<ul class="md-nav__list">
|
|
1341
|
+
|
|
1342
|
+
<li class="md-nav__item">
|
|
1343
|
+
<a href="#database-lookup" class="md-nav__link">
|
|
1344
|
+
<span class="md-ellipsis">
|
|
1345
|
+
|
|
1346
|
+
Database Lookup
|
|
1347
|
+
|
|
1348
|
+
</span>
|
|
1349
|
+
</a>
|
|
1350
|
+
|
|
1351
|
+
</li>
|
|
1352
|
+
|
|
1353
|
+
<li class="md-nav__item">
|
|
1354
|
+
<a href="#api-integration" class="md-nav__link">
|
|
1355
|
+
<span class="md-ellipsis">
|
|
1356
|
+
|
|
1357
|
+
API Integration
|
|
1358
|
+
|
|
1359
|
+
</span>
|
|
1360
|
+
</a>
|
|
1361
|
+
|
|
1362
|
+
</li>
|
|
1363
|
+
|
|
1364
|
+
<li class="md-nav__item">
|
|
1365
|
+
<a href="#file-operations" class="md-nav__link">
|
|
1366
|
+
<span class="md-ellipsis">
|
|
1367
|
+
|
|
1368
|
+
File Operations
|
|
1369
|
+
|
|
1370
|
+
</span>
|
|
1371
|
+
</a>
|
|
1372
|
+
|
|
1373
|
+
</li>
|
|
1374
|
+
|
|
1375
|
+
<li class="md-nav__item">
|
|
1376
|
+
<a href="#multi-step-operations" class="md-nav__link">
|
|
1377
|
+
<span class="md-ellipsis">
|
|
1378
|
+
|
|
1379
|
+
Multi-Step Operations
|
|
1380
|
+
|
|
1381
|
+
</span>
|
|
1382
|
+
</a>
|
|
1383
|
+
|
|
1384
|
+
</li>
|
|
1385
|
+
|
|
1386
|
+
</ul>
|
|
1387
|
+
</nav>
|
|
1388
|
+
|
|
1389
|
+
</li>
|
|
1390
|
+
|
|
1391
|
+
<li class="md-nav__item">
|
|
1392
|
+
<a href="#tool-return-values" class="md-nav__link">
|
|
1393
|
+
<span class="md-ellipsis">
|
|
1394
|
+
|
|
1395
|
+
Tool Return Values
|
|
1396
|
+
|
|
1397
|
+
</span>
|
|
1398
|
+
</a>
|
|
1399
|
+
|
|
1400
|
+
<nav class="md-nav" aria-label="Tool Return Values">
|
|
1401
|
+
<ul class="md-nav__list">
|
|
1402
|
+
|
|
1403
|
+
<li class="md-nav__item">
|
|
1404
|
+
<a href="#structured-data" class="md-nav__link">
|
|
1405
|
+
<span class="md-ellipsis">
|
|
1406
|
+
|
|
1407
|
+
Structured Data
|
|
1408
|
+
|
|
1409
|
+
</span>
|
|
1410
|
+
</a>
|
|
1411
|
+
|
|
1412
|
+
</li>
|
|
1413
|
+
|
|
1414
|
+
<li class="md-nav__item">
|
|
1415
|
+
<a href="#simple-values" class="md-nav__link">
|
|
1416
|
+
<span class="md-ellipsis">
|
|
1417
|
+
|
|
1418
|
+
Simple Values
|
|
1419
|
+
|
|
1420
|
+
</span>
|
|
1421
|
+
</a>
|
|
1422
|
+
|
|
1423
|
+
</li>
|
|
1424
|
+
|
|
1425
|
+
<li class="md-nav__item">
|
|
1426
|
+
<a href="#lists" class="md-nav__link">
|
|
1427
|
+
<span class="md-ellipsis">
|
|
1428
|
+
|
|
1429
|
+
Lists
|
|
1430
|
+
|
|
1431
|
+
</span>
|
|
1432
|
+
</a>
|
|
1433
|
+
|
|
1434
|
+
</li>
|
|
1435
|
+
|
|
1436
|
+
</ul>
|
|
1437
|
+
</nav>
|
|
1438
|
+
|
|
1439
|
+
</li>
|
|
1440
|
+
|
|
1441
|
+
<li class="md-nav__item">
|
|
1442
|
+
<a href="#error-handling" class="md-nav__link">
|
|
1443
|
+
<span class="md-ellipsis">
|
|
1444
|
+
|
|
1445
|
+
Error Handling
|
|
1446
|
+
|
|
1447
|
+
</span>
|
|
1448
|
+
</a>
|
|
1449
|
+
|
|
1450
|
+
<nav class="md-nav" aria-label="Error Handling">
|
|
1451
|
+
<ul class="md-nav__list">
|
|
1452
|
+
|
|
1453
|
+
<li class="md-nav__item">
|
|
1454
|
+
<a href="#automatic-error-handling" class="md-nav__link">
|
|
1455
|
+
<span class="md-ellipsis">
|
|
1456
|
+
|
|
1457
|
+
Automatic Error Handling
|
|
1458
|
+
|
|
1459
|
+
</span>
|
|
1460
|
+
</a>
|
|
1461
|
+
|
|
1462
|
+
</li>
|
|
1463
|
+
|
|
1464
|
+
<li class="md-nav__item">
|
|
1465
|
+
<a href="#critical-tools-opt-out" class="md-nav__link">
|
|
1466
|
+
<span class="md-ellipsis">
|
|
1467
|
+
|
|
1468
|
+
Critical Tools (Opt-Out)
|
|
1469
|
+
|
|
1470
|
+
</span>
|
|
1471
|
+
</a>
|
|
1472
|
+
|
|
1473
|
+
</li>
|
|
1474
|
+
|
|
1475
|
+
<li class="md-nav__item">
|
|
1476
|
+
<a href="#manual-error-handling" class="md-nav__link">
|
|
1477
|
+
<span class="md-ellipsis">
|
|
1478
|
+
|
|
1479
|
+
Manual Error Handling
|
|
1480
|
+
|
|
1481
|
+
</span>
|
|
1482
|
+
</a>
|
|
1483
|
+
|
|
1484
|
+
</li>
|
|
1485
|
+
|
|
1486
|
+
</ul>
|
|
1487
|
+
</nav>
|
|
1488
|
+
|
|
1489
|
+
</li>
|
|
1490
|
+
|
|
1491
|
+
<li class="md-nav__item">
|
|
1492
|
+
<a href="#tool-callbacks" class="md-nav__link">
|
|
1493
|
+
<span class="md-ellipsis">
|
|
1494
|
+
|
|
1495
|
+
Tool Callbacks
|
|
1496
|
+
|
|
1497
|
+
</span>
|
|
1498
|
+
</a>
|
|
1499
|
+
|
|
1500
|
+
</li>
|
|
1501
|
+
|
|
1502
|
+
<li class="md-nav__item">
|
|
1503
|
+
<a href="#robotlabtoolcreate-with-schema" class="md-nav__link">
|
|
1504
|
+
<span class="md-ellipsis">
|
|
1505
|
+
|
|
1506
|
+
RobotLab::Tool.create with Schema
|
|
1507
|
+
|
|
1508
|
+
</span>
|
|
1509
|
+
</a>
|
|
1510
|
+
|
|
1511
|
+
</li>
|
|
1512
|
+
|
|
1513
|
+
<li class="md-nav__item">
|
|
1514
|
+
<a href="#best-practices" class="md-nav__link">
|
|
1515
|
+
<span class="md-ellipsis">
|
|
1516
|
+
|
|
1517
|
+
Best Practices
|
|
1518
|
+
|
|
1519
|
+
</span>
|
|
1520
|
+
</a>
|
|
1521
|
+
|
|
1522
|
+
<nav class="md-nav" aria-label="Best Practices">
|
|
1523
|
+
<ul class="md-nav__list">
|
|
1524
|
+
|
|
1525
|
+
<li class="md-nav__item">
|
|
1526
|
+
<a href="#1-clear-descriptions" class="md-nav__link">
|
|
1527
|
+
<span class="md-ellipsis">
|
|
1528
|
+
|
|
1529
|
+
1. Clear Descriptions
|
|
1530
|
+
|
|
1531
|
+
</span>
|
|
1532
|
+
</a>
|
|
1533
|
+
|
|
1534
|
+
</li>
|
|
1535
|
+
|
|
1536
|
+
<li class="md-nav__item">
|
|
1537
|
+
<a href="#2-validate-inputs" class="md-nav__link">
|
|
1538
|
+
<span class="md-ellipsis">
|
|
1539
|
+
|
|
1540
|
+
2. Validate Inputs
|
|
1541
|
+
|
|
1542
|
+
</span>
|
|
1543
|
+
</a>
|
|
1544
|
+
|
|
1545
|
+
</li>
|
|
1546
|
+
|
|
1547
|
+
<li class="md-nav__item">
|
|
1548
|
+
<a href="#3-return-structured-data" class="md-nav__link">
|
|
1549
|
+
<span class="md-ellipsis">
|
|
1550
|
+
|
|
1551
|
+
3. Return Structured Data
|
|
1552
|
+
|
|
1553
|
+
</span>
|
|
1554
|
+
</a>
|
|
1555
|
+
|
|
1556
|
+
</li>
|
|
1557
|
+
|
|
1558
|
+
<li class="md-nav__item">
|
|
1559
|
+
<a href="#4-keep-tools-focused" class="md-nav__link">
|
|
1560
|
+
<span class="md-ellipsis">
|
|
1561
|
+
|
|
1562
|
+
4. Keep Tools Focused
|
|
1563
|
+
|
|
1564
|
+
</span>
|
|
1565
|
+
</a>
|
|
1566
|
+
|
|
1567
|
+
</li>
|
|
1568
|
+
|
|
1569
|
+
</ul>
|
|
1570
|
+
</nav>
|
|
1571
|
+
|
|
1572
|
+
</li>
|
|
1573
|
+
|
|
1574
|
+
<li class="md-nav__item">
|
|
1575
|
+
<a href="#next-steps" class="md-nav__link">
|
|
1576
|
+
<span class="md-ellipsis">
|
|
1577
|
+
|
|
1578
|
+
Next Steps
|
|
1579
|
+
|
|
1580
|
+
</span>
|
|
1581
|
+
</a>
|
|
1582
|
+
|
|
1583
|
+
</li>
|
|
1584
|
+
|
|
1585
|
+
</ul>
|
|
1586
|
+
|
|
1587
|
+
</nav>
|
|
1588
|
+
|
|
1589
|
+
</li>
|
|
1590
|
+
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
<li class="md-nav__item">
|
|
1601
|
+
<a href="../mcp-integration/" class="md-nav__link">
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
|
|
1605
|
+
<span class="md-ellipsis">
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
MCP Integration
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
</span>
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
</a>
|
|
1617
|
+
</li>
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
|
|
1627
|
+
|
|
1628
|
+
<li class="md-nav__item">
|
|
1629
|
+
<a href="../streaming/" class="md-nav__link">
|
|
1630
|
+
|
|
1631
|
+
|
|
1632
|
+
|
|
1633
|
+
<span class="md-ellipsis">
|
|
1634
|
+
|
|
1635
|
+
|
|
1636
|
+
Streaming Responses
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
</span>
|
|
1641
|
+
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
</a>
|
|
1645
|
+
</li>
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
|
|
1656
|
+
<li class="md-nav__item">
|
|
1657
|
+
<a href="../memory/" class="md-nav__link">
|
|
1658
|
+
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
<span class="md-ellipsis">
|
|
1662
|
+
|
|
1663
|
+
|
|
1664
|
+
Memory System
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
</span>
|
|
1669
|
+
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
</a>
|
|
1673
|
+
</li>
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
<li class="md-nav__item">
|
|
1685
|
+
<a href="../rails-integration/" class="md-nav__link">
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
<span class="md-ellipsis">
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
Rails Integration
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
</span>
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
</a>
|
|
1701
|
+
</li>
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
</ul>
|
|
1707
|
+
</nav>
|
|
1708
|
+
|
|
1709
|
+
</li>
|
|
1710
|
+
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
|
|
1735
|
+
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
<div class="md-nav__link md-nav__container">
|
|
1749
|
+
<a href="../../api/" class="md-nav__link ">
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
<span class="md-ellipsis">
|
|
1754
|
+
|
|
1755
|
+
|
|
1756
|
+
API Reference
|
|
1757
|
+
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
</span>
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
</a>
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
|
|
1768
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1769
|
+
</label>
|
|
1770
|
+
|
|
1771
|
+
</div>
|
|
1772
|
+
|
|
1773
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
|
1774
|
+
<label class="md-nav__title" for="__nav_5">
|
|
1775
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
API Reference
|
|
1779
|
+
|
|
1780
|
+
|
|
1781
|
+
</label>
|
|
1782
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
|
|
1805
|
+
|
|
1806
|
+
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
|
|
1813
|
+
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1817
|
+
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
<div class="md-nav__link md-nav__container">
|
|
1824
|
+
<a href="../../api/core/" class="md-nav__link ">
|
|
1825
|
+
|
|
1826
|
+
|
|
1827
|
+
|
|
1828
|
+
<span class="md-ellipsis">
|
|
1829
|
+
|
|
1830
|
+
|
|
1831
|
+
Core Classes
|
|
1832
|
+
|
|
1833
|
+
|
|
1834
|
+
|
|
1835
|
+
</span>
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
|
|
1839
|
+
</a>
|
|
1840
|
+
|
|
1841
|
+
|
|
1842
|
+
<label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
|
|
1843
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1844
|
+
</label>
|
|
1845
|
+
|
|
1846
|
+
</div>
|
|
1847
|
+
|
|
1848
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
|
|
1849
|
+
<label class="md-nav__title" for="__nav_5_2">
|
|
1850
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
Core Classes
|
|
1854
|
+
|
|
1855
|
+
|
|
1856
|
+
</label>
|
|
1857
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
|
|
1862
|
+
|
|
1863
|
+
|
|
1864
|
+
|
|
1865
|
+
|
|
1866
|
+
|
|
1867
|
+
<li class="md-nav__item">
|
|
1868
|
+
<a href="../../api/core/robot/" class="md-nav__link">
|
|
1869
|
+
|
|
1870
|
+
|
|
1871
|
+
|
|
1872
|
+
<span class="md-ellipsis">
|
|
1873
|
+
|
|
1874
|
+
|
|
1875
|
+
Robot
|
|
1876
|
+
|
|
1877
|
+
|
|
1878
|
+
|
|
1879
|
+
</span>
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
|
|
1883
|
+
</a>
|
|
1884
|
+
</li>
|
|
1885
|
+
|
|
1886
|
+
|
|
1887
|
+
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
|
|
1895
|
+
<li class="md-nav__item">
|
|
1896
|
+
<a href="../../api/core/network/" class="md-nav__link">
|
|
1897
|
+
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
<span class="md-ellipsis">
|
|
1901
|
+
|
|
1902
|
+
|
|
1903
|
+
Network
|
|
1904
|
+
|
|
1905
|
+
|
|
1906
|
+
|
|
1907
|
+
</span>
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
</a>
|
|
1912
|
+
</li>
|
|
1913
|
+
|
|
1914
|
+
|
|
1915
|
+
|
|
1916
|
+
|
|
1917
|
+
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
<li class="md-nav__item">
|
|
1924
|
+
<a href="../../api/core/state/" class="md-nav__link">
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
|
|
1928
|
+
<span class="md-ellipsis">
|
|
1929
|
+
|
|
1930
|
+
|
|
1931
|
+
State
|
|
1932
|
+
|
|
1933
|
+
|
|
1934
|
+
|
|
1935
|
+
</span>
|
|
1936
|
+
|
|
1937
|
+
|
|
1938
|
+
|
|
1939
|
+
</a>
|
|
1940
|
+
</li>
|
|
1941
|
+
|
|
1942
|
+
|
|
1943
|
+
|
|
1944
|
+
|
|
1945
|
+
|
|
1946
|
+
|
|
1947
|
+
|
|
1948
|
+
|
|
1949
|
+
|
|
1950
|
+
|
|
1951
|
+
<li class="md-nav__item">
|
|
1952
|
+
<a href="../../api/core/tool/" class="md-nav__link">
|
|
1953
|
+
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
<span class="md-ellipsis">
|
|
1957
|
+
|
|
1958
|
+
|
|
1959
|
+
Tool
|
|
1960
|
+
|
|
1961
|
+
|
|
1962
|
+
|
|
1963
|
+
</span>
|
|
1964
|
+
|
|
1965
|
+
|
|
1966
|
+
|
|
1967
|
+
</a>
|
|
1968
|
+
</li>
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
|
|
1977
|
+
|
|
1978
|
+
|
|
1979
|
+
<li class="md-nav__item">
|
|
1980
|
+
<a href="../../api/core/memory/" class="md-nav__link">
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
<span class="md-ellipsis">
|
|
1985
|
+
|
|
1986
|
+
|
|
1987
|
+
Memory
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
|
|
1991
|
+
</span>
|
|
1992
|
+
|
|
1993
|
+
|
|
1994
|
+
|
|
1995
|
+
</a>
|
|
1996
|
+
</li>
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
</ul>
|
|
2002
|
+
</nav>
|
|
2003
|
+
|
|
2004
|
+
</li>
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
|
|
2016
|
+
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
|
|
2022
|
+
|
|
2023
|
+
|
|
2024
|
+
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
|
|
2028
|
+
|
|
2029
|
+
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
|
|
2036
|
+
|
|
2037
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2038
|
+
|
|
2039
|
+
|
|
2040
|
+
|
|
2041
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" >
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
<div class="md-nav__link md-nav__container">
|
|
2045
|
+
<a href="../../api/messages/" class="md-nav__link ">
|
|
2046
|
+
|
|
2047
|
+
|
|
2048
|
+
|
|
2049
|
+
<span class="md-ellipsis">
|
|
2050
|
+
|
|
2051
|
+
|
|
2052
|
+
Messages
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
</span>
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
|
|
2060
|
+
</a>
|
|
2061
|
+
|
|
2062
|
+
|
|
2063
|
+
<label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0">
|
|
2064
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2065
|
+
</label>
|
|
2066
|
+
|
|
2067
|
+
</div>
|
|
2068
|
+
|
|
2069
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false">
|
|
2070
|
+
<label class="md-nav__title" for="__nav_5_3">
|
|
2071
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
Messages
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
</label>
|
|
2078
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2079
|
+
|
|
2080
|
+
|
|
2081
|
+
|
|
2082
|
+
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
|
|
2086
|
+
|
|
2087
|
+
|
|
2088
|
+
<li class="md-nav__item">
|
|
2089
|
+
<a href="../../api/messages/user-message/" class="md-nav__link">
|
|
2090
|
+
|
|
2091
|
+
|
|
2092
|
+
|
|
2093
|
+
<span class="md-ellipsis">
|
|
2094
|
+
|
|
2095
|
+
|
|
2096
|
+
UserMessage
|
|
2097
|
+
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
</span>
|
|
2101
|
+
|
|
2102
|
+
|
|
2103
|
+
|
|
2104
|
+
</a>
|
|
2105
|
+
</li>
|
|
2106
|
+
|
|
2107
|
+
|
|
2108
|
+
|
|
2109
|
+
|
|
2110
|
+
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
|
|
2115
|
+
|
|
2116
|
+
<li class="md-nav__item">
|
|
2117
|
+
<a href="../../api/messages/text-message/" class="md-nav__link">
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
|
+
|
|
2121
|
+
<span class="md-ellipsis">
|
|
2122
|
+
|
|
2123
|
+
|
|
2124
|
+
TextMessage
|
|
2125
|
+
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
</span>
|
|
2129
|
+
|
|
2130
|
+
|
|
2131
|
+
|
|
2132
|
+
</a>
|
|
2133
|
+
</li>
|
|
2134
|
+
|
|
2135
|
+
|
|
2136
|
+
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
|
|
2142
|
+
|
|
2143
|
+
|
|
2144
|
+
<li class="md-nav__item">
|
|
2145
|
+
<a href="../../api/messages/tool-call-message/" class="md-nav__link">
|
|
2146
|
+
|
|
2147
|
+
|
|
2148
|
+
|
|
2149
|
+
<span class="md-ellipsis">
|
|
2150
|
+
|
|
2151
|
+
|
|
2152
|
+
ToolCallMessage
|
|
2153
|
+
|
|
2154
|
+
|
|
2155
|
+
|
|
2156
|
+
</span>
|
|
2157
|
+
|
|
2158
|
+
|
|
2159
|
+
|
|
2160
|
+
</a>
|
|
2161
|
+
</li>
|
|
2162
|
+
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
|
|
2171
|
+
|
|
2172
|
+
<li class="md-nav__item">
|
|
2173
|
+
<a href="../../api/messages/tool-result-message/" class="md-nav__link">
|
|
2174
|
+
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
<span class="md-ellipsis">
|
|
2178
|
+
|
|
2179
|
+
|
|
2180
|
+
ToolResultMessage
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
</span>
|
|
2185
|
+
|
|
2186
|
+
|
|
2187
|
+
|
|
2188
|
+
</a>
|
|
2189
|
+
</li>
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
|
|
2193
|
+
|
|
2194
|
+
</ul>
|
|
2195
|
+
</nav>
|
|
2196
|
+
|
|
2197
|
+
</li>
|
|
2198
|
+
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
|
|
2205
|
+
|
|
2206
|
+
|
|
2207
|
+
|
|
2208
|
+
|
|
2209
|
+
|
|
2210
|
+
|
|
2211
|
+
|
|
2212
|
+
|
|
2213
|
+
|
|
2214
|
+
|
|
2215
|
+
|
|
2216
|
+
|
|
2217
|
+
|
|
2218
|
+
|
|
2219
|
+
|
|
2220
|
+
|
|
2221
|
+
|
|
2222
|
+
|
|
2223
|
+
|
|
2224
|
+
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2229
|
+
|
|
2230
|
+
|
|
2231
|
+
|
|
2232
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" >
|
|
2233
|
+
|
|
2234
|
+
|
|
2235
|
+
<div class="md-nav__link md-nav__container">
|
|
2236
|
+
<a href="../../api/mcp/" class="md-nav__link ">
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
|
|
2240
|
+
<span class="md-ellipsis">
|
|
2241
|
+
|
|
2242
|
+
|
|
2243
|
+
MCP
|
|
2244
|
+
|
|
2245
|
+
|
|
2246
|
+
|
|
2247
|
+
</span>
|
|
2248
|
+
|
|
2249
|
+
|
|
2250
|
+
|
|
2251
|
+
</a>
|
|
2252
|
+
|
|
2253
|
+
|
|
2254
|
+
<label class="md-nav__link " for="__nav_5_4" id="__nav_5_4_label" tabindex="0">
|
|
2255
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2256
|
+
</label>
|
|
2257
|
+
|
|
2258
|
+
</div>
|
|
2259
|
+
|
|
2260
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="false">
|
|
2261
|
+
<label class="md-nav__title" for="__nav_5_4">
|
|
2262
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2263
|
+
|
|
2264
|
+
|
|
2265
|
+
MCP
|
|
2266
|
+
|
|
2267
|
+
|
|
2268
|
+
</label>
|
|
2269
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2270
|
+
|
|
2271
|
+
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
|
|
2275
|
+
|
|
2276
|
+
|
|
2277
|
+
|
|
2278
|
+
|
|
2279
|
+
<li class="md-nav__item">
|
|
2280
|
+
<a href="../../api/mcp/client/" class="md-nav__link">
|
|
2281
|
+
|
|
2282
|
+
|
|
2283
|
+
|
|
2284
|
+
<span class="md-ellipsis">
|
|
2285
|
+
|
|
2286
|
+
|
|
2287
|
+
Client
|
|
2288
|
+
|
|
2289
|
+
|
|
2290
|
+
|
|
2291
|
+
</span>
|
|
2292
|
+
|
|
2293
|
+
|
|
2294
|
+
|
|
2295
|
+
</a>
|
|
2296
|
+
</li>
|
|
2297
|
+
|
|
2298
|
+
|
|
2299
|
+
|
|
2300
|
+
|
|
2301
|
+
|
|
2302
|
+
|
|
2303
|
+
|
|
2304
|
+
|
|
2305
|
+
|
|
2306
|
+
|
|
2307
|
+
<li class="md-nav__item">
|
|
2308
|
+
<a href="../../api/mcp/server/" class="md-nav__link">
|
|
2309
|
+
|
|
2310
|
+
|
|
2311
|
+
|
|
2312
|
+
<span class="md-ellipsis">
|
|
2313
|
+
|
|
2314
|
+
|
|
2315
|
+
Server
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
</span>
|
|
2320
|
+
|
|
2321
|
+
|
|
2322
|
+
|
|
2323
|
+
</a>
|
|
2324
|
+
</li>
|
|
2325
|
+
|
|
2326
|
+
|
|
2327
|
+
|
|
2328
|
+
|
|
2329
|
+
|
|
2330
|
+
|
|
2331
|
+
|
|
2332
|
+
|
|
2333
|
+
|
|
2334
|
+
|
|
2335
|
+
<li class="md-nav__item">
|
|
2336
|
+
<a href="../../api/mcp/transports/" class="md-nav__link">
|
|
2337
|
+
|
|
2338
|
+
|
|
2339
|
+
|
|
2340
|
+
<span class="md-ellipsis">
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
Transports
|
|
2344
|
+
|
|
2345
|
+
|
|
2346
|
+
|
|
2347
|
+
</span>
|
|
2348
|
+
|
|
2349
|
+
|
|
2350
|
+
|
|
2351
|
+
</a>
|
|
2352
|
+
</li>
|
|
2353
|
+
|
|
2354
|
+
|
|
2355
|
+
|
|
2356
|
+
|
|
2357
|
+
</ul>
|
|
2358
|
+
</nav>
|
|
2359
|
+
|
|
2360
|
+
</li>
|
|
2361
|
+
|
|
2362
|
+
|
|
2363
|
+
|
|
2364
|
+
|
|
2365
|
+
|
|
2366
|
+
|
|
2367
|
+
|
|
2368
|
+
|
|
2369
|
+
|
|
2370
|
+
|
|
2371
|
+
|
|
2372
|
+
|
|
2373
|
+
|
|
2374
|
+
|
|
2375
|
+
|
|
2376
|
+
|
|
2377
|
+
|
|
2378
|
+
|
|
2379
|
+
|
|
2380
|
+
|
|
2381
|
+
|
|
2382
|
+
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
|
|
2389
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2390
|
+
|
|
2391
|
+
|
|
2392
|
+
|
|
2393
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" >
|
|
2394
|
+
|
|
2395
|
+
|
|
2396
|
+
<div class="md-nav__link md-nav__container">
|
|
2397
|
+
<a href="../../api/streaming/" class="md-nav__link ">
|
|
2398
|
+
|
|
2399
|
+
|
|
2400
|
+
|
|
2401
|
+
<span class="md-ellipsis">
|
|
2402
|
+
|
|
2403
|
+
|
|
2404
|
+
Streaming
|
|
2405
|
+
|
|
2406
|
+
|
|
2407
|
+
|
|
2408
|
+
</span>
|
|
2409
|
+
|
|
2410
|
+
|
|
2411
|
+
|
|
2412
|
+
</a>
|
|
2413
|
+
|
|
2414
|
+
|
|
2415
|
+
<label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
|
|
2416
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2417
|
+
</label>
|
|
2418
|
+
|
|
2419
|
+
</div>
|
|
2420
|
+
|
|
2421
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
|
|
2422
|
+
<label class="md-nav__title" for="__nav_5_5">
|
|
2423
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2424
|
+
|
|
2425
|
+
|
|
2426
|
+
Streaming
|
|
2427
|
+
|
|
2428
|
+
|
|
2429
|
+
</label>
|
|
2430
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2431
|
+
|
|
2432
|
+
|
|
2433
|
+
|
|
2434
|
+
|
|
2435
|
+
|
|
2436
|
+
|
|
2437
|
+
|
|
2438
|
+
|
|
2439
|
+
|
|
2440
|
+
<li class="md-nav__item">
|
|
2441
|
+
<a href="../../api/streaming/context/" class="md-nav__link">
|
|
2442
|
+
|
|
2443
|
+
|
|
2444
|
+
|
|
2445
|
+
<span class="md-ellipsis">
|
|
2446
|
+
|
|
2447
|
+
|
|
2448
|
+
Context
|
|
2449
|
+
|
|
2450
|
+
|
|
2451
|
+
|
|
2452
|
+
</span>
|
|
2453
|
+
|
|
2454
|
+
|
|
2455
|
+
|
|
2456
|
+
</a>
|
|
2457
|
+
</li>
|
|
2458
|
+
|
|
2459
|
+
|
|
2460
|
+
|
|
2461
|
+
|
|
2462
|
+
|
|
2463
|
+
|
|
2464
|
+
|
|
2465
|
+
|
|
2466
|
+
|
|
2467
|
+
|
|
2468
|
+
<li class="md-nav__item">
|
|
2469
|
+
<a href="../../api/streaming/events/" class="md-nav__link">
|
|
2470
|
+
|
|
2471
|
+
|
|
2472
|
+
|
|
2473
|
+
<span class="md-ellipsis">
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
Events
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
|
|
2480
|
+
</span>
|
|
2481
|
+
|
|
2482
|
+
|
|
2483
|
+
|
|
2484
|
+
</a>
|
|
2485
|
+
</li>
|
|
2486
|
+
|
|
2487
|
+
|
|
2488
|
+
|
|
2489
|
+
|
|
2490
|
+
</ul>
|
|
2491
|
+
</nav>
|
|
2492
|
+
|
|
2493
|
+
</li>
|
|
2494
|
+
|
|
2495
|
+
|
|
2496
|
+
|
|
2497
|
+
|
|
2498
|
+
</ul>
|
|
2499
|
+
</nav>
|
|
2500
|
+
|
|
2501
|
+
</li>
|
|
2502
|
+
|
|
2503
|
+
|
|
2504
|
+
|
|
2505
|
+
|
|
2506
|
+
|
|
2507
|
+
|
|
2508
|
+
|
|
2509
|
+
|
|
2510
|
+
|
|
2511
|
+
|
|
2512
|
+
|
|
2513
|
+
|
|
2514
|
+
|
|
2515
|
+
|
|
2516
|
+
|
|
2517
|
+
|
|
2518
|
+
|
|
2519
|
+
|
|
2520
|
+
|
|
2521
|
+
|
|
2522
|
+
|
|
2523
|
+
|
|
2524
|
+
|
|
2525
|
+
|
|
2526
|
+
|
|
2527
|
+
|
|
2528
|
+
|
|
2529
|
+
|
|
2530
|
+
|
|
2531
|
+
|
|
2532
|
+
|
|
2533
|
+
|
|
2534
|
+
|
|
2535
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2536
|
+
|
|
2537
|
+
|
|
2538
|
+
|
|
2539
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
|
|
2540
|
+
|
|
2541
|
+
|
|
2542
|
+
<div class="md-nav__link md-nav__container">
|
|
2543
|
+
<a href="../../examples/" class="md-nav__link ">
|
|
2544
|
+
|
|
2545
|
+
|
|
2546
|
+
|
|
2547
|
+
<span class="md-ellipsis">
|
|
2548
|
+
|
|
2549
|
+
|
|
2550
|
+
Examples
|
|
2551
|
+
|
|
2552
|
+
|
|
2553
|
+
|
|
2554
|
+
</span>
|
|
2555
|
+
|
|
2556
|
+
|
|
2557
|
+
|
|
2558
|
+
</a>
|
|
2559
|
+
|
|
2560
|
+
|
|
2561
|
+
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
|
|
2562
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2563
|
+
</label>
|
|
2564
|
+
|
|
2565
|
+
</div>
|
|
2566
|
+
|
|
2567
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
2568
|
+
<label class="md-nav__title" for="__nav_6">
|
|
2569
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2570
|
+
|
|
2571
|
+
|
|
2572
|
+
Examples
|
|
2573
|
+
|
|
2574
|
+
|
|
2575
|
+
</label>
|
|
2576
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2577
|
+
|
|
2578
|
+
|
|
2579
|
+
|
|
2580
|
+
|
|
2581
|
+
|
|
2582
|
+
|
|
2583
|
+
|
|
2584
|
+
|
|
2585
|
+
|
|
2586
|
+
<li class="md-nav__item">
|
|
2587
|
+
<a href="../../examples/basic-chat/" class="md-nav__link">
|
|
2588
|
+
|
|
2589
|
+
|
|
2590
|
+
|
|
2591
|
+
<span class="md-ellipsis">
|
|
2592
|
+
|
|
2593
|
+
|
|
2594
|
+
Basic Chat
|
|
2595
|
+
|
|
2596
|
+
|
|
2597
|
+
|
|
2598
|
+
</span>
|
|
2599
|
+
|
|
2600
|
+
|
|
2601
|
+
|
|
2602
|
+
</a>
|
|
2603
|
+
</li>
|
|
2604
|
+
|
|
2605
|
+
|
|
2606
|
+
|
|
2607
|
+
|
|
2608
|
+
|
|
2609
|
+
|
|
2610
|
+
|
|
2611
|
+
|
|
2612
|
+
|
|
2613
|
+
|
|
2614
|
+
<li class="md-nav__item">
|
|
2615
|
+
<a href="../../examples/multi-robot-network/" class="md-nav__link">
|
|
2616
|
+
|
|
2617
|
+
|
|
2618
|
+
|
|
2619
|
+
<span class="md-ellipsis">
|
|
2620
|
+
|
|
2621
|
+
|
|
2622
|
+
Multi-Robot Network
|
|
2623
|
+
|
|
2624
|
+
|
|
2625
|
+
|
|
2626
|
+
</span>
|
|
2627
|
+
|
|
2628
|
+
|
|
2629
|
+
|
|
2630
|
+
</a>
|
|
2631
|
+
</li>
|
|
2632
|
+
|
|
2633
|
+
|
|
2634
|
+
|
|
2635
|
+
|
|
2636
|
+
|
|
2637
|
+
|
|
2638
|
+
|
|
2639
|
+
|
|
2640
|
+
|
|
2641
|
+
|
|
2642
|
+
<li class="md-nav__item">
|
|
2643
|
+
<a href="../../examples/tool-usage/" class="md-nav__link">
|
|
2644
|
+
|
|
2645
|
+
|
|
2646
|
+
|
|
2647
|
+
<span class="md-ellipsis">
|
|
2648
|
+
|
|
2649
|
+
|
|
2650
|
+
Tool Usage
|
|
2651
|
+
|
|
2652
|
+
|
|
2653
|
+
|
|
2654
|
+
</span>
|
|
2655
|
+
|
|
2656
|
+
|
|
2657
|
+
|
|
2658
|
+
</a>
|
|
2659
|
+
</li>
|
|
2660
|
+
|
|
2661
|
+
|
|
2662
|
+
|
|
2663
|
+
|
|
2664
|
+
|
|
2665
|
+
|
|
2666
|
+
|
|
2667
|
+
|
|
2668
|
+
|
|
2669
|
+
|
|
2670
|
+
<li class="md-nav__item">
|
|
2671
|
+
<a href="../../examples/mcp-server/" class="md-nav__link">
|
|
2672
|
+
|
|
2673
|
+
|
|
2674
|
+
|
|
2675
|
+
<span class="md-ellipsis">
|
|
2676
|
+
|
|
2677
|
+
|
|
2678
|
+
MCP Server
|
|
2679
|
+
|
|
2680
|
+
|
|
2681
|
+
|
|
2682
|
+
</span>
|
|
2683
|
+
|
|
2684
|
+
|
|
2685
|
+
|
|
2686
|
+
</a>
|
|
2687
|
+
</li>
|
|
2688
|
+
|
|
2689
|
+
|
|
2690
|
+
|
|
2691
|
+
|
|
2692
|
+
|
|
2693
|
+
|
|
2694
|
+
|
|
2695
|
+
|
|
2696
|
+
|
|
2697
|
+
|
|
2698
|
+
<li class="md-nav__item">
|
|
2699
|
+
<a href="../../examples/rails-application/" class="md-nav__link">
|
|
2700
|
+
|
|
2701
|
+
|
|
2702
|
+
|
|
2703
|
+
<span class="md-ellipsis">
|
|
2704
|
+
|
|
2705
|
+
|
|
2706
|
+
Rails Application
|
|
2707
|
+
|
|
2708
|
+
|
|
2709
|
+
|
|
2710
|
+
</span>
|
|
2711
|
+
|
|
2712
|
+
|
|
2713
|
+
|
|
2714
|
+
</a>
|
|
2715
|
+
</li>
|
|
2716
|
+
|
|
2717
|
+
|
|
2718
|
+
|
|
2719
|
+
|
|
2720
|
+
</ul>
|
|
2721
|
+
</nav>
|
|
2722
|
+
|
|
2723
|
+
</li>
|
|
2724
|
+
|
|
2725
|
+
|
|
2726
|
+
|
|
2727
|
+
</ul>
|
|
2728
|
+
</nav>
|
|
2729
|
+
</div>
|
|
2730
|
+
</div>
|
|
2731
|
+
</div>
|
|
2732
|
+
|
|
2733
|
+
|
|
2734
|
+
|
|
2735
|
+
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
2736
|
+
<div class="md-sidebar__scrollwrap">
|
|
2737
|
+
<div class="md-sidebar__inner">
|
|
2738
|
+
|
|
2739
|
+
|
|
2740
|
+
|
|
2741
|
+
|
|
2742
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
2743
|
+
|
|
2744
|
+
|
|
2745
|
+
|
|
2746
|
+
|
|
2747
|
+
|
|
2748
|
+
|
|
2749
|
+
<label class="md-nav__title" for="__toc">
|
|
2750
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2751
|
+
On this page
|
|
2752
|
+
</label>
|
|
2753
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
2754
|
+
|
|
2755
|
+
<li class="md-nav__item">
|
|
2756
|
+
<a href="#defining-tools" class="md-nav__link">
|
|
2757
|
+
<span class="md-ellipsis">
|
|
2758
|
+
|
|
2759
|
+
Defining Tools
|
|
2760
|
+
|
|
2761
|
+
</span>
|
|
2762
|
+
</a>
|
|
2763
|
+
|
|
2764
|
+
<nav class="md-nav" aria-label="Defining Tools">
|
|
2765
|
+
<ul class="md-nav__list">
|
|
2766
|
+
|
|
2767
|
+
<li class="md-nav__item">
|
|
2768
|
+
<a href="#rubyllmtool-subclass" class="md-nav__link">
|
|
2769
|
+
<span class="md-ellipsis">
|
|
2770
|
+
|
|
2771
|
+
RubyLLM::Tool Subclass
|
|
2772
|
+
|
|
2773
|
+
</span>
|
|
2774
|
+
</a>
|
|
2775
|
+
|
|
2776
|
+
</li>
|
|
2777
|
+
|
|
2778
|
+
<li class="md-nav__item">
|
|
2779
|
+
<a href="#robotlabtool-subclass" class="md-nav__link">
|
|
2780
|
+
<span class="md-ellipsis">
|
|
2781
|
+
|
|
2782
|
+
RobotLab::Tool Subclass
|
|
2783
|
+
|
|
2784
|
+
</span>
|
|
2785
|
+
</a>
|
|
2786
|
+
|
|
2787
|
+
</li>
|
|
2788
|
+
|
|
2789
|
+
<li class="md-nav__item">
|
|
2790
|
+
<a href="#robotlabtoolcreate-dynamic-tools" class="md-nav__link">
|
|
2791
|
+
<span class="md-ellipsis">
|
|
2792
|
+
|
|
2793
|
+
RobotLab::Tool.create (Dynamic Tools)
|
|
2794
|
+
|
|
2795
|
+
</span>
|
|
2796
|
+
</a>
|
|
2797
|
+
|
|
2798
|
+
</li>
|
|
2799
|
+
|
|
2800
|
+
</ul>
|
|
2801
|
+
</nav>
|
|
2802
|
+
|
|
2803
|
+
</li>
|
|
2804
|
+
|
|
2805
|
+
<li class="md-nav__item">
|
|
2806
|
+
<a href="#built-in-tools" class="md-nav__link">
|
|
2807
|
+
<span class="md-ellipsis">
|
|
2808
|
+
|
|
2809
|
+
Built-in Tools
|
|
2810
|
+
|
|
2811
|
+
</span>
|
|
2812
|
+
</a>
|
|
2813
|
+
|
|
2814
|
+
<nav class="md-nav" aria-label="Built-in Tools">
|
|
2815
|
+
<ul class="md-nav__list">
|
|
2816
|
+
|
|
2817
|
+
<li class="md-nav__item">
|
|
2818
|
+
<a href="#askuser" class="md-nav__link">
|
|
2819
|
+
<span class="md-ellipsis">
|
|
2820
|
+
|
|
2821
|
+
AskUser
|
|
2822
|
+
|
|
2823
|
+
</span>
|
|
2824
|
+
</a>
|
|
2825
|
+
|
|
2826
|
+
</li>
|
|
2827
|
+
|
|
2828
|
+
</ul>
|
|
2829
|
+
</nav>
|
|
2830
|
+
|
|
2831
|
+
</li>
|
|
2832
|
+
|
|
2833
|
+
<li class="md-nav__item">
|
|
2834
|
+
<a href="#attaching-tools-to-robots" class="md-nav__link">
|
|
2835
|
+
<span class="md-ellipsis">
|
|
2836
|
+
|
|
2837
|
+
Attaching Tools to Robots
|
|
2838
|
+
|
|
2839
|
+
</span>
|
|
2840
|
+
</a>
|
|
2841
|
+
|
|
2842
|
+
<nav class="md-nav" aria-label="Attaching Tools to Robots">
|
|
2843
|
+
<ul class="md-nav__list">
|
|
2844
|
+
|
|
2845
|
+
<li class="md-nav__item">
|
|
2846
|
+
<a href="#via-constructor" class="md-nav__link">
|
|
2847
|
+
<span class="md-ellipsis">
|
|
2848
|
+
|
|
2849
|
+
Via Constructor
|
|
2850
|
+
|
|
2851
|
+
</span>
|
|
2852
|
+
</a>
|
|
2853
|
+
|
|
2854
|
+
</li>
|
|
2855
|
+
|
|
2856
|
+
<li class="md-nav__item">
|
|
2857
|
+
<a href="#via-template-front-matter" class="md-nav__link">
|
|
2858
|
+
<span class="md-ellipsis">
|
|
2859
|
+
|
|
2860
|
+
Via Template Front Matter
|
|
2861
|
+
|
|
2862
|
+
</span>
|
|
2863
|
+
</a>
|
|
2864
|
+
|
|
2865
|
+
</li>
|
|
2866
|
+
|
|
2867
|
+
<li class="md-nav__item">
|
|
2868
|
+
<a href="#via-chaining" class="md-nav__link">
|
|
2869
|
+
<span class="md-ellipsis">
|
|
2870
|
+
|
|
2871
|
+
Via Chaining
|
|
2872
|
+
|
|
2873
|
+
</span>
|
|
2874
|
+
</a>
|
|
2875
|
+
|
|
2876
|
+
</li>
|
|
2877
|
+
|
|
2878
|
+
</ul>
|
|
2879
|
+
</nav>
|
|
2880
|
+
|
|
2881
|
+
</li>
|
|
2882
|
+
|
|
2883
|
+
<li class="md-nav__item">
|
|
2884
|
+
<a href="#parameter-types" class="md-nav__link">
|
|
2885
|
+
<span class="md-ellipsis">
|
|
2886
|
+
|
|
2887
|
+
Parameter Types
|
|
2888
|
+
|
|
2889
|
+
</span>
|
|
2890
|
+
</a>
|
|
2891
|
+
|
|
2892
|
+
<nav class="md-nav" aria-label="Parameter Types">
|
|
2893
|
+
<ul class="md-nav__list">
|
|
2894
|
+
|
|
2895
|
+
<li class="md-nav__item">
|
|
2896
|
+
<a href="#string" class="md-nav__link">
|
|
2897
|
+
<span class="md-ellipsis">
|
|
2898
|
+
|
|
2899
|
+
String
|
|
2900
|
+
|
|
2901
|
+
</span>
|
|
2902
|
+
</a>
|
|
2903
|
+
|
|
2904
|
+
</li>
|
|
2905
|
+
|
|
2906
|
+
<li class="md-nav__item">
|
|
2907
|
+
<a href="#integer" class="md-nav__link">
|
|
2908
|
+
<span class="md-ellipsis">
|
|
2909
|
+
|
|
2910
|
+
Integer
|
|
2911
|
+
|
|
2912
|
+
</span>
|
|
2913
|
+
</a>
|
|
2914
|
+
|
|
2915
|
+
</li>
|
|
2916
|
+
|
|
2917
|
+
<li class="md-nav__item">
|
|
2918
|
+
<a href="#number-float" class="md-nav__link">
|
|
2919
|
+
<span class="md-ellipsis">
|
|
2920
|
+
|
|
2921
|
+
Number (Float)
|
|
2922
|
+
|
|
2923
|
+
</span>
|
|
2924
|
+
</a>
|
|
2925
|
+
|
|
2926
|
+
</li>
|
|
2927
|
+
|
|
2928
|
+
<li class="md-nav__item">
|
|
2929
|
+
<a href="#boolean" class="md-nav__link">
|
|
2930
|
+
<span class="md-ellipsis">
|
|
2931
|
+
|
|
2932
|
+
Boolean
|
|
2933
|
+
|
|
2934
|
+
</span>
|
|
2935
|
+
</a>
|
|
2936
|
+
|
|
2937
|
+
</li>
|
|
2938
|
+
|
|
2939
|
+
<li class="md-nav__item">
|
|
2940
|
+
<a href="#array" class="md-nav__link">
|
|
2941
|
+
<span class="md-ellipsis">
|
|
2942
|
+
|
|
2943
|
+
Array
|
|
2944
|
+
|
|
2945
|
+
</span>
|
|
2946
|
+
</a>
|
|
2947
|
+
|
|
2948
|
+
</li>
|
|
2949
|
+
|
|
2950
|
+
<li class="md-nav__item">
|
|
2951
|
+
<a href="#enum" class="md-nav__link">
|
|
2952
|
+
<span class="md-ellipsis">
|
|
2953
|
+
|
|
2954
|
+
Enum
|
|
2955
|
+
|
|
2956
|
+
</span>
|
|
2957
|
+
</a>
|
|
2958
|
+
|
|
2959
|
+
</li>
|
|
2960
|
+
|
|
2961
|
+
<li class="md-nav__item">
|
|
2962
|
+
<a href="#required-vs-optional" class="md-nav__link">
|
|
2963
|
+
<span class="md-ellipsis">
|
|
2964
|
+
|
|
2965
|
+
Required vs Optional
|
|
2966
|
+
|
|
2967
|
+
</span>
|
|
2968
|
+
</a>
|
|
2969
|
+
|
|
2970
|
+
</li>
|
|
2971
|
+
|
|
2972
|
+
</ul>
|
|
2973
|
+
</nav>
|
|
2974
|
+
|
|
2975
|
+
</li>
|
|
2976
|
+
|
|
2977
|
+
<li class="md-nav__item">
|
|
2978
|
+
<a href="#tool-patterns" class="md-nav__link">
|
|
2979
|
+
<span class="md-ellipsis">
|
|
2980
|
+
|
|
2981
|
+
Tool Patterns
|
|
2982
|
+
|
|
2983
|
+
</span>
|
|
2984
|
+
</a>
|
|
2985
|
+
|
|
2986
|
+
<nav class="md-nav" aria-label="Tool Patterns">
|
|
2987
|
+
<ul class="md-nav__list">
|
|
2988
|
+
|
|
2989
|
+
<li class="md-nav__item">
|
|
2990
|
+
<a href="#database-lookup" class="md-nav__link">
|
|
2991
|
+
<span class="md-ellipsis">
|
|
2992
|
+
|
|
2993
|
+
Database Lookup
|
|
2994
|
+
|
|
2995
|
+
</span>
|
|
2996
|
+
</a>
|
|
2997
|
+
|
|
2998
|
+
</li>
|
|
2999
|
+
|
|
3000
|
+
<li class="md-nav__item">
|
|
3001
|
+
<a href="#api-integration" class="md-nav__link">
|
|
3002
|
+
<span class="md-ellipsis">
|
|
3003
|
+
|
|
3004
|
+
API Integration
|
|
3005
|
+
|
|
3006
|
+
</span>
|
|
3007
|
+
</a>
|
|
3008
|
+
|
|
3009
|
+
</li>
|
|
3010
|
+
|
|
3011
|
+
<li class="md-nav__item">
|
|
3012
|
+
<a href="#file-operations" class="md-nav__link">
|
|
3013
|
+
<span class="md-ellipsis">
|
|
3014
|
+
|
|
3015
|
+
File Operations
|
|
3016
|
+
|
|
3017
|
+
</span>
|
|
3018
|
+
</a>
|
|
3019
|
+
|
|
3020
|
+
</li>
|
|
3021
|
+
|
|
3022
|
+
<li class="md-nav__item">
|
|
3023
|
+
<a href="#multi-step-operations" class="md-nav__link">
|
|
3024
|
+
<span class="md-ellipsis">
|
|
3025
|
+
|
|
3026
|
+
Multi-Step Operations
|
|
3027
|
+
|
|
3028
|
+
</span>
|
|
3029
|
+
</a>
|
|
3030
|
+
|
|
3031
|
+
</li>
|
|
3032
|
+
|
|
3033
|
+
</ul>
|
|
3034
|
+
</nav>
|
|
3035
|
+
|
|
3036
|
+
</li>
|
|
3037
|
+
|
|
3038
|
+
<li class="md-nav__item">
|
|
3039
|
+
<a href="#tool-return-values" class="md-nav__link">
|
|
3040
|
+
<span class="md-ellipsis">
|
|
3041
|
+
|
|
3042
|
+
Tool Return Values
|
|
3043
|
+
|
|
3044
|
+
</span>
|
|
3045
|
+
</a>
|
|
3046
|
+
|
|
3047
|
+
<nav class="md-nav" aria-label="Tool Return Values">
|
|
3048
|
+
<ul class="md-nav__list">
|
|
3049
|
+
|
|
3050
|
+
<li class="md-nav__item">
|
|
3051
|
+
<a href="#structured-data" class="md-nav__link">
|
|
3052
|
+
<span class="md-ellipsis">
|
|
3053
|
+
|
|
3054
|
+
Structured Data
|
|
3055
|
+
|
|
3056
|
+
</span>
|
|
3057
|
+
</a>
|
|
3058
|
+
|
|
3059
|
+
</li>
|
|
3060
|
+
|
|
3061
|
+
<li class="md-nav__item">
|
|
3062
|
+
<a href="#simple-values" class="md-nav__link">
|
|
3063
|
+
<span class="md-ellipsis">
|
|
3064
|
+
|
|
3065
|
+
Simple Values
|
|
3066
|
+
|
|
3067
|
+
</span>
|
|
3068
|
+
</a>
|
|
3069
|
+
|
|
3070
|
+
</li>
|
|
3071
|
+
|
|
3072
|
+
<li class="md-nav__item">
|
|
3073
|
+
<a href="#lists" class="md-nav__link">
|
|
3074
|
+
<span class="md-ellipsis">
|
|
3075
|
+
|
|
3076
|
+
Lists
|
|
3077
|
+
|
|
3078
|
+
</span>
|
|
3079
|
+
</a>
|
|
3080
|
+
|
|
3081
|
+
</li>
|
|
3082
|
+
|
|
3083
|
+
</ul>
|
|
3084
|
+
</nav>
|
|
3085
|
+
|
|
3086
|
+
</li>
|
|
3087
|
+
|
|
3088
|
+
<li class="md-nav__item">
|
|
3089
|
+
<a href="#error-handling" class="md-nav__link">
|
|
3090
|
+
<span class="md-ellipsis">
|
|
3091
|
+
|
|
3092
|
+
Error Handling
|
|
3093
|
+
|
|
3094
|
+
</span>
|
|
3095
|
+
</a>
|
|
3096
|
+
|
|
3097
|
+
<nav class="md-nav" aria-label="Error Handling">
|
|
3098
|
+
<ul class="md-nav__list">
|
|
3099
|
+
|
|
3100
|
+
<li class="md-nav__item">
|
|
3101
|
+
<a href="#automatic-error-handling" class="md-nav__link">
|
|
3102
|
+
<span class="md-ellipsis">
|
|
3103
|
+
|
|
3104
|
+
Automatic Error Handling
|
|
3105
|
+
|
|
3106
|
+
</span>
|
|
3107
|
+
</a>
|
|
3108
|
+
|
|
3109
|
+
</li>
|
|
3110
|
+
|
|
3111
|
+
<li class="md-nav__item">
|
|
3112
|
+
<a href="#critical-tools-opt-out" class="md-nav__link">
|
|
3113
|
+
<span class="md-ellipsis">
|
|
3114
|
+
|
|
3115
|
+
Critical Tools (Opt-Out)
|
|
3116
|
+
|
|
3117
|
+
</span>
|
|
3118
|
+
</a>
|
|
3119
|
+
|
|
3120
|
+
</li>
|
|
3121
|
+
|
|
3122
|
+
<li class="md-nav__item">
|
|
3123
|
+
<a href="#manual-error-handling" class="md-nav__link">
|
|
3124
|
+
<span class="md-ellipsis">
|
|
3125
|
+
|
|
3126
|
+
Manual Error Handling
|
|
3127
|
+
|
|
3128
|
+
</span>
|
|
3129
|
+
</a>
|
|
3130
|
+
|
|
3131
|
+
</li>
|
|
3132
|
+
|
|
3133
|
+
</ul>
|
|
3134
|
+
</nav>
|
|
3135
|
+
|
|
3136
|
+
</li>
|
|
3137
|
+
|
|
3138
|
+
<li class="md-nav__item">
|
|
3139
|
+
<a href="#tool-callbacks" class="md-nav__link">
|
|
3140
|
+
<span class="md-ellipsis">
|
|
3141
|
+
|
|
3142
|
+
Tool Callbacks
|
|
3143
|
+
|
|
3144
|
+
</span>
|
|
3145
|
+
</a>
|
|
3146
|
+
|
|
3147
|
+
</li>
|
|
3148
|
+
|
|
3149
|
+
<li class="md-nav__item">
|
|
3150
|
+
<a href="#robotlabtoolcreate-with-schema" class="md-nav__link">
|
|
3151
|
+
<span class="md-ellipsis">
|
|
3152
|
+
|
|
3153
|
+
RobotLab::Tool.create with Schema
|
|
3154
|
+
|
|
3155
|
+
</span>
|
|
3156
|
+
</a>
|
|
3157
|
+
|
|
3158
|
+
</li>
|
|
3159
|
+
|
|
3160
|
+
<li class="md-nav__item">
|
|
3161
|
+
<a href="#best-practices" class="md-nav__link">
|
|
3162
|
+
<span class="md-ellipsis">
|
|
3163
|
+
|
|
3164
|
+
Best Practices
|
|
3165
|
+
|
|
3166
|
+
</span>
|
|
3167
|
+
</a>
|
|
3168
|
+
|
|
3169
|
+
<nav class="md-nav" aria-label="Best Practices">
|
|
3170
|
+
<ul class="md-nav__list">
|
|
3171
|
+
|
|
3172
|
+
<li class="md-nav__item">
|
|
3173
|
+
<a href="#1-clear-descriptions" class="md-nav__link">
|
|
3174
|
+
<span class="md-ellipsis">
|
|
3175
|
+
|
|
3176
|
+
1. Clear Descriptions
|
|
3177
|
+
|
|
3178
|
+
</span>
|
|
3179
|
+
</a>
|
|
3180
|
+
|
|
3181
|
+
</li>
|
|
3182
|
+
|
|
3183
|
+
<li class="md-nav__item">
|
|
3184
|
+
<a href="#2-validate-inputs" class="md-nav__link">
|
|
3185
|
+
<span class="md-ellipsis">
|
|
3186
|
+
|
|
3187
|
+
2. Validate Inputs
|
|
3188
|
+
|
|
3189
|
+
</span>
|
|
3190
|
+
</a>
|
|
3191
|
+
|
|
3192
|
+
</li>
|
|
3193
|
+
|
|
3194
|
+
<li class="md-nav__item">
|
|
3195
|
+
<a href="#3-return-structured-data" class="md-nav__link">
|
|
3196
|
+
<span class="md-ellipsis">
|
|
3197
|
+
|
|
3198
|
+
3. Return Structured Data
|
|
3199
|
+
|
|
3200
|
+
</span>
|
|
3201
|
+
</a>
|
|
3202
|
+
|
|
3203
|
+
</li>
|
|
3204
|
+
|
|
3205
|
+
<li class="md-nav__item">
|
|
3206
|
+
<a href="#4-keep-tools-focused" class="md-nav__link">
|
|
3207
|
+
<span class="md-ellipsis">
|
|
3208
|
+
|
|
3209
|
+
4. Keep Tools Focused
|
|
3210
|
+
|
|
3211
|
+
</span>
|
|
3212
|
+
</a>
|
|
3213
|
+
|
|
3214
|
+
</li>
|
|
3215
|
+
|
|
3216
|
+
</ul>
|
|
3217
|
+
</nav>
|
|
3218
|
+
|
|
3219
|
+
</li>
|
|
3220
|
+
|
|
3221
|
+
<li class="md-nav__item">
|
|
3222
|
+
<a href="#next-steps" class="md-nav__link">
|
|
3223
|
+
<span class="md-ellipsis">
|
|
3224
|
+
|
|
3225
|
+
Next Steps
|
|
3226
|
+
|
|
3227
|
+
</span>
|
|
3228
|
+
</a>
|
|
3229
|
+
|
|
3230
|
+
</li>
|
|
3231
|
+
|
|
3232
|
+
</ul>
|
|
3233
|
+
|
|
3234
|
+
</nav>
|
|
3235
|
+
</div>
|
|
3236
|
+
</div>
|
|
3237
|
+
</div>
|
|
3238
|
+
|
|
3239
|
+
|
|
3240
|
+
|
|
3241
|
+
<div class="md-content" data-md-component="content">
|
|
3242
|
+
|
|
3243
|
+
|
|
3244
|
+
|
|
3245
|
+
|
|
3246
|
+
|
|
3247
|
+
|
|
3248
|
+
|
|
3249
|
+
<article class="md-content__inner md-typeset">
|
|
3250
|
+
|
|
3251
|
+
|
|
3252
|
+
|
|
3253
|
+
|
|
3254
|
+
|
|
3255
|
+
<a href="https://github.com/madbomber/robot_lab/edit/main/docs/guides/using-tools.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
|
|
3256
|
+
|
|
3257
|
+
<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>
|
|
3258
|
+
</a>
|
|
3259
|
+
|
|
3260
|
+
|
|
3261
|
+
|
|
3262
|
+
|
|
3263
|
+
|
|
3264
|
+
<a href="https://github.com/madbomber/robot_lab/raw/main/docs/guides/using-tools.md" title="View source of this page" class="md-content__button md-icon">
|
|
3265
|
+
|
|
3266
|
+
<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>
|
|
3267
|
+
</a>
|
|
3268
|
+
|
|
3269
|
+
|
|
3270
|
+
|
|
3271
|
+
<h1 id="using-tools">Using Tools<a class="headerlink" href="#using-tools" title="Permanent link">¶</a></h1>
|
|
3272
|
+
<p>Tools give robots the ability to interact with external systems. RobotLab supports three approaches: <code>RubyLLM::Tool</code> subclasses, <code>RobotLab::Tool</code> subclasses (with robot access), and <code>RobotLab::Tool.create</code> for dynamic tools.</p>
|
|
3273
|
+
<h2 id="defining-tools">Defining Tools<a class="headerlink" href="#defining-tools" title="Permanent link">¶</a></h2>
|
|
3274
|
+
<h3 id="rubyllmtool-subclass">RubyLLM::Tool Subclass<a class="headerlink" href="#rubyllmtool-subclass" title="Permanent link">¶</a></h3>
|
|
3275
|
+
<p>For reusable tools that don't need robot access:</p>
|
|
3276
|
+
<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"><</span><span class="w"> </span><span class="no">RubyLLM</span><span class="o">::</span><span class="no">Tool</span>
|
|
3277
|
+
</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">"Get current weather for a location"</span>
|
|
3278
|
+
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>
|
|
3279
|
+
</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="ss">:string</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">"City name or zip code"</span>
|
|
3280
|
+
</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="ss">:string</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">"Temperature unit"</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>
|
|
3281
|
+
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a>
|
|
3282
|
+
</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">"celsius"</span><span class="p">)</span>
|
|
3283
|
+
</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>
|
|
3284
|
+
</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>
|
|
3285
|
+
</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>
|
|
3286
|
+
</span></code></pre></div>
|
|
3287
|
+
<h3 id="robotlabtool-subclass">RobotLab::Tool Subclass<a class="headerlink" href="#robotlabtool-subclass" title="Permanent link">¶</a></h3>
|
|
3288
|
+
<p>For tools that need access to their owning robot (self-modification, spawning, etc.):</p>
|
|
3289
|
+
<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="k">class</span><span class="w"> </span><span class="nc">AdjustEnergy</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>
|
|
3290
|
+
</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="n">description</span><span class="w"> </span><span class="s2">"Adjust the robot's creativity level"</span>
|
|
3291
|
+
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
|
|
3292
|
+
</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="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">"number"</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">"Temperature from 0.0 to 1.0"</span>
|
|
3293
|
+
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>
|
|
3294
|
+
</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="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>
|
|
3295
|
+
</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="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>
|
|
3296
|
+
</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="s2">"Temperature adjusted to </span><span class="si">#{</span><span class="n">level</span><span class="si">}</span><span class="s2">"</span>
|
|
3297
|
+
</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="k">end</span>
|
|
3298
|
+
</span><span id="__span-1-10"><a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="k">end</span>
|
|
3299
|
+
</span></code></pre></div>
|
|
3300
|
+
<p>Pass <code>robot: self</code> when constructing:</p>
|
|
3301
|
+
<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="k">class</span><span class="w"> </span><span class="nc">MyRobot</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>
|
|
3302
|
+
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span>
|
|
3303
|
+
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="w"> </span><span class="k">super</span><span class="p">(</span>
|
|
3304
|
+
</span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"creative_bot"</span><span class="p">,</span>
|
|
3305
|
+
</span><span id="__span-2-5"><a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"You are creative."</span><span class="p">,</span>
|
|
3306
|
+
</span><span id="__span-2-6"><a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w"> </span><span class="ss">local_tools</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="no">AdjustEnergy</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>
|
|
3307
|
+
</span><span id="__span-2-7"><a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="w"> </span><span class="p">)</span>
|
|
3308
|
+
</span><span id="__span-2-8"><a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="w"> </span><span class="k">end</span>
|
|
3309
|
+
</span><span id="__span-2-9"><a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="k">end</span>
|
|
3310
|
+
</span></code></pre></div>
|
|
3311
|
+
<h3 id="robotlabtoolcreate-dynamic-tools">RobotLab::Tool.create (Dynamic Tools)<a class="headerlink" href="#robotlabtoolcreate-dynamic-tools" title="Permanent link">¶</a></h3>
|
|
3312
|
+
<p>For quick, inline tools use the <code>Tool.create</code> factory:</p>
|
|
3313
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="n">get_time</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>
|
|
3314
|
+
</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"get_time"</span><span class="p">,</span>
|
|
3315
|
+
</span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="ss">description</span><span class="p">:</span><span class="w"> </span><span class="s2">"Get the current time"</span>
|
|
3316
|
+
</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></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">Time</span><span class="o">.</span><span class="n">now</span><span class="o">.</span><span class="n">to_s</span><span class="w"> </span><span class="p">}</span>
|
|
3317
|
+
</span></code></pre></div>
|
|
3318
|
+
<p>With parameters:</p>
|
|
3319
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="n">weather_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>
|
|
3320
|
+
</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><span class="w"> </span><span class="s2">"get_weather"</span><span class="p">,</span>
|
|
3321
|
+
</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="s2">"Get current weather for a location"</span><span class="p">,</span>
|
|
3322
|
+
</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="p">{</span>
|
|
3323
|
+
</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">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</span><span class="p">,</span>
|
|
3324
|
+
</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">properties</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
3325
|
+
</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="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">"string"</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">"City name"</span><span class="w"> </span><span class="p">}</span>
|
|
3326
|
+
</span><span id="__span-4-8"><a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="w"> </span><span class="p">},</span>
|
|
3327
|
+
</span><span id="__span-4-9"><a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-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">"location"</span><span class="o">]</span>
|
|
3328
|
+
</span><span id="__span-4-10"><a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a><span class="w"> </span><span class="p">}</span>
|
|
3329
|
+
</span><span id="__span-4-11"><a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-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>
|
|
3330
|
+
</span></code></pre></div>
|
|
3331
|
+
<h2 id="built-in-tools">Built-in Tools<a class="headerlink" href="#built-in-tools" title="Permanent link">¶</a></h2>
|
|
3332
|
+
<h3 id="askuser">AskUser<a class="headerlink" href="#askuser" title="Permanent link">¶</a></h3>
|
|
3333
|
+
<p><code>RobotLab::AskUser</code> lets a robot ask the user a question via the terminal. The LLM decides when it needs human input and calls the tool with a question, optional choices, and an optional default.</p>
|
|
3334
|
+
<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="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>
|
|
3335
|
+
</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="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"onboarding"</span><span class="p">,</span>
|
|
3336
|
+
</span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"Walk the user through project setup. Ask questions to understand their needs."</span><span class="p">,</span>
|
|
3337
|
+
</span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-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>
|
|
3338
|
+
</span><span id="__span-5-5"><a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="p">)</span>
|
|
3339
|
+
</span><span id="__span-5-6"><a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"Help the user set up a new project"</span><span class="p">)</span>
|
|
3340
|
+
</span></code></pre></div>
|
|
3341
|
+
<p>The tool displays the robot's name and question, then waits for terminal input:</p>
|
|
3342
|
+
<div class="language-text highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>[onboarding] What programming language will you use?
|
|
3343
|
+
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a> 1. Ruby
|
|
3344
|
+
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a> 2. Python
|
|
3345
|
+
</span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a> 3. Go
|
|
3346
|
+
</span><span id="__span-6-5"><a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a>>
|
|
3347
|
+
</span></code></pre></div>
|
|
3348
|
+
<p>Features:</p>
|
|
3349
|
+
<ul>
|
|
3350
|
+
<li><strong>Open-ended</strong>: just a question, free-text response</li>
|
|
3351
|
+
<li><strong>Multiple choice</strong>: numbered options, user types the number or text</li>
|
|
3352
|
+
<li><strong>Default value</strong>: shown in the prompt, used when user presses Enter</li>
|
|
3353
|
+
</ul>
|
|
3354
|
+
<p>IO is sourced from <code>robot.input</code> / <code>robot.output</code> (defaulting to <code>$stdin</code> / <code>$stdout</code>), making it easy to test with <code>StringIO</code>:</p>
|
|
3355
|
+
<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="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">"2</span><span class="se">\n</span><span class="s2">"</span><span class="p">)</span>
|
|
3356
|
+
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></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>
|
|
3357
|
+
</span></code></pre></div>
|
|
3358
|
+
<p>See the <a href="../../api/core/tool/#built-in-askuser">AskUser API reference</a> for full details.</p>
|
|
3359
|
+
<h2 id="attaching-tools-to-robots">Attaching Tools to Robots<a class="headerlink" href="#attaching-tools-to-robots" title="Permanent link">¶</a></h2>
|
|
3360
|
+
<h3 id="via-constructor">Via Constructor<a class="headerlink" href="#via-constructor" title="Permanent link">¶</a></h3>
|
|
3361
|
+
<p>Pass tools via the <code>local_tools:</code> parameter when building a robot:</p>
|
|
3362
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="n">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>
|
|
3363
|
+
</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="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"assistant"</span><span class="p">,</span>
|
|
3364
|
+
</span><span id="__span-8-3"><a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"You are a helpful assistant with tool access."</span><span class="p">,</span>
|
|
3365
|
+
</span><span id="__span-8-4"><a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-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">GetWeather</span><span class="p">,</span><span class="w"> </span><span class="no">CalculatorTool</span><span class="o">]</span>
|
|
3366
|
+
</span><span id="__span-8-5"><a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a><span class="p">)</span>
|
|
3367
|
+
</span></code></pre></div>
|
|
3368
|
+
<h3 id="via-template-front-matter">Via Template Front Matter<a class="headerlink" href="#via-template-front-matter" title="Permanent link">¶</a></h3>
|
|
3369
|
+
<p>Declare tool class names in the template's YAML front matter. RobotLab resolves each string to a Ruby constant via <code>Object.const_get</code> and instantiates it:</p>
|
|
3370
|
+
<div class="language-markdown highlight"><span class="filename">prompts/weather_bot.md</span><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>---
|
|
3371
|
+
</span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>description: Weather assistant with forecast tools
|
|
3372
|
+
</span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a>tools:
|
|
3373
|
+
</span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="w"> </span><span class="k">-</span><span class="w"> </span>GetWeather
|
|
3374
|
+
</span><span id="__span-9-5"><a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="gu"> - GetForecast</span>
|
|
3375
|
+
</span><span id="__span-9-6"><a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="gu">---</span>
|
|
3376
|
+
</span><span id="__span-9-7"><a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a>You are a weather assistant. Use your tools to look up weather information.
|
|
3377
|
+
</span></code></pre></div>
|
|
3378
|
+
<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="c1"># Tools are resolved from frontmatter — no local_tools: needed</span>
|
|
3379
|
+
</span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></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><span class="ss">template</span><span class="p">:</span><span class="w"> </span><span class="ss">:weather_bot</span><span class="p">)</span>
|
|
3380
|
+
</span></code></pre></div>
|
|
3381
|
+
<p>Tool classes must be defined and loaded before building the robot. Unresolvable names are skipped with a warning. Constructor <code>local_tools:</code> overrides frontmatter <code>tools:</code> when provided.</p>
|
|
3382
|
+
<h3 id="via-chaining">Via Chaining<a class="headerlink" href="#via-chaining" title="Permanent link">¶</a></h3>
|
|
3383
|
+
<p>You can also add tools dynamically with chaining:</p>
|
|
3384
|
+
<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">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><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"assistant"</span><span class="p">,</span><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">)</span>
|
|
3385
|
+
</span><span id="__span-11-2"><a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="n">robot</span><span class="o">.</span><span class="n">with_tools</span><span class="p">(</span><span class="no">GetWeather</span><span class="p">,</span><span class="w"> </span><span class="no">CalculatorTool</span><span class="p">)</span>
|
|
3386
|
+
</span></code></pre></div>
|
|
3387
|
+
<h2 id="parameter-types">Parameter Types<a class="headerlink" href="#parameter-types" title="Permanent link">¶</a></h2>
|
|
3388
|
+
<p>Define parameters on <code>RubyLLM::Tool</code> subclasses using <code>param</code>:</p>
|
|
3389
|
+
<h3 id="string">String<a class="headerlink" href="#string" title="Permanent link">¶</a></h3>
|
|
3390
|
+
<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">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="ss">:string</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">"User's full name"</span>
|
|
3391
|
+
</span></code></pre></div>
|
|
3392
|
+
<h3 id="integer">Integer<a class="headerlink" href="#integer" title="Permanent link">¶</a></h3>
|
|
3393
|
+
<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">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="ss">:integer</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">"Number of results"</span>
|
|
3394
|
+
</span></code></pre></div>
|
|
3395
|
+
<h3 id="number-float">Number (Float)<a class="headerlink" href="#number-float" title="Permanent link">¶</a></h3>
|
|
3396
|
+
<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">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="ss">:number</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">"Price in dollars"</span>
|
|
3397
|
+
</span></code></pre></div>
|
|
3398
|
+
<h3 id="boolean">Boolean<a class="headerlink" href="#boolean" title="Permanent link">¶</a></h3>
|
|
3399
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-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="ss">:boolean</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">"Whether the user is active"</span>
|
|
3400
|
+
</span></code></pre></div>
|
|
3401
|
+
<h3 id="array">Array<a class="headerlink" href="#array" title="Permanent link">¶</a></h3>
|
|
3402
|
+
<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="n">param</span><span class="w"> </span><span class="ss">:tags</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="ss">:array</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">"List of tags"</span>
|
|
3403
|
+
</span></code></pre></div>
|
|
3404
|
+
<h3 id="enum">Enum<a class="headerlink" href="#enum" title="Permanent link">¶</a></h3>
|
|
3405
|
+
<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">param</span><span class="w"> </span><span class="ss">:status</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="ss">:string</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">"Order status"</span><span class="p">,</span><span class="w"> </span><span class="ss">enum</span><span class="p">:</span><span class="w"> </span><span class="sx">%w[pending active completed]</span>
|
|
3406
|
+
</span></code></pre></div>
|
|
3407
|
+
<h3 id="required-vs-optional">Required vs Optional<a class="headerlink" href="#required-vs-optional" title="Permanent link">¶</a></h3>
|
|
3408
|
+
<p>Parameters are required by default. Mark optional with <code>required: false</code>:</p>
|
|
3409
|
+
<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">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="ss">:string</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">"Search query"</span><span class="w"> </span><span class="c1"># required</span>
|
|
3410
|
+
</span><span id="__span-18-2"><a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-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="ss">:integer</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">"Max results"</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>
|
|
3411
|
+
</span></code></pre></div>
|
|
3412
|
+
<h2 id="tool-patterns">Tool Patterns<a class="headerlink" href="#tool-patterns" title="Permanent link">¶</a></h2>
|
|
3413
|
+
<h3 id="database-lookup">Database Lookup<a class="headerlink" href="#database-lookup" title="Permanent link">¶</a></h3>
|
|
3414
|
+
<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="k">class</span><span class="w"> </span><span class="nc">FindUser</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">RubyLLM</span><span class="o">::</span><span class="no">Tool</span>
|
|
3415
|
+
</span><span id="__span-19-2"><a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a><span class="w"> </span><span class="n">description</span><span class="w"> </span><span class="s2">"Find user by email or ID"</span>
|
|
3416
|
+
</span><span id="__span-19-3"><a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a>
|
|
3417
|
+
</span><span id="__span-19-4"><a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:identifier</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="ss">:string</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">"Email address or user ID"</span>
|
|
3418
|
+
</span><span id="__span-19-5"><a id="__codelineno-19-5" name="__codelineno-19-5" href="#__codelineno-19-5"></a>
|
|
3419
|
+
</span><span id="__span-19-6"><a id="__codelineno-19-6" name="__codelineno-19-6" href="#__codelineno-19-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">identifier</span><span class="p">:)</span>
|
|
3420
|
+
</span><span id="__span-19-7"><a id="__codelineno-19-7" name="__codelineno-19-7" href="#__codelineno-19-7"></a><span class="w"> </span><span class="n">user</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">User</span><span class="o">.</span><span class="n">find_by</span><span class="p">(</span><span class="nb">id</span><span class="p">:</span><span class="w"> </span><span class="n">identifier</span><span class="p">)</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="no">User</span><span class="o">.</span><span class="n">find_by</span><span class="p">(</span><span class="ss">email</span><span class="p">:</span><span class="w"> </span><span class="n">identifier</span><span class="p">)</span>
|
|
3421
|
+
</span><span id="__span-19-8"><a id="__codelineno-19-8" name="__codelineno-19-8" href="#__codelineno-19-8"></a><span class="w"> </span><span class="n">user</span><span class="w"> </span><span class="p">?</span><span class="w"> </span><span class="n">user</span><span class="o">.</span><span class="n">to_h</span><span class="w"> </span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s2">"User not found"</span><span class="w"> </span><span class="p">}</span>
|
|
3422
|
+
</span><span id="__span-19-9"><a id="__codelineno-19-9" name="__codelineno-19-9" href="#__codelineno-19-9"></a><span class="w"> </span><span class="k">end</span>
|
|
3423
|
+
</span><span id="__span-19-10"><a id="__codelineno-19-10" name="__codelineno-19-10" href="#__codelineno-19-10"></a><span class="k">end</span>
|
|
3424
|
+
</span></code></pre></div>
|
|
3425
|
+
<h3 id="api-integration">API Integration<a class="headerlink" href="#api-integration" title="Permanent link">¶</a></h3>
|
|
3426
|
+
<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="k">class</span><span class="w"> </span><span class="nc">GetStockPrice</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">RubyLLM</span><span class="o">::</span><span class="no">Tool</span>
|
|
3427
|
+
</span><span id="__span-20-2"><a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a><span class="w"> </span><span class="n">description</span><span class="w"> </span><span class="s2">"Get current stock price for a ticker symbol"</span>
|
|
3428
|
+
</span><span id="__span-20-3"><a id="__codelineno-20-3" name="__codelineno-20-3" href="#__codelineno-20-3"></a>
|
|
3429
|
+
</span><span id="__span-20-4"><a id="__codelineno-20-4" name="__codelineno-20-4" href="#__codelineno-20-4"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:symbol</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="ss">:string</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">"Stock ticker symbol (e.g. AAPL)"</span>
|
|
3430
|
+
</span><span id="__span-20-5"><a id="__codelineno-20-5" name="__codelineno-20-5" href="#__codelineno-20-5"></a>
|
|
3431
|
+
</span><span id="__span-20-6"><a id="__codelineno-20-6" name="__codelineno-20-6" href="#__codelineno-20-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">symbol</span><span class="p">:)</span>
|
|
3432
|
+
</span><span id="__span-20-7"><a id="__codelineno-20-7" name="__codelineno-20-7" href="#__codelineno-20-7"></a><span class="w"> </span><span class="n">response</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">HTTP</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"https://api.stocks.example/quote/</span><span class="si">#{</span><span class="n">symbol</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
3433
|
+
</span><span id="__span-20-8"><a id="__codelineno-20-8" name="__codelineno-20-8" href="#__codelineno-20-8"></a><span class="w"> </span><span class="no">JSON</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="n">response</span><span class="o">.</span><span class="n">body</span><span class="p">)</span>
|
|
3434
|
+
</span><span id="__span-20-9"><a id="__codelineno-20-9" name="__codelineno-20-9" href="#__codelineno-20-9"></a><span class="w"> </span><span class="k">rescue</span><span class="w"> </span><span class="no">HTTP</span><span class="o">::</span><span class="no">Error</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="n">e</span>
|
|
3435
|
+
</span><span id="__span-20-10"><a id="__codelineno-20-10" name="__codelineno-20-10" href="#__codelineno-20-10"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s2">"Failed to fetch stock price: </span><span class="si">#{</span><span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="si">}</span><span class="s2">"</span><span class="w"> </span><span class="p">}</span>
|
|
3436
|
+
</span><span id="__span-20-11"><a id="__codelineno-20-11" name="__codelineno-20-11" href="#__codelineno-20-11"></a><span class="w"> </span><span class="k">end</span>
|
|
3437
|
+
</span><span id="__span-20-12"><a id="__codelineno-20-12" name="__codelineno-20-12" href="#__codelineno-20-12"></a><span class="k">end</span>
|
|
3438
|
+
</span></code></pre></div>
|
|
3439
|
+
<h3 id="file-operations">File Operations<a class="headerlink" href="#file-operations" title="Permanent link">¶</a></h3>
|
|
3440
|
+
<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="k">class</span><span class="w"> </span><span class="nc">ReadFile</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">RubyLLM</span><span class="o">::</span><span class="no">Tool</span>
|
|
3441
|
+
</span><span id="__span-21-2"><a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a><span class="w"> </span><span class="n">description</span><span class="w"> </span><span class="s2">"Read contents of a file"</span>
|
|
3442
|
+
</span><span id="__span-21-3"><a id="__codelineno-21-3" name="__codelineno-21-3" href="#__codelineno-21-3"></a>
|
|
3443
|
+
</span><span id="__span-21-4"><a id="__codelineno-21-4" name="__codelineno-21-4" href="#__codelineno-21-4"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:path</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="ss">:string</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">"Absolute path to the file"</span>
|
|
3444
|
+
</span><span id="__span-21-5"><a id="__codelineno-21-5" name="__codelineno-21-5" href="#__codelineno-21-5"></a>
|
|
3445
|
+
</span><span id="__span-21-6"><a id="__codelineno-21-6" name="__codelineno-21-6" href="#__codelineno-21-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">path</span><span class="p">:)</span>
|
|
3446
|
+
</span><span id="__span-21-7"><a id="__codelineno-21-7" name="__codelineno-21-7" href="#__codelineno-21-7"></a><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="no">File</span><span class="o">.</span><span class="n">exist?</span><span class="p">(</span><span class="n">path</span><span class="p">)</span><span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="no">File</span><span class="o">.</span><span class="n">readable?</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
|
|
3447
|
+
</span><span id="__span-21-8"><a id="__codelineno-21-8" name="__codelineno-21-8" href="#__codelineno-21-8"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">content</span><span class="p">:</span><span class="w"> </span><span class="no">File</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="n">path</span><span class="p">),</span><span class="w"> </span><span class="ss">size</span><span class="p">:</span><span class="w"> </span><span class="no">File</span><span class="o">.</span><span class="n">size</span><span class="p">(</span><span class="n">path</span><span class="p">)</span><span class="w"> </span><span class="p">}</span>
|
|
3448
|
+
</span><span id="__span-21-9"><a id="__codelineno-21-9" name="__codelineno-21-9" href="#__codelineno-21-9"></a><span class="w"> </span><span class="k">else</span>
|
|
3449
|
+
</span><span id="__span-21-10"><a id="__codelineno-21-10" name="__codelineno-21-10" href="#__codelineno-21-10"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s2">"File not found or not readable"</span><span class="w"> </span><span class="p">}</span>
|
|
3450
|
+
</span><span id="__span-21-11"><a id="__codelineno-21-11" name="__codelineno-21-11" href="#__codelineno-21-11"></a><span class="w"> </span><span class="k">end</span>
|
|
3451
|
+
</span><span id="__span-21-12"><a id="__codelineno-21-12" name="__codelineno-21-12" href="#__codelineno-21-12"></a><span class="w"> </span><span class="k">end</span>
|
|
3452
|
+
</span><span id="__span-21-13"><a id="__codelineno-21-13" name="__codelineno-21-13" href="#__codelineno-21-13"></a><span class="k">end</span>
|
|
3453
|
+
</span></code></pre></div>
|
|
3454
|
+
<h3 id="multi-step-operations">Multi-Step Operations<a class="headerlink" href="#multi-step-operations" title="Permanent link">¶</a></h3>
|
|
3455
|
+
<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">ProcessOrder</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">RubyLLM</span><span class="o">::</span><span class="no">Tool</span>
|
|
3456
|
+
</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">"Validate and process a customer order"</span>
|
|
3457
|
+
</span><span id="__span-22-3"><a id="__codelineno-22-3" name="__codelineno-22-3" href="#__codelineno-22-3"></a>
|
|
3458
|
+
</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">:order_id</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="ss">:string</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">"The order ID to process"</span>
|
|
3459
|
+
</span><span id="__span-22-5"><a id="__codelineno-22-5" name="__codelineno-22-5" href="#__codelineno-22-5"></a>
|
|
3460
|
+
</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">order_id</span><span class="p">:)</span>
|
|
3461
|
+
</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">order</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Order</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">order_id</span><span class="p">)</span>
|
|
3462
|
+
</span><span id="__span-22-8"><a id="__codelineno-22-8" name="__codelineno-22-8" href="#__codelineno-22-8"></a>
|
|
3463
|
+
</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="c1"># Validate</span>
|
|
3464
|
+
</span><span id="__span-22-10"><a id="__codelineno-22-10" name="__codelineno-22-10" href="#__codelineno-22-10"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s2">"Invalid order"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">unless</span><span class="w"> </span><span class="n">order</span><span class="o">.</span><span class="n">valid?</span>
|
|
3465
|
+
</span><span id="__span-22-11"><a id="__codelineno-22-11" name="__codelineno-22-11" href="#__codelineno-22-11"></a>
|
|
3466
|
+
</span><span id="__span-22-12"><a id="__codelineno-22-12" name="__codelineno-22-12" href="#__codelineno-22-12"></a><span class="w"> </span><span class="c1"># Process payment</span>
|
|
3467
|
+
</span><span id="__span-22-13"><a id="__codelineno-22-13" name="__codelineno-22-13" href="#__codelineno-22-13"></a><span class="w"> </span><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">PaymentProcessor</span><span class="o">.</span><span class="n">charge</span><span class="p">(</span><span class="n">order</span><span class="p">)</span>
|
|
3468
|
+
</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="k">return</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="n">result</span><span class="o">[</span><span class="ss">:error</span><span class="o">]</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">unless</span><span class="w"> </span><span class="n">result</span><span class="o">[</span><span class="ss">:success</span><span class="o">]</span>
|
|
3469
|
+
</span><span id="__span-22-15"><a id="__codelineno-22-15" name="__codelineno-22-15" href="#__codelineno-22-15"></a>
|
|
3470
|
+
</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="c1"># Update status</span>
|
|
3471
|
+
</span><span id="__span-22-17"><a id="__codelineno-22-17" name="__codelineno-22-17" href="#__codelineno-22-17"></a><span class="w"> </span><span class="n">order</span><span class="o">.</span><span class="n">update!</span><span class="p">(</span><span class="ss">status</span><span class="p">:</span><span class="w"> </span><span class="s2">"paid"</span><span class="p">)</span>
|
|
3472
|
+
</span><span id="__span-22-18"><a id="__codelineno-22-18" name="__codelineno-22-18" href="#__codelineno-22-18"></a>
|
|
3473
|
+
</span><span id="__span-22-19"><a id="__codelineno-22-19" name="__codelineno-22-19" href="#__codelineno-22-19"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">success</span><span class="p">:</span><span class="w"> </span><span class="kp">true</span><span class="p">,</span><span class="w"> </span><span class="ss">order_id</span><span class="p">:</span><span class="w"> </span><span class="n">order</span><span class="o">.</span><span class="n">id</span><span class="p">,</span><span class="w"> </span><span class="ss">amount</span><span class="p">:</span><span class="w"> </span><span class="n">order</span><span class="o">.</span><span class="n">total</span><span class="w"> </span><span class="p">}</span>
|
|
3474
|
+
</span><span id="__span-22-20"><a id="__codelineno-22-20" name="__codelineno-22-20" href="#__codelineno-22-20"></a><span class="w"> </span><span class="k">end</span>
|
|
3475
|
+
</span><span id="__span-22-21"><a id="__codelineno-22-21" name="__codelineno-22-21" href="#__codelineno-22-21"></a><span class="k">end</span>
|
|
3476
|
+
</span></code></pre></div>
|
|
3477
|
+
<h2 id="tool-return-values">Tool Return Values<a class="headerlink" href="#tool-return-values" title="Permanent link">¶</a></h2>
|
|
3478
|
+
<h3 id="structured-data">Structured Data<a class="headerlink" href="#structured-data" title="Permanent link">¶</a></h3>
|
|
3479
|
+
<p>Return hashes with consistent structure:</p>
|
|
3480
|
+
<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="k">def</span><span class="w"> </span><span class="nf">execute</span><span class="p">(</span><span class="ss">user_id</span><span class="p">:)</span>
|
|
3481
|
+
</span><span id="__span-23-2"><a id="__codelineno-23-2" name="__codelineno-23-2" href="#__codelineno-23-2"></a><span class="w"> </span><span class="n">user</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">User</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">user_id</span><span class="p">)</span>
|
|
3482
|
+
</span><span id="__span-23-3"><a id="__codelineno-23-3" name="__codelineno-23-3" href="#__codelineno-23-3"></a><span class="w"> </span><span class="p">{</span>
|
|
3483
|
+
</span><span id="__span-23-4"><a id="__codelineno-23-4" name="__codelineno-23-4" href="#__codelineno-23-4"></a><span class="w"> </span><span class="nb">id</span><span class="p">:</span><span class="w"> </span><span class="n">user</span><span class="o">.</span><span class="n">id</span><span class="p">,</span>
|
|
3484
|
+
</span><span id="__span-23-5"><a id="__codelineno-23-5" name="__codelineno-23-5" href="#__codelineno-23-5"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="n">user</span><span class="o">.</span><span class="n">name</span><span class="p">,</span>
|
|
3485
|
+
</span><span id="__span-23-6"><a id="__codelineno-23-6" name="__codelineno-23-6" href="#__codelineno-23-6"></a><span class="w"> </span><span class="ss">email</span><span class="p">:</span><span class="w"> </span><span class="n">user</span><span class="o">.</span><span class="n">email</span><span class="p">,</span>
|
|
3486
|
+
</span><span id="__span-23-7"><a id="__codelineno-23-7" name="__codelineno-23-7" href="#__codelineno-23-7"></a><span class="w"> </span><span class="ss">created_at</span><span class="p">:</span><span class="w"> </span><span class="n">user</span><span class="o">.</span><span class="n">created_at</span><span class="o">.</span><span class="n">iso8601</span>
|
|
3487
|
+
</span><span id="__span-23-8"><a id="__codelineno-23-8" name="__codelineno-23-8" href="#__codelineno-23-8"></a><span class="w"> </span><span class="p">}</span>
|
|
3488
|
+
</span><span id="__span-23-9"><a id="__codelineno-23-9" name="__codelineno-23-9" href="#__codelineno-23-9"></a><span class="k">end</span>
|
|
3489
|
+
</span></code></pre></div>
|
|
3490
|
+
<h3 id="simple-values">Simple Values<a class="headerlink" href="#simple-values" title="Permanent link">¶</a></h3>
|
|
3491
|
+
<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="k">def</span><span class="w"> </span><span class="nf">execute</span><span class="p">(</span><span class="o">**</span><span class="n">_</span><span class="p">)</span>
|
|
3492
|
+
</span><span id="__span-24-2"><a id="__codelineno-24-2" name="__codelineno-24-2" href="#__codelineno-24-2"></a><span class="w"> </span><span class="no">Time</span><span class="o">.</span><span class="n">now</span><span class="o">.</span><span class="n">to_s</span>
|
|
3493
|
+
</span><span id="__span-24-3"><a id="__codelineno-24-3" name="__codelineno-24-3" href="#__codelineno-24-3"></a><span class="k">end</span>
|
|
3494
|
+
</span></code></pre></div>
|
|
3495
|
+
<h3 id="lists">Lists<a class="headerlink" href="#lists" title="Permanent link">¶</a></h3>
|
|
3496
|
+
<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="k">def</span><span class="w"> </span><span class="nf">execute</span><span class="p">(</span><span class="ss">query</span><span class="p">:)</span>
|
|
3497
|
+
</span><span id="__span-25-2"><a id="__codelineno-25-2" name="__codelineno-25-2" href="#__codelineno-25-2"></a><span class="w"> </span><span class="n">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Search</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">query</span><span class="p">)</span>
|
|
3498
|
+
</span><span id="__span-25-3"><a id="__codelineno-25-3" name="__codelineno-25-3" href="#__codelineno-25-3"></a><span class="w"> </span><span class="n">results</span><span class="o">.</span><span class="n">map</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">r</span><span class="o">|</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">id</span><span class="p">:</span><span class="w"> </span><span class="n">r</span><span class="o">.</span><span class="n">id</span><span class="p">,</span><span class="w"> </span><span class="ss">title</span><span class="p">:</span><span class="w"> </span><span class="n">r</span><span class="o">.</span><span class="n">title</span><span class="p">,</span><span class="w"> </span><span class="ss">score</span><span class="p">:</span><span class="w"> </span><span class="n">r</span><span class="o">.</span><span class="n">score</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">}</span>
|
|
3499
|
+
</span><span id="__span-25-4"><a id="__codelineno-25-4" name="__codelineno-25-4" href="#__codelineno-25-4"></a><span class="k">end</span>
|
|
3500
|
+
</span></code></pre></div>
|
|
3501
|
+
<h2 id="error-handling">Error Handling<a class="headerlink" href="#error-handling" title="Permanent link">¶</a></h2>
|
|
3502
|
+
<h3 id="automatic-error-handling">Automatic Error Handling<a class="headerlink" href="#automatic-error-handling" title="Permanent link">¶</a></h3>
|
|
3503
|
+
<p><code>RobotLab::Tool</code> automatically catches <code>StandardError</code> exceptions from <code>execute</code> and returns a plain-text error string to the LLM. The LLM can then reason about the failure and try an alternative approach — without crashing the run.</p>
|
|
3504
|
+
<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="k">class</span><span class="w"> </span><span class="nc">FetchResource</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>
|
|
3505
|
+
</span><span id="__span-26-2"><a id="__codelineno-26-2" name="__codelineno-26-2" href="#__codelineno-26-2"></a><span class="w"> </span><span class="n">description</span><span class="w"> </span><span class="s2">"Fetch a resource from an external API"</span>
|
|
3506
|
+
</span><span id="__span-26-3"><a id="__codelineno-26-3" name="__codelineno-26-3" href="#__codelineno-26-3"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:id</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="ss">:string</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">"Resource ID"</span>
|
|
3507
|
+
</span><span id="__span-26-4"><a id="__codelineno-26-4" name="__codelineno-26-4" href="#__codelineno-26-4"></a>
|
|
3508
|
+
</span><span id="__span-26-5"><a id="__codelineno-26-5" name="__codelineno-26-5" href="#__codelineno-26-5"></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">id</span><span class="p">:)</span>
|
|
3509
|
+
</span><span id="__span-26-6"><a id="__codelineno-26-6" name="__codelineno-26-6" href="#__codelineno-26-6"></a><span class="w"> </span><span class="no">ExternalAPI</span><span class="o">.</span><span class="n">fetch</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span>
|
|
3510
|
+
</span><span id="__span-26-7"><a id="__codelineno-26-7" name="__codelineno-26-7" href="#__codelineno-26-7"></a><span class="w"> </span><span class="k">end</span>
|
|
3511
|
+
</span><span id="__span-26-8"><a id="__codelineno-26-8" name="__codelineno-26-8" href="#__codelineno-26-8"></a><span class="k">end</span>
|
|
3512
|
+
</span><span id="__span-26-9"><a id="__codelineno-26-9" name="__codelineno-26-9" href="#__codelineno-26-9"></a>
|
|
3513
|
+
</span><span id="__span-26-10"><a id="__codelineno-26-10" name="__codelineno-26-10" href="#__codelineno-26-10"></a><span class="n">tool</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">FetchResource</span><span class="o">.</span><span class="n">new</span>
|
|
3514
|
+
</span><span id="__span-26-11"><a id="__codelineno-26-11" name="__codelineno-26-11" href="#__codelineno-26-11"></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="w"> </span><span class="s2">"id"</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="s2">"missing"</span><span class="w"> </span><span class="p">})</span>
|
|
3515
|
+
</span><span id="__span-26-12"><a id="__codelineno-26-12" name="__codelineno-26-12" href="#__codelineno-26-12"></a><span class="c1"># If ExternalAPI.fetch raises, result is:</span>
|
|
3516
|
+
</span><span id="__span-26-13"><a id="__codelineno-26-13" name="__codelineno-26-13" href="#__codelineno-26-13"></a><span class="c1"># => "Error (fetch_resource): connection refused"</span>
|
|
3517
|
+
</span></code></pre></div>
|
|
3518
|
+
<p>This applies to all <code>RobotLab::Tool</code> variants — subclasses, <code>Tool.create</code> factory tools, and MCP tools. Errors are also logged via <code>RobotLab.config.logger</code> at <code>:warn</code> level.</p>
|
|
3519
|
+
<h3 id="critical-tools-opt-out">Critical Tools (Opt-Out)<a class="headerlink" href="#critical-tools-opt-out" title="Permanent link">¶</a></h3>
|
|
3520
|
+
<p>For tools where you want exceptions to propagate (e.g., a tool whose failure should abort the run), set <code>raise_on_error</code> on the class:</p>
|
|
3521
|
+
<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="k">class</span><span class="w"> </span><span class="nc">CriticalPayment</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>
|
|
3522
|
+
</span><span id="__span-27-2"><a id="__codelineno-27-2" name="__codelineno-27-2" href="#__codelineno-27-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>
|
|
3523
|
+
</span><span id="__span-27-3"><a id="__codelineno-27-3" name="__codelineno-27-3" href="#__codelineno-27-3"></a>
|
|
3524
|
+
</span><span id="__span-27-4"><a id="__codelineno-27-4" name="__codelineno-27-4" href="#__codelineno-27-4"></a><span class="w"> </span><span class="n">description</span><span class="w"> </span><span class="s2">"Process a payment"</span>
|
|
3525
|
+
</span><span id="__span-27-5"><a id="__codelineno-27-5" name="__codelineno-27-5" href="#__codelineno-27-5"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:amount</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="ss">:number</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">"Payment amount"</span>
|
|
3526
|
+
</span><span id="__span-27-6"><a id="__codelineno-27-6" name="__codelineno-27-6" href="#__codelineno-27-6"></a>
|
|
3527
|
+
</span><span id="__span-27-7"><a id="__codelineno-27-7" name="__codelineno-27-7" href="#__codelineno-27-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">amount</span><span class="p">:)</span>
|
|
3528
|
+
</span><span id="__span-27-8"><a id="__codelineno-27-8" name="__codelineno-27-8" href="#__codelineno-27-8"></a><span class="w"> </span><span class="no">PaymentGateway</span><span class="o">.</span><span class="n">charge</span><span class="p">(</span><span class="n">amount</span><span class="p">)</span>
|
|
3529
|
+
</span><span id="__span-27-9"><a id="__codelineno-27-9" name="__codelineno-27-9" href="#__codelineno-27-9"></a><span class="w"> </span><span class="k">end</span>
|
|
3530
|
+
</span><span id="__span-27-10"><a id="__codelineno-27-10" name="__codelineno-27-10" href="#__codelineno-27-10"></a><span class="k">end</span>
|
|
3531
|
+
</span></code></pre></div>
|
|
3532
|
+
<p><code>raise_on_error</code> is per-class and defaults to <code>false</code>. Setting it on one class does not affect others.</p>
|
|
3533
|
+
<h3 id="manual-error-handling">Manual Error Handling<a class="headerlink" href="#manual-error-handling" title="Permanent link">¶</a></h3>
|
|
3534
|
+
<p>You can still handle specific errors inside <code>execute</code> for domain-specific responses:</p>
|
|
3535
|
+
<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">FetchResource</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>
|
|
3536
|
+
</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">"Fetch a resource from an external API"</span>
|
|
3537
|
+
</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">:id</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="ss">:string</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">"Resource ID"</span>
|
|
3538
|
+
</span><span id="__span-28-4"><a id="__codelineno-28-4" name="__codelineno-28-4" href="#__codelineno-28-4"></a>
|
|
3539
|
+
</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="k">def</span><span class="w"> </span><span class="nf">execute</span><span class="p">(</span><span class="nb">id</span><span class="p">:)</span>
|
|
3540
|
+
</span><span id="__span-28-6"><a id="__codelineno-28-6" name="__codelineno-28-6" href="#__codelineno-28-6"></a><span class="w"> </span><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">ExternalAPI</span><span class="o">.</span><span class="n">fetch</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span>
|
|
3541
|
+
</span><span id="__span-28-7"><a id="__codelineno-28-7" name="__codelineno-28-7" href="#__codelineno-28-7"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">success</span><span class="p">:</span><span class="w"> </span><span class="kp">true</span><span class="p">,</span><span class="w"> </span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="n">result</span><span class="w"> </span><span class="p">}</span>
|
|
3542
|
+
</span><span id="__span-28-8"><a id="__codelineno-28-8" name="__codelineno-28-8" href="#__codelineno-28-8"></a><span class="w"> </span><span class="k">rescue</span><span class="w"> </span><span class="no">ExternalAPI</span><span class="o">::</span><span class="no">NotFound</span>
|
|
3543
|
+
</span><span id="__span-28-9"><a id="__codelineno-28-9" name="__codelineno-28-9" href="#__codelineno-28-9"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">success</span><span class="p">:</span><span class="w"> </span><span class="kp">false</span><span class="p">,</span><span class="w"> </span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s2">"Resource not found"</span><span class="p">,</span><span class="w"> </span><span class="nb">id</span><span class="p">:</span><span class="w"> </span><span class="nb">id</span><span class="w"> </span><span class="p">}</span>
|
|
3544
|
+
</span><span id="__span-28-10"><a id="__codelineno-28-10" name="__codelineno-28-10" href="#__codelineno-28-10"></a><span class="w"> </span><span class="k">rescue</span><span class="w"> </span><span class="no">ExternalAPI</span><span class="o">::</span><span class="no">RateLimited</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="n">e</span>
|
|
3545
|
+
</span><span id="__span-28-11"><a id="__codelineno-28-11" name="__codelineno-28-11" href="#__codelineno-28-11"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">success</span><span class="p">:</span><span class="w"> </span><span class="kp">false</span><span class="p">,</span><span class="w"> </span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s2">"Rate limited"</span><span class="p">,</span><span class="w"> </span><span class="ss">retry_after</span><span class="p">:</span><span class="w"> </span><span class="n">e</span><span class="o">.</span><span class="n">retry_after</span><span class="w"> </span><span class="p">}</span>
|
|
3546
|
+
</span><span id="__span-28-12"><a id="__codelineno-28-12" name="__codelineno-28-12" href="#__codelineno-28-12"></a><span class="w"> </span><span class="k">end</span>
|
|
3547
|
+
</span><span id="__span-28-13"><a id="__codelineno-28-13" name="__codelineno-28-13" href="#__codelineno-28-13"></a><span class="w"> </span><span class="c1"># Any other StandardError is still caught by the automatic handler</span>
|
|
3548
|
+
</span><span id="__span-28-14"><a id="__codelineno-28-14" name="__codelineno-28-14" href="#__codelineno-28-14"></a><span class="k">end</span>
|
|
3549
|
+
</span></code></pre></div>
|
|
3550
|
+
<h2 id="tool-callbacks">Tool Callbacks<a class="headerlink" href="#tool-callbacks" title="Permanent link">¶</a></h2>
|
|
3551
|
+
<p>Robots support <code>on_tool_call</code> and <code>on_tool_result</code> callbacks for monitoring tool usage:</p>
|
|
3552
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-29-1"><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-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>
|
|
3553
|
+
</span><span id="__span-29-2"><a id="__codelineno-29-2" name="__codelineno-29-2" href="#__codelineno-29-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"assistant"</span><span class="p">,</span>
|
|
3554
|
+
</span><span id="__span-29-3"><a id="__codelineno-29-3" name="__codelineno-29-3" href="#__codelineno-29-3"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">,</span>
|
|
3555
|
+
</span><span id="__span-29-4"><a id="__codelineno-29-4" name="__codelineno-29-4" href="#__codelineno-29-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">GetWeather</span><span class="o">]</span><span class="p">,</span>
|
|
3556
|
+
</span><span id="__span-29-5"><a id="__codelineno-29-5" name="__codelineno-29-5" href="#__codelineno-29-5"></a><span class="w"> </span><span class="ss">on_tool_call</span><span class="p">:</span><span class="w"> </span><span class="o">-></span><span class="p">(</span><span class="n">call</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">"Calling: </span><span class="si">#{</span><span class="n">call</span><span class="si">}</span><span class="s2">"</span><span class="w"> </span><span class="p">},</span>
|
|
3557
|
+
</span><span id="__span-29-6"><a id="__codelineno-29-6" name="__codelineno-29-6" href="#__codelineno-29-6"></a><span class="w"> </span><span class="ss">on_tool_result</span><span class="p">:</span><span class="w"> </span><span class="o">-></span><span class="p">(</span><span class="n">result</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">"Result: </span><span class="si">#{</span><span class="n">result</span><span class="si">}</span><span class="s2">"</span><span class="w"> </span><span class="p">}</span>
|
|
3558
|
+
</span><span id="__span-29-7"><a id="__codelineno-29-7" name="__codelineno-29-7" href="#__codelineno-29-7"></a><span class="p">)</span>
|
|
3559
|
+
</span></code></pre></div>
|
|
3560
|
+
<h2 id="robotlabtoolcreate-with-schema">RobotLab::Tool.create with Schema<a class="headerlink" href="#robotlabtoolcreate-with-schema" title="Permanent link">¶</a></h2>
|
|
3561
|
+
<p>For dynamic tools via <code>Tool.create</code>, pass parameters as a JSON Schema hash:</p>
|
|
3562
|
+
<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">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>
|
|
3563
|
+
</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">"search"</span><span class="p">,</span>
|
|
3564
|
+
</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">description</span><span class="p">:</span><span class="w"> </span><span class="s2">"Search for items"</span><span class="p">,</span>
|
|
3565
|
+
</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">parameters</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
3566
|
+
</span><span id="__span-30-5"><a id="__codelineno-30-5" name="__codelineno-30-5" href="#__codelineno-30-5"></a><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</span><span class="p">,</span>
|
|
3567
|
+
</span><span id="__span-30-6"><a id="__codelineno-30-6" name="__codelineno-30-6" href="#__codelineno-30-6"></a><span class="w"> </span><span class="ss">properties</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
3568
|
+
</span><span id="__span-30-7"><a id="__codelineno-30-7" name="__codelineno-30-7" href="#__codelineno-30-7"></a><span class="w"> </span><span class="ss">query</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">"string"</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">"Search query"</span><span class="w"> </span><span class="p">},</span>
|
|
3569
|
+
</span><span id="__span-30-8"><a id="__codelineno-30-8" name="__codelineno-30-8" href="#__codelineno-30-8"></a><span class="w"> </span><span class="ss">limit</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">"integer"</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">"Max results"</span><span class="w"> </span><span class="p">}</span>
|
|
3570
|
+
</span><span id="__span-30-9"><a id="__codelineno-30-9" name="__codelineno-30-9" href="#__codelineno-30-9"></a><span class="w"> </span><span class="p">},</span>
|
|
3571
|
+
</span><span id="__span-30-10"><a id="__codelineno-30-10" name="__codelineno-30-10" href="#__codelineno-30-10"></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">"query"</span><span class="o">]</span>
|
|
3572
|
+
</span><span id="__span-30-11"><a id="__codelineno-30-11" name="__codelineno-30-11" href="#__codelineno-30-11"></a><span class="w"> </span><span class="p">}</span>
|
|
3573
|
+
</span><span id="__span-30-12"><a id="__codelineno-30-12" name="__codelineno-30-12" href="#__codelineno-30-12"></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">Search</span><span class="o">.</span><span class="n">query</span><span class="p">(</span><span class="n">args</span><span class="o">[</span><span class="ss">:query</span><span class="o">]</span><span class="p">,</span><span class="w"> </span><span class="ss">limit</span><span class="p">:</span><span class="w"> </span><span class="n">args</span><span class="o">[</span><span class="ss">:limit</span><span class="o">]</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="mi">10</span><span class="p">)</span><span class="w"> </span><span class="p">}</span>
|
|
3574
|
+
</span></code></pre></div>
|
|
3575
|
+
<h2 id="best-practices">Best Practices<a class="headerlink" href="#best-practices" title="Permanent link">¶</a></h2>
|
|
3576
|
+
<h3 id="1-clear-descriptions">1. Clear Descriptions<a class="headerlink" href="#1-clear-descriptions" title="Permanent link">¶</a></h3>
|
|
3577
|
+
<p>Write descriptions that help the LLM understand when and how to use the tool:</p>
|
|
3578
|
+
<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="c1"># Good: Specific and actionable</span>
|
|
3579
|
+
</span><span id="__span-31-2"><a id="__codelineno-31-2" name="__codelineno-31-2" href="#__codelineno-31-2"></a><span class="k">class</span><span class="w"> </span><span class="nc">SearchOrders</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">RubyLLM</span><span class="o">::</span><span class="no">Tool</span>
|
|
3580
|
+
</span><span id="__span-31-3"><a id="__codelineno-31-3" name="__codelineno-31-3" href="#__codelineno-31-3"></a><span class="w"> </span><span class="n">description</span><span class="w"> </span><span class="s2">"Search customer orders by date range, status, or customer email. Returns up to 50 matching orders sorted by date."</span>
|
|
3581
|
+
</span><span id="__span-31-4"><a id="__codelineno-31-4" name="__codelineno-31-4" href="#__codelineno-31-4"></a><span class="w"> </span><span class="c1"># ...</span>
|
|
3582
|
+
</span><span id="__span-31-5"><a id="__codelineno-31-5" name="__codelineno-31-5" href="#__codelineno-31-5"></a><span class="k">end</span>
|
|
3583
|
+
</span><span id="__span-31-6"><a id="__codelineno-31-6" name="__codelineno-31-6" href="#__codelineno-31-6"></a>
|
|
3584
|
+
</span><span id="__span-31-7"><a id="__codelineno-31-7" name="__codelineno-31-7" href="#__codelineno-31-7"></a><span class="c1"># Bad: Vague</span>
|
|
3585
|
+
</span><span id="__span-31-8"><a id="__codelineno-31-8" name="__codelineno-31-8" href="#__codelineno-31-8"></a><span class="k">class</span><span class="w"> </span><span class="nc">Search</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">RubyLLM</span><span class="o">::</span><span class="no">Tool</span>
|
|
3586
|
+
</span><span id="__span-31-9"><a id="__codelineno-31-9" name="__codelineno-31-9" href="#__codelineno-31-9"></a><span class="w"> </span><span class="n">description</span><span class="w"> </span><span class="s2">"Searches stuff"</span>
|
|
3587
|
+
</span><span id="__span-31-10"><a id="__codelineno-31-10" name="__codelineno-31-10" href="#__codelineno-31-10"></a><span class="w"> </span><span class="c1"># ...</span>
|
|
3588
|
+
</span><span id="__span-31-11"><a id="__codelineno-31-11" name="__codelineno-31-11" href="#__codelineno-31-11"></a><span class="k">end</span>
|
|
3589
|
+
</span></code></pre></div>
|
|
3590
|
+
<h3 id="2-validate-inputs">2. Validate Inputs<a class="headerlink" href="#2-validate-inputs" title="Permanent link">¶</a></h3>
|
|
3591
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-32-1"><a id="__codelineno-32-1" name="__codelineno-32-1" href="#__codelineno-32-1"></a><span class="k">def</span><span class="w"> </span><span class="nf">execute</span><span class="p">(</span><span class="ss">email</span><span class="p">:)</span>
|
|
3592
|
+
</span><span id="__span-32-2"><a id="__codelineno-32-2" name="__codelineno-32-2" href="#__codelineno-32-2"></a><span class="w"> </span><span class="k">unless</span><span class="w"> </span><span class="n">email</span><span class="o">.</span><span class="n">match?</span><span class="p">(</span><span class="sr">/\A[\w+\-.]+@[a-z\d\-]+(\.[a-z\d\-]+)*\.[a-z]+\z/i</span><span class="p">)</span>
|
|
3593
|
+
</span><span id="__span-32-3"><a id="__codelineno-32-3" name="__codelineno-32-3" href="#__codelineno-32-3"></a><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">error</span><span class="p">:</span><span class="w"> </span><span class="s2">"Invalid email format"</span><span class="w"> </span><span class="p">}</span>
|
|
3594
|
+
</span><span id="__span-32-4"><a id="__codelineno-32-4" name="__codelineno-32-4" href="#__codelineno-32-4"></a><span class="w"> </span><span class="k">end</span>
|
|
3595
|
+
</span><span id="__span-32-5"><a id="__codelineno-32-5" name="__codelineno-32-5" href="#__codelineno-32-5"></a><span class="w"> </span><span class="c1"># ... rest of logic</span>
|
|
3596
|
+
</span><span id="__span-32-6"><a id="__codelineno-32-6" name="__codelineno-32-6" href="#__codelineno-32-6"></a><span class="k">end</span>
|
|
3597
|
+
</span></code></pre></div>
|
|
3598
|
+
<h3 id="3-return-structured-data">3. Return Structured Data<a class="headerlink" href="#3-return-structured-data" title="Permanent link">¶</a></h3>
|
|
3599
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-33-1"><a id="__codelineno-33-1" name="__codelineno-33-1" href="#__codelineno-33-1"></a><span class="c1"># Good: Structured and consistent</span>
|
|
3600
|
+
</span><span id="__span-33-2"><a id="__codelineno-33-2" name="__codelineno-33-2" href="#__codelineno-33-2"></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="n">_</span><span class="p">)</span>
|
|
3601
|
+
</span><span id="__span-33-3"><a id="__codelineno-33-3" name="__codelineno-33-3" href="#__codelineno-33-3"></a><span class="w"> </span><span class="p">{</span>
|
|
3602
|
+
</span><span id="__span-33-4"><a id="__codelineno-33-4" name="__codelineno-33-4" href="#__codelineno-33-4"></a><span class="w"> </span><span class="ss">success</span><span class="p">:</span><span class="w"> </span><span class="kp">true</span><span class="p">,</span>
|
|
3603
|
+
</span><span id="__span-33-5"><a id="__codelineno-33-5" name="__codelineno-33-5" href="#__codelineno-33-5"></a><span class="w"> </span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">id</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"Item"</span><span class="w"> </span><span class="p">},</span>
|
|
3604
|
+
</span><span id="__span-33-6"><a id="__codelineno-33-6" name="__codelineno-33-6" href="#__codelineno-33-6"></a><span class="w"> </span><span class="ss">metadata</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">fetched_at</span><span class="p">:</span><span class="w"> </span><span class="no">Time</span><span class="o">.</span><span class="n">now</span><span class="o">.</span><span class="n">iso8601</span><span class="w"> </span><span class="p">}</span>
|
|
3605
|
+
</span><span id="__span-33-7"><a id="__codelineno-33-7" name="__codelineno-33-7" href="#__codelineno-33-7"></a><span class="w"> </span><span class="p">}</span>
|
|
3606
|
+
</span><span id="__span-33-8"><a id="__codelineno-33-8" name="__codelineno-33-8" href="#__codelineno-33-8"></a><span class="k">end</span>
|
|
3607
|
+
</span><span id="__span-33-9"><a id="__codelineno-33-9" name="__codelineno-33-9" href="#__codelineno-33-9"></a>
|
|
3608
|
+
</span><span id="__span-33-10"><a id="__codelineno-33-10" name="__codelineno-33-10" href="#__codelineno-33-10"></a><span class="c1"># Bad: Unstructured</span>
|
|
3609
|
+
</span><span id="__span-33-11"><a id="__codelineno-33-11" name="__codelineno-33-11" href="#__codelineno-33-11"></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="n">_</span><span class="p">)</span>
|
|
3610
|
+
</span><span id="__span-33-12"><a id="__codelineno-33-12" name="__codelineno-33-12" href="#__codelineno-33-12"></a><span class="w"> </span><span class="s2">"Found item with id 1 named Item"</span>
|
|
3611
|
+
</span><span id="__span-33-13"><a id="__codelineno-33-13" name="__codelineno-33-13" href="#__codelineno-33-13"></a><span class="k">end</span>
|
|
3612
|
+
</span></code></pre></div>
|
|
3613
|
+
<h3 id="4-keep-tools-focused">4. Keep Tools Focused<a class="headerlink" href="#4-keep-tools-focused" title="Permanent link">¶</a></h3>
|
|
3614
|
+
<p>Each tool should do one thing well. Prefer multiple focused tools over one tool that does everything.</p>
|
|
3615
|
+
<h2 id="next-steps">Next Steps<a class="headerlink" href="#next-steps" title="Permanent link">¶</a></h2>
|
|
3616
|
+
<ul>
|
|
3617
|
+
<li><a href="../mcp-integration/">MCP Integration</a> - External tool servers</li>
|
|
3618
|
+
<li><a href="../building-robots/">Building Robots</a> - Robot creation patterns</li>
|
|
3619
|
+
<li><a href="../../api/core/tool/">API Reference: Tool</a> - Complete API</li>
|
|
3620
|
+
</ul>
|
|
3621
|
+
|
|
3622
|
+
|
|
3623
|
+
|
|
3624
|
+
|
|
3625
|
+
|
|
3626
|
+
|
|
3627
|
+
|
|
3628
|
+
|
|
3629
|
+
|
|
3630
|
+
|
|
3631
|
+
|
|
3632
|
+
|
|
3633
|
+
|
|
3634
|
+
<form class="md-feedback" name="feedback" hidden>
|
|
3635
|
+
<fieldset>
|
|
3636
|
+
<legend class="md-feedback__title">
|
|
3637
|
+
Was this page helpful?
|
|
3638
|
+
</legend>
|
|
3639
|
+
<div class="md-feedback__inner">
|
|
3640
|
+
<div class="md-feedback__list">
|
|
3641
|
+
|
|
3642
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
|
|
3643
|
+
<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>
|
|
3644
|
+
</button>
|
|
3645
|
+
|
|
3646
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
|
|
3647
|
+
<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>
|
|
3648
|
+
</button>
|
|
3649
|
+
|
|
3650
|
+
</div>
|
|
3651
|
+
<div class="md-feedback__note">
|
|
3652
|
+
|
|
3653
|
+
<div data-md-value="1" hidden>
|
|
3654
|
+
|
|
3655
|
+
|
|
3656
|
+
|
|
3657
|
+
|
|
3658
|
+
|
|
3659
|
+
|
|
3660
|
+
|
|
3661
|
+
|
|
3662
|
+
|
|
3663
|
+
Thanks for your feedback!
|
|
3664
|
+
</div>
|
|
3665
|
+
|
|
3666
|
+
<div data-md-value="0" hidden>
|
|
3667
|
+
|
|
3668
|
+
|
|
3669
|
+
|
|
3670
|
+
|
|
3671
|
+
|
|
3672
|
+
|
|
3673
|
+
|
|
3674
|
+
|
|
3675
|
+
|
|
3676
|
+
Thanks for your feedback! Help us improve by creating an issue.
|
|
3677
|
+
</div>
|
|
3678
|
+
|
|
3679
|
+
</div>
|
|
3680
|
+
</div>
|
|
3681
|
+
</fieldset>
|
|
3682
|
+
</form>
|
|
3683
|
+
|
|
3684
|
+
|
|
3685
|
+
|
|
3686
|
+
</article>
|
|
3687
|
+
</div>
|
|
3688
|
+
|
|
3689
|
+
|
|
3690
|
+
<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>
|
|
3691
|
+
|
|
3692
|
+
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
3693
|
+
</div>
|
|
3694
|
+
|
|
3695
|
+
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
|
3696
|
+
|
|
3697
|
+
<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>
|
|
3698
|
+
Back to top
|
|
3699
|
+
</button>
|
|
3700
|
+
|
|
3701
|
+
</main>
|
|
3702
|
+
|
|
3703
|
+
<footer class="md-footer">
|
|
3704
|
+
|
|
3705
|
+
|
|
3706
|
+
|
|
3707
|
+
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
|
3708
|
+
|
|
3709
|
+
|
|
3710
|
+
<a href="../creating-networks/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Creating Networks">
|
|
3711
|
+
<div class="md-footer__button md-icon">
|
|
3712
|
+
|
|
3713
|
+
<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>
|
|
3714
|
+
</div>
|
|
3715
|
+
<div class="md-footer__title">
|
|
3716
|
+
<span class="md-footer__direction">
|
|
3717
|
+
Previous
|
|
3718
|
+
</span>
|
|
3719
|
+
<div class="md-ellipsis">
|
|
3720
|
+
Creating Networks
|
|
3721
|
+
</div>
|
|
3722
|
+
</div>
|
|
3723
|
+
</a>
|
|
3724
|
+
|
|
3725
|
+
|
|
3726
|
+
|
|
3727
|
+
<a href="../mcp-integration/" class="md-footer__link md-footer__link--next" aria-label="Next: MCP Integration">
|
|
3728
|
+
<div class="md-footer__title">
|
|
3729
|
+
<span class="md-footer__direction">
|
|
3730
|
+
Next
|
|
3731
|
+
</span>
|
|
3732
|
+
<div class="md-ellipsis">
|
|
3733
|
+
MCP Integration
|
|
3734
|
+
</div>
|
|
3735
|
+
</div>
|
|
3736
|
+
<div class="md-footer__button md-icon">
|
|
3737
|
+
|
|
3738
|
+
<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>
|
|
3739
|
+
</div>
|
|
3740
|
+
</a>
|
|
3741
|
+
|
|
3742
|
+
</nav>
|
|
3743
|
+
|
|
3744
|
+
|
|
3745
|
+
<div class="md-footer-meta md-typeset">
|
|
3746
|
+
<div class="md-footer-meta__inner md-grid">
|
|
3747
|
+
<div class="md-copyright">
|
|
3748
|
+
|
|
3749
|
+
<div class="md-copyright__highlight">
|
|
3750
|
+
Copyright © 2025 Dewayne VanHoozer
|
|
3751
|
+
</div>
|
|
3752
|
+
|
|
3753
|
+
|
|
3754
|
+
Made with
|
|
3755
|
+
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
3756
|
+
Material for MkDocs
|
|
3757
|
+
</a>
|
|
3758
|
+
|
|
3759
|
+
</div>
|
|
3760
|
+
|
|
3761
|
+
|
|
3762
|
+
<div class="md-social">
|
|
3763
|
+
|
|
3764
|
+
|
|
3765
|
+
|
|
3766
|
+
|
|
3767
|
+
|
|
3768
|
+
<a href="https://github.com/madbomber/robot_lab" target="_blank" rel="noopener" title="RobotLab on GitHub" class="md-social__link">
|
|
3769
|
+
<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>
|
|
3770
|
+
</a>
|
|
3771
|
+
|
|
3772
|
+
|
|
3773
|
+
|
|
3774
|
+
|
|
3775
|
+
|
|
3776
|
+
<a href="https://rubygems.org/gems/robot_lab" target="_blank" rel="noopener" title="RobotLab on RubyGems" class="md-social__link">
|
|
3777
|
+
<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>
|
|
3778
|
+
</a>
|
|
3779
|
+
|
|
3780
|
+
</div>
|
|
3781
|
+
|
|
3782
|
+
</div>
|
|
3783
|
+
</div>
|
|
3784
|
+
</footer>
|
|
3785
|
+
|
|
3786
|
+
</div>
|
|
3787
|
+
<div class="md-dialog" data-md-component="dialog">
|
|
3788
|
+
<div class="md-dialog__inner md-typeset"></div>
|
|
3789
|
+
</div>
|
|
3790
|
+
|
|
3791
|
+
|
|
3792
|
+
|
|
3793
|
+
|
|
3794
|
+
|
|
3795
|
+
<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>
|
|
3796
|
+
|
|
3797
|
+
|
|
3798
|
+
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
|
|
3799
|
+
|
|
3800
|
+
|
|
3801
|
+
</body>
|
|
3802
|
+
</html>
|