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,3435 @@
|
|
|
1
|
+
|
|
2
|
+
<!doctype html>
|
|
3
|
+
<html lang="en" class="no-js">
|
|
4
|
+
<head>
|
|
5
|
+
|
|
6
|
+
<meta charset="utf-8">
|
|
7
|
+
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
8
|
+
|
|
9
|
+
<meta name="description" content="Multi-robot LLM workflow orchestration for Ruby">
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<meta name="author" content="Dewayne VanHoozer">
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
<link rel="canonical" href="https://madbomber.github.io/robot_lab/api/mcp/client/">
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<link rel="prev" href="../">
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<link rel="next" href="../server/">
|
|
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>Client - RobotLab</title>
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
<link rel="stylesheet" href="../../../assets/stylesheets/main.484c7ddc.min.css">
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
<link rel="stylesheet" href="../../../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
53
|
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
|
54
|
+
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<link rel="stylesheet" href="../../../assets/css/custom.css">
|
|
59
|
+
|
|
60
|
+
<script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</head>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="amber">
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
82
|
+
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
83
|
+
<label class="md-overlay" for="__drawer"></label>
|
|
84
|
+
<div data-md-component="skip">
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
<a href="#mcp-client" 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
|
+
Client
|
|
124
|
+
|
|
125
|
+
</span>
|
|
126
|
+
</div>
|
|
127
|
+
</div>
|
|
128
|
+
</div>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<form class="md-header__option" data-md-component="palette">
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="amber" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
|
137
|
+
|
|
138
|
+
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
|
139
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
|
|
140
|
+
</label>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="amber" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
|
147
|
+
|
|
148
|
+
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
|
149
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
|
|
150
|
+
</label>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
</form>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<label class="md-header__button md-icon" for="__search">
|
|
164
|
+
|
|
165
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
166
|
+
</label>
|
|
167
|
+
<div class="md-search" data-md-component="search" role="dialog">
|
|
168
|
+
<label class="md-search__overlay" for="__search"></label>
|
|
169
|
+
<div class="md-search__inner" role="search">
|
|
170
|
+
<form class="md-search__form" name="search">
|
|
171
|
+
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
172
|
+
<label class="md-search__icon md-icon" for="__search">
|
|
173
|
+
|
|
174
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
175
|
+
|
|
176
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
|
177
|
+
</label>
|
|
178
|
+
<nav class="md-search__options" aria-label="Search">
|
|
179
|
+
|
|
180
|
+
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
|
|
181
|
+
|
|
182
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
|
|
183
|
+
</a>
|
|
184
|
+
|
|
185
|
+
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
|
186
|
+
|
|
187
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
|
188
|
+
</button>
|
|
189
|
+
</nav>
|
|
190
|
+
|
|
191
|
+
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
|
192
|
+
|
|
193
|
+
</form>
|
|
194
|
+
<div class="md-search__output">
|
|
195
|
+
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
|
196
|
+
<div class="md-search-result" data-md-component="search-result">
|
|
197
|
+
<div class="md-search-result__meta">
|
|
198
|
+
Initializing search
|
|
199
|
+
</div>
|
|
200
|
+
<ol class="md-search-result__list" role="presentation"></ol>
|
|
201
|
+
</div>
|
|
202
|
+
</div>
|
|
203
|
+
</div>
|
|
204
|
+
</div>
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<div class="md-header__source">
|
|
210
|
+
<a href="https://github.com/madbomber/robot_lab" title="Go to repository" class="md-source" data-md-component="source">
|
|
211
|
+
<div class="md-source__icon md-icon">
|
|
212
|
+
|
|
213
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
|
214
|
+
</div>
|
|
215
|
+
<div class="md-source__repository">
|
|
216
|
+
madbomber/robot_lab
|
|
217
|
+
</div>
|
|
218
|
+
</a>
|
|
219
|
+
</div>
|
|
220
|
+
|
|
221
|
+
</nav>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
|
|
226
|
+
<div class="md-grid">
|
|
227
|
+
<ul class="md-tabs__list">
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<li class="md-tabs__item">
|
|
237
|
+
<a href="../../.." class="md-tabs__link">
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
Home
|
|
244
|
+
|
|
245
|
+
</a>
|
|
246
|
+
</li>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
<li class="md-tabs__item">
|
|
259
|
+
<a href="../../../getting-started/" class="md-tabs__link">
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
Getting Started
|
|
266
|
+
|
|
267
|
+
</a>
|
|
268
|
+
</li>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<li class="md-tabs__item">
|
|
281
|
+
<a href="../../../architecture/" class="md-tabs__link">
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
Architecture
|
|
288
|
+
|
|
289
|
+
</a>
|
|
290
|
+
</li>
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<li class="md-tabs__item">
|
|
303
|
+
<a href="../../../guides/" class="md-tabs__link">
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
Guides
|
|
310
|
+
|
|
311
|
+
</a>
|
|
312
|
+
</li>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<li class="md-tabs__item md-tabs__item--active">
|
|
327
|
+
<a href="../../" class="md-tabs__link">
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
API Reference
|
|
334
|
+
|
|
335
|
+
</a>
|
|
336
|
+
</li>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<li class="md-tabs__item">
|
|
349
|
+
<a href="../../../examples/" class="md-tabs__link">
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
Examples
|
|
356
|
+
|
|
357
|
+
</a>
|
|
358
|
+
</li>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</ul>
|
|
364
|
+
</div>
|
|
365
|
+
</nav>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</header>
|
|
369
|
+
|
|
370
|
+
<div class="md-container" data-md-component="container">
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<main class="md-main" data-md-component="main">
|
|
376
|
+
<div class="md-main__inner md-grid">
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
381
|
+
<div class="md-sidebar__scrollwrap">
|
|
382
|
+
<div class="md-sidebar__inner">
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
|
|
390
|
+
<label class="md-nav__title" for="__drawer">
|
|
391
|
+
<a href="../../.." title="RobotLab" class="md-nav__button md-logo" aria-label="RobotLab" data-md-component="logo">
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a2 2 0 0 1 2 2c0 .74-.4 1.39-1 1.73V7h1a7 7 0 0 1 7 7h1a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1h-1v1a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-1H2a1 1 0 0 1-1-1v-3a1 1 0 0 1 1-1h1a7 7 0 0 1 7-7h1V5.73c-.6-.34-1-.99-1-1.73a2 2 0 0 1 2-2M7.5 13A2.5 2.5 0 0 0 5 15.5 2.5 2.5 0 0 0 7.5 18a2.5 2.5 0 0 0 2.5-2.5A2.5 2.5 0 0 0 7.5 13m9 0a2.5 2.5 0 0 0-2.5 2.5 2.5 2.5 0 0 0 2.5 2.5 2.5 2.5 0 0 0 2.5-2.5 2.5 2.5 0 0 0-2.5-2.5"/></svg>
|
|
395
|
+
|
|
396
|
+
</a>
|
|
397
|
+
RobotLab
|
|
398
|
+
</label>
|
|
399
|
+
|
|
400
|
+
<div class="md-nav__source">
|
|
401
|
+
<a href="https://github.com/madbomber/robot_lab" title="Go to repository" class="md-source" data-md-component="source">
|
|
402
|
+
<div class="md-source__icon md-icon">
|
|
403
|
+
|
|
404
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
|
405
|
+
</div>
|
|
406
|
+
<div class="md-source__repository">
|
|
407
|
+
madbomber/robot_lab
|
|
408
|
+
</div>
|
|
409
|
+
</a>
|
|
410
|
+
</div>
|
|
411
|
+
|
|
412
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
<div class="md-nav__link md-nav__container">
|
|
444
|
+
<a href="../../.." class="md-nav__link ">
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<span class="md-ellipsis">
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
Home
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
</span>
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
</a>
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
<label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
|
|
463
|
+
<span class="md-nav__icon md-icon"></span>
|
|
464
|
+
</label>
|
|
465
|
+
|
|
466
|
+
</div>
|
|
467
|
+
|
|
468
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
|
|
469
|
+
<label class="md-nav__title" for="__nav_1">
|
|
470
|
+
<span class="md-nav__icon md-icon"></span>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
Home
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
</label>
|
|
477
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
<li class="md-nav__item">
|
|
488
|
+
<a href="../../../concepts/" class="md-nav__link">
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
<span class="md-ellipsis">
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
Concepts
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
</span>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
</a>
|
|
504
|
+
</li>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
</ul>
|
|
510
|
+
</nav>
|
|
511
|
+
|
|
512
|
+
</li>
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
<div class="md-nav__link md-nav__container">
|
|
550
|
+
<a href="../../../getting-started/" class="md-nav__link ">
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
<span class="md-ellipsis">
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
Getting Started
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
</span>
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
</a>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="0">
|
|
569
|
+
<span class="md-nav__icon md-icon"></span>
|
|
570
|
+
</label>
|
|
571
|
+
|
|
572
|
+
</div>
|
|
573
|
+
|
|
574
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
|
575
|
+
<label class="md-nav__title" for="__nav_2">
|
|
576
|
+
<span class="md-nav__icon md-icon"></span>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
Getting Started
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</label>
|
|
583
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
<li class="md-nav__item">
|
|
594
|
+
<a href="../../../getting-started/installation/" class="md-nav__link">
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
<span class="md-ellipsis">
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
Installation
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
</span>
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
</a>
|
|
610
|
+
</li>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
<li class="md-nav__item">
|
|
622
|
+
<a href="../../../getting-started/quick-start/" class="md-nav__link">
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
<span class="md-ellipsis">
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
Quick Start
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
</span>
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
</a>
|
|
638
|
+
</li>
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
<li class="md-nav__item">
|
|
650
|
+
<a href="../../../getting-started/configuration/" class="md-nav__link">
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
<span class="md-ellipsis">
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
Configuration
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
</span>
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
</a>
|
|
666
|
+
</li>
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
</ul>
|
|
672
|
+
</nav>
|
|
673
|
+
|
|
674
|
+
</li>
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
|
|
713
|
+
|
|
714
|
+
|
|
715
|
+
<div class="md-nav__link md-nav__container">
|
|
716
|
+
<a href="../../../architecture/" class="md-nav__link ">
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
<span class="md-ellipsis">
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
Architecture
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
</span>
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
</a>
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
|
|
735
|
+
<span class="md-nav__icon md-icon"></span>
|
|
736
|
+
</label>
|
|
737
|
+
|
|
738
|
+
</div>
|
|
739
|
+
|
|
740
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
|
741
|
+
<label class="md-nav__title" for="__nav_3">
|
|
742
|
+
<span class="md-nav__icon md-icon"></span>
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
Architecture
|
|
746
|
+
|
|
747
|
+
|
|
748
|
+
</label>
|
|
749
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
<li class="md-nav__item">
|
|
760
|
+
<a href="../../../architecture/core-concepts/" class="md-nav__link">
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
<span class="md-ellipsis">
|
|
765
|
+
|
|
766
|
+
|
|
767
|
+
Core Concepts
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
</span>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
</a>
|
|
776
|
+
</li>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
<li class="md-nav__item">
|
|
788
|
+
<a href="../../../architecture/robot-execution/" class="md-nav__link">
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
<span class="md-ellipsis">
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
Robot Execution
|
|
796
|
+
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
</span>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
</a>
|
|
804
|
+
</li>
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
<li class="md-nav__item">
|
|
816
|
+
<a href="../../../architecture/network-orchestration/" class="md-nav__link">
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
<span class="md-ellipsis">
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
Network Orchestration
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
</span>
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
</a>
|
|
832
|
+
</li>
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
<li class="md-nav__item">
|
|
844
|
+
<a href="../../../architecture/state-management/" class="md-nav__link">
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
<span class="md-ellipsis">
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
State Management
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
</span>
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
</a>
|
|
860
|
+
</li>
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
<li class="md-nav__item">
|
|
872
|
+
<a href="../../../architecture/message-flow/" class="md-nav__link">
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
<span class="md-ellipsis">
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
Message Flow
|
|
880
|
+
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
</span>
|
|
884
|
+
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
</a>
|
|
888
|
+
</li>
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
</ul>
|
|
894
|
+
</nav>
|
|
895
|
+
|
|
896
|
+
</li>
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
<div class="md-nav__link md-nav__container">
|
|
942
|
+
<a href="../../../guides/" class="md-nav__link ">
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
|
|
946
|
+
<span class="md-ellipsis">
|
|
947
|
+
|
|
948
|
+
|
|
949
|
+
Guides
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
</span>
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
</a>
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
|
|
961
|
+
<span class="md-nav__icon md-icon"></span>
|
|
962
|
+
</label>
|
|
963
|
+
|
|
964
|
+
</div>
|
|
965
|
+
|
|
966
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
|
967
|
+
<label class="md-nav__title" for="__nav_4">
|
|
968
|
+
<span class="md-nav__icon md-icon"></span>
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
Guides
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
</label>
|
|
975
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
<li class="md-nav__item">
|
|
986
|
+
<a href="../../../guides/building-robots/" class="md-nav__link">
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
<span class="md-ellipsis">
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
Building Robots
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
</span>
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
</a>
|
|
1002
|
+
</li>
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
<li class="md-nav__item">
|
|
1014
|
+
<a href="../../../guides/creating-networks/" class="md-nav__link">
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
<span class="md-ellipsis">
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
Creating Networks
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
</span>
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
</a>
|
|
1030
|
+
</li>
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
<li class="md-nav__item">
|
|
1042
|
+
<a href="../../../guides/using-tools/" class="md-nav__link">
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
<span class="md-ellipsis">
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
Using Tools
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
</span>
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
</a>
|
|
1058
|
+
</li>
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
<li class="md-nav__item">
|
|
1070
|
+
<a href="../../../guides/mcp-integration/" class="md-nav__link">
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
<span class="md-ellipsis">
|
|
1075
|
+
|
|
1076
|
+
|
|
1077
|
+
MCP Integration
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
</span>
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
</a>
|
|
1086
|
+
</li>
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
<li class="md-nav__item">
|
|
1098
|
+
<a href="../../../guides/streaming/" class="md-nav__link">
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
<span class="md-ellipsis">
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
Streaming Responses
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
</span>
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
</a>
|
|
1114
|
+
</li>
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
<li class="md-nav__item">
|
|
1126
|
+
<a href="../../../guides/memory/" class="md-nav__link">
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
<span class="md-ellipsis">
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
Memory System
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
</span>
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
</a>
|
|
1142
|
+
</li>
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
<li class="md-nav__item">
|
|
1154
|
+
<a href="../../../guides/rails-integration/" class="md-nav__link">
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
<span class="md-ellipsis">
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
Rails Integration
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
</span>
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
</a>
|
|
1170
|
+
</li>
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
</ul>
|
|
1176
|
+
</nav>
|
|
1177
|
+
|
|
1178
|
+
</li>
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
<div class="md-nav__link md-nav__container">
|
|
1223
|
+
<a href="../../" class="md-nav__link ">
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
<span class="md-ellipsis">
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
API Reference
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
</span>
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
</a>
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
|
|
1242
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1243
|
+
</label>
|
|
1244
|
+
|
|
1245
|
+
</div>
|
|
1246
|
+
|
|
1247
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
|
|
1248
|
+
<label class="md-nav__title" for="__nav_5">
|
|
1249
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
API Reference
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
</label>
|
|
1256
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
<div class="md-nav__link md-nav__container">
|
|
1298
|
+
<a href="../../core/" class="md-nav__link ">
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
|
|
1302
|
+
<span class="md-ellipsis">
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
Core Classes
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
</span>
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
</a>
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
<label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
|
|
1317
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1318
|
+
</label>
|
|
1319
|
+
|
|
1320
|
+
</div>
|
|
1321
|
+
|
|
1322
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
|
|
1323
|
+
<label class="md-nav__title" for="__nav_5_2">
|
|
1324
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
Core Classes
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
</label>
|
|
1331
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
<li class="md-nav__item">
|
|
1342
|
+
<a href="../../core/robot/" class="md-nav__link">
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
<span class="md-ellipsis">
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
Robot
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
</span>
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
</a>
|
|
1358
|
+
</li>
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
<li class="md-nav__item">
|
|
1370
|
+
<a href="../../core/network/" class="md-nav__link">
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
<span class="md-ellipsis">
|
|
1375
|
+
|
|
1376
|
+
|
|
1377
|
+
Network
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
</span>
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
</a>
|
|
1386
|
+
</li>
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
|
|
1397
|
+
<li class="md-nav__item">
|
|
1398
|
+
<a href="../../core/state/" class="md-nav__link">
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
<span class="md-ellipsis">
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
State
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
</span>
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
</a>
|
|
1414
|
+
</li>
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
<li class="md-nav__item">
|
|
1426
|
+
<a href="../../core/tool/" class="md-nav__link">
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
<span class="md-ellipsis">
|
|
1431
|
+
|
|
1432
|
+
|
|
1433
|
+
Tool
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
</span>
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
</a>
|
|
1442
|
+
</li>
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
<li class="md-nav__item">
|
|
1454
|
+
<a href="../../core/memory/" class="md-nav__link">
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
<span class="md-ellipsis">
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
Memory
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
</span>
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
</a>
|
|
1470
|
+
</li>
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
</ul>
|
|
1476
|
+
</nav>
|
|
1477
|
+
|
|
1478
|
+
</li>
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" >
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
<div class="md-nav__link md-nav__container">
|
|
1519
|
+
<a href="../../messages/" class="md-nav__link ">
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
<span class="md-ellipsis">
|
|
1524
|
+
|
|
1525
|
+
|
|
1526
|
+
Messages
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
|
|
1530
|
+
</span>
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
</a>
|
|
1535
|
+
|
|
1536
|
+
|
|
1537
|
+
<label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0">
|
|
1538
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1539
|
+
</label>
|
|
1540
|
+
|
|
1541
|
+
</div>
|
|
1542
|
+
|
|
1543
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false">
|
|
1544
|
+
<label class="md-nav__title" for="__nav_5_3">
|
|
1545
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
Messages
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
</label>
|
|
1552
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
<li class="md-nav__item">
|
|
1563
|
+
<a href="../../messages/user-message/" class="md-nav__link">
|
|
1564
|
+
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
<span class="md-ellipsis">
|
|
1568
|
+
|
|
1569
|
+
|
|
1570
|
+
UserMessage
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
</span>
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
</a>
|
|
1579
|
+
</li>
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
<li class="md-nav__item">
|
|
1591
|
+
<a href="../../messages/text-message/" class="md-nav__link">
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
<span class="md-ellipsis">
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
TextMessage
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
|
|
1602
|
+
</span>
|
|
1603
|
+
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
</a>
|
|
1607
|
+
</li>
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
|
|
1617
|
+
|
|
1618
|
+
<li class="md-nav__item">
|
|
1619
|
+
<a href="../../messages/tool-call-message/" class="md-nav__link">
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
|
|
1623
|
+
<span class="md-ellipsis">
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
ToolCallMessage
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
|
|
1630
|
+
</span>
|
|
1631
|
+
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
</a>
|
|
1635
|
+
</li>
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
|
|
1641
|
+
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
<li class="md-nav__item">
|
|
1647
|
+
<a href="../../messages/tool-result-message/" class="md-nav__link">
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
<span class="md-ellipsis">
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
ToolResultMessage
|
|
1655
|
+
|
|
1656
|
+
|
|
1657
|
+
|
|
1658
|
+
</span>
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
</a>
|
|
1663
|
+
</li>
|
|
1664
|
+
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
</ul>
|
|
1669
|
+
</nav>
|
|
1670
|
+
|
|
1671
|
+
</li>
|
|
1672
|
+
|
|
1673
|
+
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" checked>
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
<div class="md-nav__link md-nav__container">
|
|
1712
|
+
<a href="../" class="md-nav__link ">
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
|
|
1716
|
+
<span class="md-ellipsis">
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
MCP
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
</span>
|
|
1724
|
+
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
</a>
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
<label class="md-nav__link " for="__nav_5_4" id="__nav_5_4_label" tabindex="0">
|
|
1731
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1732
|
+
</label>
|
|
1733
|
+
|
|
1734
|
+
</div>
|
|
1735
|
+
|
|
1736
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="true">
|
|
1737
|
+
<label class="md-nav__title" for="__nav_5_4">
|
|
1738
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
MCP
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
</label>
|
|
1745
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
|
|
1753
|
+
|
|
1754
|
+
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
<li class="md-nav__item md-nav__item--active">
|
|
1758
|
+
|
|
1759
|
+
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
1760
|
+
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
|
|
1765
|
+
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
1766
|
+
|
|
1767
|
+
|
|
1768
|
+
|
|
1769
|
+
<span class="md-ellipsis">
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
Client
|
|
1773
|
+
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
</span>
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
|
|
1780
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1781
|
+
</label>
|
|
1782
|
+
|
|
1783
|
+
<a href="./" class="md-nav__link md-nav__link--active">
|
|
1784
|
+
|
|
1785
|
+
|
|
1786
|
+
|
|
1787
|
+
<span class="md-ellipsis">
|
|
1788
|
+
|
|
1789
|
+
|
|
1790
|
+
Client
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
</span>
|
|
1795
|
+
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
</a>
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
1805
|
+
|
|
1806
|
+
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
|
|
1811
|
+
<label class="md-nav__title" for="__toc">
|
|
1812
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1813
|
+
On this page
|
|
1814
|
+
</label>
|
|
1815
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
1816
|
+
|
|
1817
|
+
<li class="md-nav__item">
|
|
1818
|
+
<a href="#class-robotlabmcpclient" class="md-nav__link">
|
|
1819
|
+
<span class="md-ellipsis">
|
|
1820
|
+
|
|
1821
|
+
Class: RobotLab::MCP::Client
|
|
1822
|
+
|
|
1823
|
+
</span>
|
|
1824
|
+
</a>
|
|
1825
|
+
|
|
1826
|
+
</li>
|
|
1827
|
+
|
|
1828
|
+
<li class="md-nav__item">
|
|
1829
|
+
<a href="#constructor" class="md-nav__link">
|
|
1830
|
+
<span class="md-ellipsis">
|
|
1831
|
+
|
|
1832
|
+
Constructor
|
|
1833
|
+
|
|
1834
|
+
</span>
|
|
1835
|
+
</a>
|
|
1836
|
+
|
|
1837
|
+
</li>
|
|
1838
|
+
|
|
1839
|
+
<li class="md-nav__item">
|
|
1840
|
+
<a href="#attributes" class="md-nav__link">
|
|
1841
|
+
<span class="md-ellipsis">
|
|
1842
|
+
|
|
1843
|
+
Attributes
|
|
1844
|
+
|
|
1845
|
+
</span>
|
|
1846
|
+
</a>
|
|
1847
|
+
|
|
1848
|
+
<nav class="md-nav" aria-label="Attributes">
|
|
1849
|
+
<ul class="md-nav__list">
|
|
1850
|
+
|
|
1851
|
+
<li class="md-nav__item">
|
|
1852
|
+
<a href="#server" class="md-nav__link">
|
|
1853
|
+
<span class="md-ellipsis">
|
|
1854
|
+
|
|
1855
|
+
server
|
|
1856
|
+
|
|
1857
|
+
</span>
|
|
1858
|
+
</a>
|
|
1859
|
+
|
|
1860
|
+
</li>
|
|
1861
|
+
|
|
1862
|
+
<li class="md-nav__item">
|
|
1863
|
+
<a href="#connected" class="md-nav__link">
|
|
1864
|
+
<span class="md-ellipsis">
|
|
1865
|
+
|
|
1866
|
+
connected?
|
|
1867
|
+
|
|
1868
|
+
</span>
|
|
1869
|
+
</a>
|
|
1870
|
+
|
|
1871
|
+
</li>
|
|
1872
|
+
|
|
1873
|
+
</ul>
|
|
1874
|
+
</nav>
|
|
1875
|
+
|
|
1876
|
+
</li>
|
|
1877
|
+
|
|
1878
|
+
<li class="md-nav__item">
|
|
1879
|
+
<a href="#methods" class="md-nav__link">
|
|
1880
|
+
<span class="md-ellipsis">
|
|
1881
|
+
|
|
1882
|
+
Methods
|
|
1883
|
+
|
|
1884
|
+
</span>
|
|
1885
|
+
</a>
|
|
1886
|
+
|
|
1887
|
+
<nav class="md-nav" aria-label="Methods">
|
|
1888
|
+
<ul class="md-nav__list">
|
|
1889
|
+
|
|
1890
|
+
<li class="md-nav__item">
|
|
1891
|
+
<a href="#connect" class="md-nav__link">
|
|
1892
|
+
<span class="md-ellipsis">
|
|
1893
|
+
|
|
1894
|
+
connect
|
|
1895
|
+
|
|
1896
|
+
</span>
|
|
1897
|
+
</a>
|
|
1898
|
+
|
|
1899
|
+
</li>
|
|
1900
|
+
|
|
1901
|
+
<li class="md-nav__item">
|
|
1902
|
+
<a href="#disconnect" class="md-nav__link">
|
|
1903
|
+
<span class="md-ellipsis">
|
|
1904
|
+
|
|
1905
|
+
disconnect
|
|
1906
|
+
|
|
1907
|
+
</span>
|
|
1908
|
+
</a>
|
|
1909
|
+
|
|
1910
|
+
</li>
|
|
1911
|
+
|
|
1912
|
+
<li class="md-nav__item">
|
|
1913
|
+
<a href="#list_tools" class="md-nav__link">
|
|
1914
|
+
<span class="md-ellipsis">
|
|
1915
|
+
|
|
1916
|
+
list_tools
|
|
1917
|
+
|
|
1918
|
+
</span>
|
|
1919
|
+
</a>
|
|
1920
|
+
|
|
1921
|
+
</li>
|
|
1922
|
+
|
|
1923
|
+
<li class="md-nav__item">
|
|
1924
|
+
<a href="#call_tool" class="md-nav__link">
|
|
1925
|
+
<span class="md-ellipsis">
|
|
1926
|
+
|
|
1927
|
+
call_tool
|
|
1928
|
+
|
|
1929
|
+
</span>
|
|
1930
|
+
</a>
|
|
1931
|
+
|
|
1932
|
+
</li>
|
|
1933
|
+
|
|
1934
|
+
<li class="md-nav__item">
|
|
1935
|
+
<a href="#list_resources" class="md-nav__link">
|
|
1936
|
+
<span class="md-ellipsis">
|
|
1937
|
+
|
|
1938
|
+
list_resources
|
|
1939
|
+
|
|
1940
|
+
</span>
|
|
1941
|
+
</a>
|
|
1942
|
+
|
|
1943
|
+
</li>
|
|
1944
|
+
|
|
1945
|
+
<li class="md-nav__item">
|
|
1946
|
+
<a href="#read_resource" class="md-nav__link">
|
|
1947
|
+
<span class="md-ellipsis">
|
|
1948
|
+
|
|
1949
|
+
read_resource
|
|
1950
|
+
|
|
1951
|
+
</span>
|
|
1952
|
+
</a>
|
|
1953
|
+
|
|
1954
|
+
</li>
|
|
1955
|
+
|
|
1956
|
+
<li class="md-nav__item">
|
|
1957
|
+
<a href="#list_prompts" class="md-nav__link">
|
|
1958
|
+
<span class="md-ellipsis">
|
|
1959
|
+
|
|
1960
|
+
list_prompts
|
|
1961
|
+
|
|
1962
|
+
</span>
|
|
1963
|
+
</a>
|
|
1964
|
+
|
|
1965
|
+
</li>
|
|
1966
|
+
|
|
1967
|
+
<li class="md-nav__item">
|
|
1968
|
+
<a href="#get_prompt" class="md-nav__link">
|
|
1969
|
+
<span class="md-ellipsis">
|
|
1970
|
+
|
|
1971
|
+
get_prompt
|
|
1972
|
+
|
|
1973
|
+
</span>
|
|
1974
|
+
</a>
|
|
1975
|
+
|
|
1976
|
+
</li>
|
|
1977
|
+
|
|
1978
|
+
<li class="md-nav__item">
|
|
1979
|
+
<a href="#to_h" class="md-nav__link">
|
|
1980
|
+
<span class="md-ellipsis">
|
|
1981
|
+
|
|
1982
|
+
to_h
|
|
1983
|
+
|
|
1984
|
+
</span>
|
|
1985
|
+
</a>
|
|
1986
|
+
|
|
1987
|
+
</li>
|
|
1988
|
+
|
|
1989
|
+
</ul>
|
|
1990
|
+
</nav>
|
|
1991
|
+
|
|
1992
|
+
</li>
|
|
1993
|
+
|
|
1994
|
+
<li class="md-nav__item">
|
|
1995
|
+
<a href="#transport-configuration" class="md-nav__link">
|
|
1996
|
+
<span class="md-ellipsis">
|
|
1997
|
+
|
|
1998
|
+
Transport Configuration
|
|
1999
|
+
|
|
2000
|
+
</span>
|
|
2001
|
+
</a>
|
|
2002
|
+
|
|
2003
|
+
<nav class="md-nav" aria-label="Transport Configuration">
|
|
2004
|
+
<ul class="md-nav__list">
|
|
2005
|
+
|
|
2006
|
+
<li class="md-nav__item">
|
|
2007
|
+
<a href="#stdio" class="md-nav__link">
|
|
2008
|
+
<span class="md-ellipsis">
|
|
2009
|
+
|
|
2010
|
+
Stdio
|
|
2011
|
+
|
|
2012
|
+
</span>
|
|
2013
|
+
</a>
|
|
2014
|
+
|
|
2015
|
+
</li>
|
|
2016
|
+
|
|
2017
|
+
<li class="md-nav__item">
|
|
2018
|
+
<a href="#websocket" class="md-nav__link">
|
|
2019
|
+
<span class="md-ellipsis">
|
|
2020
|
+
|
|
2021
|
+
WebSocket
|
|
2022
|
+
|
|
2023
|
+
</span>
|
|
2024
|
+
</a>
|
|
2025
|
+
|
|
2026
|
+
</li>
|
|
2027
|
+
|
|
2028
|
+
<li class="md-nav__item">
|
|
2029
|
+
<a href="#sse" class="md-nav__link">
|
|
2030
|
+
<span class="md-ellipsis">
|
|
2031
|
+
|
|
2032
|
+
SSE
|
|
2033
|
+
|
|
2034
|
+
</span>
|
|
2035
|
+
</a>
|
|
2036
|
+
|
|
2037
|
+
</li>
|
|
2038
|
+
|
|
2039
|
+
<li class="md-nav__item">
|
|
2040
|
+
<a href="#streamable-http" class="md-nav__link">
|
|
2041
|
+
<span class="md-ellipsis">
|
|
2042
|
+
|
|
2043
|
+
Streamable HTTP
|
|
2044
|
+
|
|
2045
|
+
</span>
|
|
2046
|
+
</a>
|
|
2047
|
+
|
|
2048
|
+
</li>
|
|
2049
|
+
|
|
2050
|
+
</ul>
|
|
2051
|
+
</nav>
|
|
2052
|
+
|
|
2053
|
+
</li>
|
|
2054
|
+
|
|
2055
|
+
<li class="md-nav__item">
|
|
2056
|
+
<a href="#examples" class="md-nav__link">
|
|
2057
|
+
<span class="md-ellipsis">
|
|
2058
|
+
|
|
2059
|
+
Examples
|
|
2060
|
+
|
|
2061
|
+
</span>
|
|
2062
|
+
</a>
|
|
2063
|
+
|
|
2064
|
+
<nav class="md-nav" aria-label="Examples">
|
|
2065
|
+
<ul class="md-nav__list">
|
|
2066
|
+
|
|
2067
|
+
<li class="md-nav__item">
|
|
2068
|
+
<a href="#basic-usage" class="md-nav__link">
|
|
2069
|
+
<span class="md-ellipsis">
|
|
2070
|
+
|
|
2071
|
+
Basic Usage
|
|
2072
|
+
|
|
2073
|
+
</span>
|
|
2074
|
+
</a>
|
|
2075
|
+
|
|
2076
|
+
</li>
|
|
2077
|
+
|
|
2078
|
+
<li class="md-nav__item">
|
|
2079
|
+
<a href="#from-a-server-object" class="md-nav__link">
|
|
2080
|
+
<span class="md-ellipsis">
|
|
2081
|
+
|
|
2082
|
+
From a Server Object
|
|
2083
|
+
|
|
2084
|
+
</span>
|
|
2085
|
+
</a>
|
|
2086
|
+
|
|
2087
|
+
</li>
|
|
2088
|
+
|
|
2089
|
+
<li class="md-nav__item">
|
|
2090
|
+
<a href="#in-a-robot" class="md-nav__link">
|
|
2091
|
+
<span class="md-ellipsis">
|
|
2092
|
+
|
|
2093
|
+
In a Robot
|
|
2094
|
+
|
|
2095
|
+
</span>
|
|
2096
|
+
</a>
|
|
2097
|
+
|
|
2098
|
+
</li>
|
|
2099
|
+
|
|
2100
|
+
<li class="md-nav__item">
|
|
2101
|
+
<a href="#error-handling" class="md-nav__link">
|
|
2102
|
+
<span class="md-ellipsis">
|
|
2103
|
+
|
|
2104
|
+
Error Handling
|
|
2105
|
+
|
|
2106
|
+
</span>
|
|
2107
|
+
</a>
|
|
2108
|
+
|
|
2109
|
+
</li>
|
|
2110
|
+
|
|
2111
|
+
</ul>
|
|
2112
|
+
</nav>
|
|
2113
|
+
|
|
2114
|
+
</li>
|
|
2115
|
+
|
|
2116
|
+
<li class="md-nav__item">
|
|
2117
|
+
<a href="#see-also" class="md-nav__link">
|
|
2118
|
+
<span class="md-ellipsis">
|
|
2119
|
+
|
|
2120
|
+
See Also
|
|
2121
|
+
|
|
2122
|
+
</span>
|
|
2123
|
+
</a>
|
|
2124
|
+
|
|
2125
|
+
</li>
|
|
2126
|
+
|
|
2127
|
+
</ul>
|
|
2128
|
+
|
|
2129
|
+
</nav>
|
|
2130
|
+
|
|
2131
|
+
</li>
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
|
|
2135
|
+
|
|
2136
|
+
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
|
|
2142
|
+
<li class="md-nav__item">
|
|
2143
|
+
<a href="../server/" class="md-nav__link">
|
|
2144
|
+
|
|
2145
|
+
|
|
2146
|
+
|
|
2147
|
+
<span class="md-ellipsis">
|
|
2148
|
+
|
|
2149
|
+
|
|
2150
|
+
Server
|
|
2151
|
+
|
|
2152
|
+
|
|
2153
|
+
|
|
2154
|
+
</span>
|
|
2155
|
+
|
|
2156
|
+
|
|
2157
|
+
|
|
2158
|
+
</a>
|
|
2159
|
+
</li>
|
|
2160
|
+
|
|
2161
|
+
|
|
2162
|
+
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
<li class="md-nav__item">
|
|
2171
|
+
<a href="../transports/" class="md-nav__link">
|
|
2172
|
+
|
|
2173
|
+
|
|
2174
|
+
|
|
2175
|
+
<span class="md-ellipsis">
|
|
2176
|
+
|
|
2177
|
+
|
|
2178
|
+
Transports
|
|
2179
|
+
|
|
2180
|
+
|
|
2181
|
+
|
|
2182
|
+
</span>
|
|
2183
|
+
|
|
2184
|
+
|
|
2185
|
+
|
|
2186
|
+
</a>
|
|
2187
|
+
</li>
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
</ul>
|
|
2193
|
+
</nav>
|
|
2194
|
+
|
|
2195
|
+
</li>
|
|
2196
|
+
|
|
2197
|
+
|
|
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
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" >
|
|
2229
|
+
|
|
2230
|
+
|
|
2231
|
+
<div class="md-nav__link md-nav__container">
|
|
2232
|
+
<a href="../../streaming/" class="md-nav__link ">
|
|
2233
|
+
|
|
2234
|
+
|
|
2235
|
+
|
|
2236
|
+
<span class="md-ellipsis">
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
Streaming
|
|
2240
|
+
|
|
2241
|
+
|
|
2242
|
+
|
|
2243
|
+
</span>
|
|
2244
|
+
|
|
2245
|
+
|
|
2246
|
+
|
|
2247
|
+
</a>
|
|
2248
|
+
|
|
2249
|
+
|
|
2250
|
+
<label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
|
|
2251
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2252
|
+
</label>
|
|
2253
|
+
|
|
2254
|
+
</div>
|
|
2255
|
+
|
|
2256
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
|
|
2257
|
+
<label class="md-nav__title" for="__nav_5_5">
|
|
2258
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2259
|
+
|
|
2260
|
+
|
|
2261
|
+
Streaming
|
|
2262
|
+
|
|
2263
|
+
|
|
2264
|
+
</label>
|
|
2265
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2266
|
+
|
|
2267
|
+
|
|
2268
|
+
|
|
2269
|
+
|
|
2270
|
+
|
|
2271
|
+
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
|
|
2275
|
+
<li class="md-nav__item">
|
|
2276
|
+
<a href="../../streaming/context/" class="md-nav__link">
|
|
2277
|
+
|
|
2278
|
+
|
|
2279
|
+
|
|
2280
|
+
<span class="md-ellipsis">
|
|
2281
|
+
|
|
2282
|
+
|
|
2283
|
+
Context
|
|
2284
|
+
|
|
2285
|
+
|
|
2286
|
+
|
|
2287
|
+
</span>
|
|
2288
|
+
|
|
2289
|
+
|
|
2290
|
+
|
|
2291
|
+
</a>
|
|
2292
|
+
</li>
|
|
2293
|
+
|
|
2294
|
+
|
|
2295
|
+
|
|
2296
|
+
|
|
2297
|
+
|
|
2298
|
+
|
|
2299
|
+
|
|
2300
|
+
|
|
2301
|
+
|
|
2302
|
+
|
|
2303
|
+
<li class="md-nav__item">
|
|
2304
|
+
<a href="../../streaming/events/" class="md-nav__link">
|
|
2305
|
+
|
|
2306
|
+
|
|
2307
|
+
|
|
2308
|
+
<span class="md-ellipsis">
|
|
2309
|
+
|
|
2310
|
+
|
|
2311
|
+
Events
|
|
2312
|
+
|
|
2313
|
+
|
|
2314
|
+
|
|
2315
|
+
</span>
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
</a>
|
|
2320
|
+
</li>
|
|
2321
|
+
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
|
|
2325
|
+
</ul>
|
|
2326
|
+
</nav>
|
|
2327
|
+
|
|
2328
|
+
</li>
|
|
2329
|
+
|
|
2330
|
+
|
|
2331
|
+
|
|
2332
|
+
|
|
2333
|
+
</ul>
|
|
2334
|
+
</nav>
|
|
2335
|
+
|
|
2336
|
+
</li>
|
|
2337
|
+
|
|
2338
|
+
|
|
2339
|
+
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
|
|
2344
|
+
|
|
2345
|
+
|
|
2346
|
+
|
|
2347
|
+
|
|
2348
|
+
|
|
2349
|
+
|
|
2350
|
+
|
|
2351
|
+
|
|
2352
|
+
|
|
2353
|
+
|
|
2354
|
+
|
|
2355
|
+
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
|
|
2359
|
+
|
|
2360
|
+
|
|
2361
|
+
|
|
2362
|
+
|
|
2363
|
+
|
|
2364
|
+
|
|
2365
|
+
|
|
2366
|
+
|
|
2367
|
+
|
|
2368
|
+
|
|
2369
|
+
|
|
2370
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2371
|
+
|
|
2372
|
+
|
|
2373
|
+
|
|
2374
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
|
|
2375
|
+
|
|
2376
|
+
|
|
2377
|
+
<div class="md-nav__link md-nav__container">
|
|
2378
|
+
<a href="../../../examples/" class="md-nav__link ">
|
|
2379
|
+
|
|
2380
|
+
|
|
2381
|
+
|
|
2382
|
+
<span class="md-ellipsis">
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
Examples
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
|
|
2389
|
+
</span>
|
|
2390
|
+
|
|
2391
|
+
|
|
2392
|
+
|
|
2393
|
+
</a>
|
|
2394
|
+
|
|
2395
|
+
|
|
2396
|
+
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
|
|
2397
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2398
|
+
</label>
|
|
2399
|
+
|
|
2400
|
+
</div>
|
|
2401
|
+
|
|
2402
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
2403
|
+
<label class="md-nav__title" for="__nav_6">
|
|
2404
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2405
|
+
|
|
2406
|
+
|
|
2407
|
+
Examples
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
</label>
|
|
2411
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2412
|
+
|
|
2413
|
+
|
|
2414
|
+
|
|
2415
|
+
|
|
2416
|
+
|
|
2417
|
+
|
|
2418
|
+
|
|
2419
|
+
|
|
2420
|
+
|
|
2421
|
+
<li class="md-nav__item">
|
|
2422
|
+
<a href="../../../examples/basic-chat/" class="md-nav__link">
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
|
|
2426
|
+
<span class="md-ellipsis">
|
|
2427
|
+
|
|
2428
|
+
|
|
2429
|
+
Basic Chat
|
|
2430
|
+
|
|
2431
|
+
|
|
2432
|
+
|
|
2433
|
+
</span>
|
|
2434
|
+
|
|
2435
|
+
|
|
2436
|
+
|
|
2437
|
+
</a>
|
|
2438
|
+
</li>
|
|
2439
|
+
|
|
2440
|
+
|
|
2441
|
+
|
|
2442
|
+
|
|
2443
|
+
|
|
2444
|
+
|
|
2445
|
+
|
|
2446
|
+
|
|
2447
|
+
|
|
2448
|
+
|
|
2449
|
+
<li class="md-nav__item">
|
|
2450
|
+
<a href="../../../examples/multi-robot-network/" class="md-nav__link">
|
|
2451
|
+
|
|
2452
|
+
|
|
2453
|
+
|
|
2454
|
+
<span class="md-ellipsis">
|
|
2455
|
+
|
|
2456
|
+
|
|
2457
|
+
Multi-Robot Network
|
|
2458
|
+
|
|
2459
|
+
|
|
2460
|
+
|
|
2461
|
+
</span>
|
|
2462
|
+
|
|
2463
|
+
|
|
2464
|
+
|
|
2465
|
+
</a>
|
|
2466
|
+
</li>
|
|
2467
|
+
|
|
2468
|
+
|
|
2469
|
+
|
|
2470
|
+
|
|
2471
|
+
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
|
|
2477
|
+
<li class="md-nav__item">
|
|
2478
|
+
<a href="../../../examples/tool-usage/" class="md-nav__link">
|
|
2479
|
+
|
|
2480
|
+
|
|
2481
|
+
|
|
2482
|
+
<span class="md-ellipsis">
|
|
2483
|
+
|
|
2484
|
+
|
|
2485
|
+
Tool Usage
|
|
2486
|
+
|
|
2487
|
+
|
|
2488
|
+
|
|
2489
|
+
</span>
|
|
2490
|
+
|
|
2491
|
+
|
|
2492
|
+
|
|
2493
|
+
</a>
|
|
2494
|
+
</li>
|
|
2495
|
+
|
|
2496
|
+
|
|
2497
|
+
|
|
2498
|
+
|
|
2499
|
+
|
|
2500
|
+
|
|
2501
|
+
|
|
2502
|
+
|
|
2503
|
+
|
|
2504
|
+
|
|
2505
|
+
<li class="md-nav__item">
|
|
2506
|
+
<a href="../../../examples/mcp-server/" class="md-nav__link">
|
|
2507
|
+
|
|
2508
|
+
|
|
2509
|
+
|
|
2510
|
+
<span class="md-ellipsis">
|
|
2511
|
+
|
|
2512
|
+
|
|
2513
|
+
MCP Server
|
|
2514
|
+
|
|
2515
|
+
|
|
2516
|
+
|
|
2517
|
+
</span>
|
|
2518
|
+
|
|
2519
|
+
|
|
2520
|
+
|
|
2521
|
+
</a>
|
|
2522
|
+
</li>
|
|
2523
|
+
|
|
2524
|
+
|
|
2525
|
+
|
|
2526
|
+
|
|
2527
|
+
|
|
2528
|
+
|
|
2529
|
+
|
|
2530
|
+
|
|
2531
|
+
|
|
2532
|
+
|
|
2533
|
+
<li class="md-nav__item">
|
|
2534
|
+
<a href="../../../examples/rails-application/" class="md-nav__link">
|
|
2535
|
+
|
|
2536
|
+
|
|
2537
|
+
|
|
2538
|
+
<span class="md-ellipsis">
|
|
2539
|
+
|
|
2540
|
+
|
|
2541
|
+
Rails Application
|
|
2542
|
+
|
|
2543
|
+
|
|
2544
|
+
|
|
2545
|
+
</span>
|
|
2546
|
+
|
|
2547
|
+
|
|
2548
|
+
|
|
2549
|
+
</a>
|
|
2550
|
+
</li>
|
|
2551
|
+
|
|
2552
|
+
|
|
2553
|
+
|
|
2554
|
+
|
|
2555
|
+
</ul>
|
|
2556
|
+
</nav>
|
|
2557
|
+
|
|
2558
|
+
</li>
|
|
2559
|
+
|
|
2560
|
+
|
|
2561
|
+
|
|
2562
|
+
</ul>
|
|
2563
|
+
</nav>
|
|
2564
|
+
</div>
|
|
2565
|
+
</div>
|
|
2566
|
+
</div>
|
|
2567
|
+
|
|
2568
|
+
|
|
2569
|
+
|
|
2570
|
+
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
2571
|
+
<div class="md-sidebar__scrollwrap">
|
|
2572
|
+
<div class="md-sidebar__inner">
|
|
2573
|
+
|
|
2574
|
+
|
|
2575
|
+
|
|
2576
|
+
|
|
2577
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
2578
|
+
|
|
2579
|
+
|
|
2580
|
+
|
|
2581
|
+
|
|
2582
|
+
|
|
2583
|
+
|
|
2584
|
+
<label class="md-nav__title" for="__toc">
|
|
2585
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2586
|
+
On this page
|
|
2587
|
+
</label>
|
|
2588
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
2589
|
+
|
|
2590
|
+
<li class="md-nav__item">
|
|
2591
|
+
<a href="#class-robotlabmcpclient" class="md-nav__link">
|
|
2592
|
+
<span class="md-ellipsis">
|
|
2593
|
+
|
|
2594
|
+
Class: RobotLab::MCP::Client
|
|
2595
|
+
|
|
2596
|
+
</span>
|
|
2597
|
+
</a>
|
|
2598
|
+
|
|
2599
|
+
</li>
|
|
2600
|
+
|
|
2601
|
+
<li class="md-nav__item">
|
|
2602
|
+
<a href="#constructor" class="md-nav__link">
|
|
2603
|
+
<span class="md-ellipsis">
|
|
2604
|
+
|
|
2605
|
+
Constructor
|
|
2606
|
+
|
|
2607
|
+
</span>
|
|
2608
|
+
</a>
|
|
2609
|
+
|
|
2610
|
+
</li>
|
|
2611
|
+
|
|
2612
|
+
<li class="md-nav__item">
|
|
2613
|
+
<a href="#attributes" class="md-nav__link">
|
|
2614
|
+
<span class="md-ellipsis">
|
|
2615
|
+
|
|
2616
|
+
Attributes
|
|
2617
|
+
|
|
2618
|
+
</span>
|
|
2619
|
+
</a>
|
|
2620
|
+
|
|
2621
|
+
<nav class="md-nav" aria-label="Attributes">
|
|
2622
|
+
<ul class="md-nav__list">
|
|
2623
|
+
|
|
2624
|
+
<li class="md-nav__item">
|
|
2625
|
+
<a href="#server" class="md-nav__link">
|
|
2626
|
+
<span class="md-ellipsis">
|
|
2627
|
+
|
|
2628
|
+
server
|
|
2629
|
+
|
|
2630
|
+
</span>
|
|
2631
|
+
</a>
|
|
2632
|
+
|
|
2633
|
+
</li>
|
|
2634
|
+
|
|
2635
|
+
<li class="md-nav__item">
|
|
2636
|
+
<a href="#connected" class="md-nav__link">
|
|
2637
|
+
<span class="md-ellipsis">
|
|
2638
|
+
|
|
2639
|
+
connected?
|
|
2640
|
+
|
|
2641
|
+
</span>
|
|
2642
|
+
</a>
|
|
2643
|
+
|
|
2644
|
+
</li>
|
|
2645
|
+
|
|
2646
|
+
</ul>
|
|
2647
|
+
</nav>
|
|
2648
|
+
|
|
2649
|
+
</li>
|
|
2650
|
+
|
|
2651
|
+
<li class="md-nav__item">
|
|
2652
|
+
<a href="#methods" class="md-nav__link">
|
|
2653
|
+
<span class="md-ellipsis">
|
|
2654
|
+
|
|
2655
|
+
Methods
|
|
2656
|
+
|
|
2657
|
+
</span>
|
|
2658
|
+
</a>
|
|
2659
|
+
|
|
2660
|
+
<nav class="md-nav" aria-label="Methods">
|
|
2661
|
+
<ul class="md-nav__list">
|
|
2662
|
+
|
|
2663
|
+
<li class="md-nav__item">
|
|
2664
|
+
<a href="#connect" class="md-nav__link">
|
|
2665
|
+
<span class="md-ellipsis">
|
|
2666
|
+
|
|
2667
|
+
connect
|
|
2668
|
+
|
|
2669
|
+
</span>
|
|
2670
|
+
</a>
|
|
2671
|
+
|
|
2672
|
+
</li>
|
|
2673
|
+
|
|
2674
|
+
<li class="md-nav__item">
|
|
2675
|
+
<a href="#disconnect" class="md-nav__link">
|
|
2676
|
+
<span class="md-ellipsis">
|
|
2677
|
+
|
|
2678
|
+
disconnect
|
|
2679
|
+
|
|
2680
|
+
</span>
|
|
2681
|
+
</a>
|
|
2682
|
+
|
|
2683
|
+
</li>
|
|
2684
|
+
|
|
2685
|
+
<li class="md-nav__item">
|
|
2686
|
+
<a href="#list_tools" class="md-nav__link">
|
|
2687
|
+
<span class="md-ellipsis">
|
|
2688
|
+
|
|
2689
|
+
list_tools
|
|
2690
|
+
|
|
2691
|
+
</span>
|
|
2692
|
+
</a>
|
|
2693
|
+
|
|
2694
|
+
</li>
|
|
2695
|
+
|
|
2696
|
+
<li class="md-nav__item">
|
|
2697
|
+
<a href="#call_tool" class="md-nav__link">
|
|
2698
|
+
<span class="md-ellipsis">
|
|
2699
|
+
|
|
2700
|
+
call_tool
|
|
2701
|
+
|
|
2702
|
+
</span>
|
|
2703
|
+
</a>
|
|
2704
|
+
|
|
2705
|
+
</li>
|
|
2706
|
+
|
|
2707
|
+
<li class="md-nav__item">
|
|
2708
|
+
<a href="#list_resources" class="md-nav__link">
|
|
2709
|
+
<span class="md-ellipsis">
|
|
2710
|
+
|
|
2711
|
+
list_resources
|
|
2712
|
+
|
|
2713
|
+
</span>
|
|
2714
|
+
</a>
|
|
2715
|
+
|
|
2716
|
+
</li>
|
|
2717
|
+
|
|
2718
|
+
<li class="md-nav__item">
|
|
2719
|
+
<a href="#read_resource" class="md-nav__link">
|
|
2720
|
+
<span class="md-ellipsis">
|
|
2721
|
+
|
|
2722
|
+
read_resource
|
|
2723
|
+
|
|
2724
|
+
</span>
|
|
2725
|
+
</a>
|
|
2726
|
+
|
|
2727
|
+
</li>
|
|
2728
|
+
|
|
2729
|
+
<li class="md-nav__item">
|
|
2730
|
+
<a href="#list_prompts" class="md-nav__link">
|
|
2731
|
+
<span class="md-ellipsis">
|
|
2732
|
+
|
|
2733
|
+
list_prompts
|
|
2734
|
+
|
|
2735
|
+
</span>
|
|
2736
|
+
</a>
|
|
2737
|
+
|
|
2738
|
+
</li>
|
|
2739
|
+
|
|
2740
|
+
<li class="md-nav__item">
|
|
2741
|
+
<a href="#get_prompt" class="md-nav__link">
|
|
2742
|
+
<span class="md-ellipsis">
|
|
2743
|
+
|
|
2744
|
+
get_prompt
|
|
2745
|
+
|
|
2746
|
+
</span>
|
|
2747
|
+
</a>
|
|
2748
|
+
|
|
2749
|
+
</li>
|
|
2750
|
+
|
|
2751
|
+
<li class="md-nav__item">
|
|
2752
|
+
<a href="#to_h" class="md-nav__link">
|
|
2753
|
+
<span class="md-ellipsis">
|
|
2754
|
+
|
|
2755
|
+
to_h
|
|
2756
|
+
|
|
2757
|
+
</span>
|
|
2758
|
+
</a>
|
|
2759
|
+
|
|
2760
|
+
</li>
|
|
2761
|
+
|
|
2762
|
+
</ul>
|
|
2763
|
+
</nav>
|
|
2764
|
+
|
|
2765
|
+
</li>
|
|
2766
|
+
|
|
2767
|
+
<li class="md-nav__item">
|
|
2768
|
+
<a href="#transport-configuration" class="md-nav__link">
|
|
2769
|
+
<span class="md-ellipsis">
|
|
2770
|
+
|
|
2771
|
+
Transport Configuration
|
|
2772
|
+
|
|
2773
|
+
</span>
|
|
2774
|
+
</a>
|
|
2775
|
+
|
|
2776
|
+
<nav class="md-nav" aria-label="Transport Configuration">
|
|
2777
|
+
<ul class="md-nav__list">
|
|
2778
|
+
|
|
2779
|
+
<li class="md-nav__item">
|
|
2780
|
+
<a href="#stdio" class="md-nav__link">
|
|
2781
|
+
<span class="md-ellipsis">
|
|
2782
|
+
|
|
2783
|
+
Stdio
|
|
2784
|
+
|
|
2785
|
+
</span>
|
|
2786
|
+
</a>
|
|
2787
|
+
|
|
2788
|
+
</li>
|
|
2789
|
+
|
|
2790
|
+
<li class="md-nav__item">
|
|
2791
|
+
<a href="#websocket" class="md-nav__link">
|
|
2792
|
+
<span class="md-ellipsis">
|
|
2793
|
+
|
|
2794
|
+
WebSocket
|
|
2795
|
+
|
|
2796
|
+
</span>
|
|
2797
|
+
</a>
|
|
2798
|
+
|
|
2799
|
+
</li>
|
|
2800
|
+
|
|
2801
|
+
<li class="md-nav__item">
|
|
2802
|
+
<a href="#sse" class="md-nav__link">
|
|
2803
|
+
<span class="md-ellipsis">
|
|
2804
|
+
|
|
2805
|
+
SSE
|
|
2806
|
+
|
|
2807
|
+
</span>
|
|
2808
|
+
</a>
|
|
2809
|
+
|
|
2810
|
+
</li>
|
|
2811
|
+
|
|
2812
|
+
<li class="md-nav__item">
|
|
2813
|
+
<a href="#streamable-http" class="md-nav__link">
|
|
2814
|
+
<span class="md-ellipsis">
|
|
2815
|
+
|
|
2816
|
+
Streamable HTTP
|
|
2817
|
+
|
|
2818
|
+
</span>
|
|
2819
|
+
</a>
|
|
2820
|
+
|
|
2821
|
+
</li>
|
|
2822
|
+
|
|
2823
|
+
</ul>
|
|
2824
|
+
</nav>
|
|
2825
|
+
|
|
2826
|
+
</li>
|
|
2827
|
+
|
|
2828
|
+
<li class="md-nav__item">
|
|
2829
|
+
<a href="#examples" class="md-nav__link">
|
|
2830
|
+
<span class="md-ellipsis">
|
|
2831
|
+
|
|
2832
|
+
Examples
|
|
2833
|
+
|
|
2834
|
+
</span>
|
|
2835
|
+
</a>
|
|
2836
|
+
|
|
2837
|
+
<nav class="md-nav" aria-label="Examples">
|
|
2838
|
+
<ul class="md-nav__list">
|
|
2839
|
+
|
|
2840
|
+
<li class="md-nav__item">
|
|
2841
|
+
<a href="#basic-usage" class="md-nav__link">
|
|
2842
|
+
<span class="md-ellipsis">
|
|
2843
|
+
|
|
2844
|
+
Basic Usage
|
|
2845
|
+
|
|
2846
|
+
</span>
|
|
2847
|
+
</a>
|
|
2848
|
+
|
|
2849
|
+
</li>
|
|
2850
|
+
|
|
2851
|
+
<li class="md-nav__item">
|
|
2852
|
+
<a href="#from-a-server-object" class="md-nav__link">
|
|
2853
|
+
<span class="md-ellipsis">
|
|
2854
|
+
|
|
2855
|
+
From a Server Object
|
|
2856
|
+
|
|
2857
|
+
</span>
|
|
2858
|
+
</a>
|
|
2859
|
+
|
|
2860
|
+
</li>
|
|
2861
|
+
|
|
2862
|
+
<li class="md-nav__item">
|
|
2863
|
+
<a href="#in-a-robot" class="md-nav__link">
|
|
2864
|
+
<span class="md-ellipsis">
|
|
2865
|
+
|
|
2866
|
+
In a Robot
|
|
2867
|
+
|
|
2868
|
+
</span>
|
|
2869
|
+
</a>
|
|
2870
|
+
|
|
2871
|
+
</li>
|
|
2872
|
+
|
|
2873
|
+
<li class="md-nav__item">
|
|
2874
|
+
<a href="#error-handling" class="md-nav__link">
|
|
2875
|
+
<span class="md-ellipsis">
|
|
2876
|
+
|
|
2877
|
+
Error Handling
|
|
2878
|
+
|
|
2879
|
+
</span>
|
|
2880
|
+
</a>
|
|
2881
|
+
|
|
2882
|
+
</li>
|
|
2883
|
+
|
|
2884
|
+
</ul>
|
|
2885
|
+
</nav>
|
|
2886
|
+
|
|
2887
|
+
</li>
|
|
2888
|
+
|
|
2889
|
+
<li class="md-nav__item">
|
|
2890
|
+
<a href="#see-also" class="md-nav__link">
|
|
2891
|
+
<span class="md-ellipsis">
|
|
2892
|
+
|
|
2893
|
+
See Also
|
|
2894
|
+
|
|
2895
|
+
</span>
|
|
2896
|
+
</a>
|
|
2897
|
+
|
|
2898
|
+
</li>
|
|
2899
|
+
|
|
2900
|
+
</ul>
|
|
2901
|
+
|
|
2902
|
+
</nav>
|
|
2903
|
+
</div>
|
|
2904
|
+
</div>
|
|
2905
|
+
</div>
|
|
2906
|
+
|
|
2907
|
+
|
|
2908
|
+
|
|
2909
|
+
<div class="md-content" data-md-component="content">
|
|
2910
|
+
|
|
2911
|
+
|
|
2912
|
+
|
|
2913
|
+
|
|
2914
|
+
|
|
2915
|
+
|
|
2916
|
+
<nav class="md-path" aria-label="Navigation" >
|
|
2917
|
+
<ol class="md-path__list">
|
|
2918
|
+
|
|
2919
|
+
|
|
2920
|
+
|
|
2921
|
+
|
|
2922
|
+
|
|
2923
|
+
|
|
2924
|
+
|
|
2925
|
+
<li class="md-path__item">
|
|
2926
|
+
<a href="../../" class="md-path__link">
|
|
2927
|
+
|
|
2928
|
+
<span class="md-ellipsis">
|
|
2929
|
+
API Reference
|
|
2930
|
+
</span>
|
|
2931
|
+
|
|
2932
|
+
</a>
|
|
2933
|
+
</li>
|
|
2934
|
+
|
|
2935
|
+
|
|
2936
|
+
|
|
2937
|
+
|
|
2938
|
+
|
|
2939
|
+
|
|
2940
|
+
|
|
2941
|
+
|
|
2942
|
+
|
|
2943
|
+
<li class="md-path__item">
|
|
2944
|
+
<a href="../" class="md-path__link">
|
|
2945
|
+
|
|
2946
|
+
<span class="md-ellipsis">
|
|
2947
|
+
MCP
|
|
2948
|
+
</span>
|
|
2949
|
+
|
|
2950
|
+
</a>
|
|
2951
|
+
</li>
|
|
2952
|
+
|
|
2953
|
+
|
|
2954
|
+
|
|
2955
|
+
|
|
2956
|
+
</ol>
|
|
2957
|
+
</nav>
|
|
2958
|
+
|
|
2959
|
+
|
|
2960
|
+
<article class="md-content__inner md-typeset">
|
|
2961
|
+
|
|
2962
|
+
|
|
2963
|
+
|
|
2964
|
+
|
|
2965
|
+
|
|
2966
|
+
<a href="https://github.com/madbomber/robot_lab/edit/main/docs/api/mcp/client.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
|
|
2967
|
+
|
|
2968
|
+
<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>
|
|
2969
|
+
</a>
|
|
2970
|
+
|
|
2971
|
+
|
|
2972
|
+
|
|
2973
|
+
|
|
2974
|
+
|
|
2975
|
+
<a href="https://github.com/madbomber/robot_lab/raw/main/docs/api/mcp/client.md" title="View source of this page" class="md-content__button md-icon">
|
|
2976
|
+
|
|
2977
|
+
<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>
|
|
2978
|
+
</a>
|
|
2979
|
+
|
|
2980
|
+
|
|
2981
|
+
|
|
2982
|
+
<h1 id="mcp-client">MCP Client<a class="headerlink" href="#mcp-client" title="Permanent link">¶</a></h1>
|
|
2983
|
+
<p>Connects to MCP servers, discovers tools, and invokes them via the Model Context Protocol.</p>
|
|
2984
|
+
<h2 id="class-robotlabmcpclient">Class: <code>RobotLab::MCP::Client</code><a class="headerlink" href="#class-robotlabmcpclient" title="Permanent link">¶</a></h2>
|
|
2985
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Client</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
|
2986
|
+
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"filesystem"</span><span class="p">,</span>
|
|
2987
|
+
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"stdio"</span><span class="p">,</span><span class="w"> </span><span class="ss">command</span><span class="p">:</span><span class="w"> </span><span class="s2">"mcp-server-filesystem"</span><span class="p">,</span><span class="w"> </span><span class="ss">args</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="s2">"--root"</span><span class="p">,</span><span class="w"> </span><span class="s2">"/data"</span><span class="o">]</span><span class="w"> </span><span class="p">}</span>
|
|
2988
|
+
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span>
|
|
2989
|
+
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>
|
|
2990
|
+
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="n">client</span><span class="o">.</span><span class="n">connect</span>
|
|
2991
|
+
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="n">tools</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">client</span><span class="o">.</span><span class="n">list_tools</span>
|
|
2992
|
+
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">client</span><span class="o">.</span><span class="n">call_tool</span><span class="p">(</span><span class="s2">"readFile"</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">path</span><span class="p">:</span><span class="w"> </span><span class="s2">"/data/readme.txt"</span><span class="w"> </span><span class="p">})</span>
|
|
2993
|
+
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="n">client</span><span class="o">.</span><span class="n">disconnect</span>
|
|
2994
|
+
</span></code></pre></div>
|
|
2995
|
+
<h2 id="constructor">Constructor<a class="headerlink" href="#constructor" title="Permanent link">¶</a></h2>
|
|
2996
|
+
<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="no">Client</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="n">server_or_config</span><span class="p">)</span>
|
|
2997
|
+
</span></code></pre></div>
|
|
2998
|
+
<p>Accepts either a <code>Server</code> instance or a Hash configuration. When a Hash is provided, it is used to construct a <code>Server</code> internally.</p>
|
|
2999
|
+
<p><strong>Parameters:</strong></p>
|
|
3000
|
+
<table>
|
|
3001
|
+
<thead>
|
|
3002
|
+
<tr>
|
|
3003
|
+
<th>Name</th>
|
|
3004
|
+
<th>Type</th>
|
|
3005
|
+
<th>Description</th>
|
|
3006
|
+
</tr>
|
|
3007
|
+
</thead>
|
|
3008
|
+
<tbody>
|
|
3009
|
+
<tr>
|
|
3010
|
+
<td><code>server_or_config</code></td>
|
|
3011
|
+
<td><code>Server</code>, <code>Hash</code></td>
|
|
3012
|
+
<td>Server instance or configuration hash</td>
|
|
3013
|
+
</tr>
|
|
3014
|
+
</tbody>
|
|
3015
|
+
</table>
|
|
3016
|
+
<p><strong>Hash Configuration Keys:</strong></p>
|
|
3017
|
+
<table>
|
|
3018
|
+
<thead>
|
|
3019
|
+
<tr>
|
|
3020
|
+
<th>Key</th>
|
|
3021
|
+
<th>Type</th>
|
|
3022
|
+
<th>Required</th>
|
|
3023
|
+
<th>Description</th>
|
|
3024
|
+
</tr>
|
|
3025
|
+
</thead>
|
|
3026
|
+
<tbody>
|
|
3027
|
+
<tr>
|
|
3028
|
+
<td><code>name</code></td>
|
|
3029
|
+
<td><code>String</code></td>
|
|
3030
|
+
<td>Yes</td>
|
|
3031
|
+
<td>Server identifier</td>
|
|
3032
|
+
</tr>
|
|
3033
|
+
<tr>
|
|
3034
|
+
<td><code>transport</code></td>
|
|
3035
|
+
<td><code>Hash</code></td>
|
|
3036
|
+
<td>Yes</td>
|
|
3037
|
+
<td>Transport configuration (must include <code>type</code>)</td>
|
|
3038
|
+
</tr>
|
|
3039
|
+
</tbody>
|
|
3040
|
+
</table>
|
|
3041
|
+
<p><strong>Raises:</strong> <code>ArgumentError</code> if the config is neither a <code>Server</code> nor a <code>Hash</code>.</p>
|
|
3042
|
+
<h2 id="attributes">Attributes<a class="headerlink" href="#attributes" title="Permanent link">¶</a></h2>
|
|
3043
|
+
<h3 id="server">server<a class="headerlink" href="#server" title="Permanent link">¶</a></h3>
|
|
3044
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="n">client</span><span class="o">.</span><span class="n">server</span><span class="w"> </span><span class="c1"># => RobotLab::MCP::Server</span>
|
|
3045
|
+
</span></code></pre></div>
|
|
3046
|
+
<p>The MCP server configuration object.</p>
|
|
3047
|
+
<h3 id="connected">connected?<a class="headerlink" href="#connected" title="Permanent link">¶</a></h3>
|
|
3048
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="n">client</span><span class="o">.</span><span class="n">connected?</span><span class="w"> </span><span class="c1"># => Boolean</span>
|
|
3049
|
+
</span></code></pre></div>
|
|
3050
|
+
<p>Whether the client is currently connected to the server.</p>
|
|
3051
|
+
<h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">¶</a></h2>
|
|
3052
|
+
<h3 id="connect">connect<a class="headerlink" href="#connect" title="Permanent link">¶</a></h3>
|
|
3053
|
+
<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">client</span><span class="o">.</span><span class="n">connect</span><span class="w"> </span><span class="c1"># => self</span>
|
|
3054
|
+
</span></code></pre></div>
|
|
3055
|
+
<p>Establish a connection to the MCP server. Creates the appropriate transport based on the server's transport type, then connects. If already connected, returns immediately.</p>
|
|
3056
|
+
<p>Connection failures are logged as warnings and the client remains in a disconnected state (does not raise).</p>
|
|
3057
|
+
<h3 id="disconnect">disconnect<a class="headerlink" href="#disconnect" title="Permanent link">¶</a></h3>
|
|
3058
|
+
<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">client</span><span class="o">.</span><span class="n">disconnect</span><span class="w"> </span><span class="c1"># => self</span>
|
|
3059
|
+
</span></code></pre></div>
|
|
3060
|
+
<p>Close the connection to the MCP server. Closes the underlying transport and resets connection state. If not connected, returns immediately.</p>
|
|
3061
|
+
<h3 id="list_tools">list_tools<a class="headerlink" href="#list_tools" title="Permanent link">¶</a></h3>
|
|
3062
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="n">client</span><span class="o">.</span><span class="n">list_tools</span><span class="w"> </span><span class="c1"># => Array<Hash></span>
|
|
3063
|
+
</span></code></pre></div>
|
|
3064
|
+
<p>Discover available tools from the server. Returns an array of tool definition hashes.</p>
|
|
3065
|
+
<p><strong>Raises:</strong> <code>MCPError</code> if not connected.</p>
|
|
3066
|
+
<h3 id="call_tool">call_tool<a class="headerlink" href="#call_tool" title="Permanent link">¶</a></h3>
|
|
3067
|
+
<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">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">client</span><span class="o">.</span><span class="n">call_tool</span><span class="p">(</span><span class="nb">name</span><span class="p">,</span><span class="w"> </span><span class="n">arguments</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{})</span>
|
|
3068
|
+
</span></code></pre></div>
|
|
3069
|
+
<p>Execute a tool on the server.</p>
|
|
3070
|
+
<p><strong>Parameters:</strong></p>
|
|
3071
|
+
<table>
|
|
3072
|
+
<thead>
|
|
3073
|
+
<tr>
|
|
3074
|
+
<th>Name</th>
|
|
3075
|
+
<th>Type</th>
|
|
3076
|
+
<th>Description</th>
|
|
3077
|
+
</tr>
|
|
3078
|
+
</thead>
|
|
3079
|
+
<tbody>
|
|
3080
|
+
<tr>
|
|
3081
|
+
<td><code>name</code></td>
|
|
3082
|
+
<td><code>String</code></td>
|
|
3083
|
+
<td>Tool name</td>
|
|
3084
|
+
</tr>
|
|
3085
|
+
<tr>
|
|
3086
|
+
<td><code>arguments</code></td>
|
|
3087
|
+
<td><code>Hash</code></td>
|
|
3088
|
+
<td>Tool arguments (default: <code>{}</code>)</td>
|
|
3089
|
+
</tr>
|
|
3090
|
+
</tbody>
|
|
3091
|
+
</table>
|
|
3092
|
+
<p><strong>Returns:</strong> Tool result content (from the <code>content</code> field of the response).</p>
|
|
3093
|
+
<p><strong>Raises:</strong> <code>MCPError</code> if not connected.</p>
|
|
3094
|
+
<h3 id="list_resources">list_resources<a class="headerlink" href="#list_resources" title="Permanent link">¶</a></h3>
|
|
3095
|
+
<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">client</span><span class="o">.</span><span class="n">list_resources</span><span class="w"> </span><span class="c1"># => Array<Hash></span>
|
|
3096
|
+
</span></code></pre></div>
|
|
3097
|
+
<p>List available resources from the server.</p>
|
|
3098
|
+
<p><strong>Raises:</strong> <code>MCPError</code> if not connected.</p>
|
|
3099
|
+
<h3 id="read_resource">read_resource<a class="headerlink" href="#read_resource" title="Permanent link">¶</a></h3>
|
|
3100
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="n">client</span><span class="o">.</span><span class="n">read_resource</span><span class="p">(</span><span class="n">uri</span><span class="p">)</span><span class="w"> </span><span class="c1"># => Object</span>
|
|
3101
|
+
</span></code></pre></div>
|
|
3102
|
+
<p>Read a resource by URI.</p>
|
|
3103
|
+
<p><strong>Parameters:</strong></p>
|
|
3104
|
+
<table>
|
|
3105
|
+
<thead>
|
|
3106
|
+
<tr>
|
|
3107
|
+
<th>Name</th>
|
|
3108
|
+
<th>Type</th>
|
|
3109
|
+
<th>Description</th>
|
|
3110
|
+
</tr>
|
|
3111
|
+
</thead>
|
|
3112
|
+
<tbody>
|
|
3113
|
+
<tr>
|
|
3114
|
+
<td><code>uri</code></td>
|
|
3115
|
+
<td><code>String</code></td>
|
|
3116
|
+
<td>Resource URI</td>
|
|
3117
|
+
</tr>
|
|
3118
|
+
</tbody>
|
|
3119
|
+
</table>
|
|
3120
|
+
<p><strong>Raises:</strong> <code>MCPError</code> if not connected.</p>
|
|
3121
|
+
<h3 id="list_prompts">list_prompts<a class="headerlink" href="#list_prompts" title="Permanent link">¶</a></h3>
|
|
3122
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="n">client</span><span class="o">.</span><span class="n">list_prompts</span><span class="w"> </span><span class="c1"># => Array<Hash></span>
|
|
3123
|
+
</span></code></pre></div>
|
|
3124
|
+
<p>List available prompts from the server.</p>
|
|
3125
|
+
<p><strong>Raises:</strong> <code>MCPError</code> if not connected.</p>
|
|
3126
|
+
<h3 id="get_prompt">get_prompt<a class="headerlink" href="#get_prompt" title="Permanent link">¶</a></h3>
|
|
3127
|
+
<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">client</span><span class="o">.</span><span class="n">get_prompt</span><span class="p">(</span><span class="nb">name</span><span class="p">,</span><span class="w"> </span><span class="n">arguments</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{})</span><span class="w"> </span><span class="c1"># => Hash</span>
|
|
3128
|
+
</span></code></pre></div>
|
|
3129
|
+
<p>Get a prompt by name with optional arguments.</p>
|
|
3130
|
+
<p><strong>Parameters:</strong></p>
|
|
3131
|
+
<table>
|
|
3132
|
+
<thead>
|
|
3133
|
+
<tr>
|
|
3134
|
+
<th>Name</th>
|
|
3135
|
+
<th>Type</th>
|
|
3136
|
+
<th>Description</th>
|
|
3137
|
+
</tr>
|
|
3138
|
+
</thead>
|
|
3139
|
+
<tbody>
|
|
3140
|
+
<tr>
|
|
3141
|
+
<td><code>name</code></td>
|
|
3142
|
+
<td><code>String</code></td>
|
|
3143
|
+
<td>Prompt name</td>
|
|
3144
|
+
</tr>
|
|
3145
|
+
<tr>
|
|
3146
|
+
<td><code>arguments</code></td>
|
|
3147
|
+
<td><code>Hash</code></td>
|
|
3148
|
+
<td>Prompt arguments (default: <code>{}</code>)</td>
|
|
3149
|
+
</tr>
|
|
3150
|
+
</tbody>
|
|
3151
|
+
</table>
|
|
3152
|
+
<p><strong>Raises:</strong> <code>MCPError</code> if not connected.</p>
|
|
3153
|
+
<h3 id="to_h">to_h<a class="headerlink" href="#to_h" title="Permanent link">¶</a></h3>
|
|
3154
|
+
<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">client</span><span class="o">.</span><span class="n">to_h</span><span class="w"> </span><span class="c1"># => Hash</span>
|
|
3155
|
+
</span></code></pre></div>
|
|
3156
|
+
<p>Converts the client to a hash representation containing server config and connection status.</p>
|
|
3157
|
+
<h2 id="transport-configuration">Transport Configuration<a class="headerlink" href="#transport-configuration" title="Permanent link">¶</a></h2>
|
|
3158
|
+
<p>The transport type is determined by the <code>type</code> key in the transport hash of the <code>Server</code> configuration.</p>
|
|
3159
|
+
<h3 id="stdio">Stdio<a class="headerlink" href="#stdio" title="Permanent link">¶</a></h3>
|
|
3160
|
+
<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">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Client</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
|
3161
|
+
</span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"local"</span><span class="p">,</span>
|
|
3162
|
+
</span><span id="__span-13-3"><a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
3163
|
+
</span><span id="__span-13-4"><a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"stdio"</span><span class="p">,</span>
|
|
3164
|
+
</span><span id="__span-13-5"><a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a><span class="w"> </span><span class="ss">command</span><span class="p">:</span><span class="w"> </span><span class="s2">"npx"</span><span class="p">,</span>
|
|
3165
|
+
</span><span id="__span-13-6"><a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a><span class="w"> </span><span class="ss">args</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="s2">"@modelcontextprotocol/server-filesystem"</span><span class="p">,</span><span class="w"> </span><span class="s2">"/path"</span><span class="o">]</span>
|
|
3166
|
+
</span><span id="__span-13-7"><a id="__codelineno-13-7" name="__codelineno-13-7" href="#__codelineno-13-7"></a><span class="w"> </span><span class="p">}</span>
|
|
3167
|
+
</span><span id="__span-13-8"><a id="__codelineno-13-8" name="__codelineno-13-8" href="#__codelineno-13-8"></a><span class="p">)</span>
|
|
3168
|
+
</span></code></pre></div>
|
|
3169
|
+
<h3 id="websocket">WebSocket<a class="headerlink" href="#websocket" title="Permanent link">¶</a></h3>
|
|
3170
|
+
<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">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Client</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
|
3171
|
+
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"remote"</span><span class="p">,</span>
|
|
3172
|
+
</span><span id="__span-14-3"><a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
3173
|
+
</span><span id="__span-14-4"><a id="__codelineno-14-4" name="__codelineno-14-4" href="#__codelineno-14-4"></a><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"ws"</span><span class="p">,</span>
|
|
3174
|
+
</span><span id="__span-14-5"><a id="__codelineno-14-5" name="__codelineno-14-5" href="#__codelineno-14-5"></a><span class="w"> </span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s2">"wss://mcp.example.com/ws"</span>
|
|
3175
|
+
</span><span id="__span-14-6"><a id="__codelineno-14-6" name="__codelineno-14-6" href="#__codelineno-14-6"></a><span class="w"> </span><span class="p">}</span>
|
|
3176
|
+
</span><span id="__span-14-7"><a id="__codelineno-14-7" name="__codelineno-14-7" href="#__codelineno-14-7"></a><span class="p">)</span>
|
|
3177
|
+
</span></code></pre></div>
|
|
3178
|
+
<h3 id="sse">SSE<a class="headerlink" href="#sse" title="Permanent link">¶</a></h3>
|
|
3179
|
+
<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">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Client</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
|
3180
|
+
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"streaming"</span><span class="p">,</span>
|
|
3181
|
+
</span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
3182
|
+
</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"sse"</span><span class="p">,</span>
|
|
3183
|
+
</span><span id="__span-15-5"><a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a><span class="w"> </span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://mcp.example.com/sse"</span>
|
|
3184
|
+
</span><span id="__span-15-6"><a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a><span class="w"> </span><span class="p">}</span>
|
|
3185
|
+
</span><span id="__span-15-7"><a id="__codelineno-15-7" name="__codelineno-15-7" href="#__codelineno-15-7"></a><span class="p">)</span>
|
|
3186
|
+
</span></code></pre></div>
|
|
3187
|
+
<h3 id="streamable-http">Streamable HTTP<a class="headerlink" href="#streamable-http" title="Permanent link">¶</a></h3>
|
|
3188
|
+
<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">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Client</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
|
3189
|
+
</span><span id="__span-16-2"><a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"http"</span><span class="p">,</span>
|
|
3190
|
+
</span><span id="__span-16-3"><a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
3191
|
+
</span><span id="__span-16-4"><a id="__codelineno-16-4" name="__codelineno-16-4" href="#__codelineno-16-4"></a><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"streamable-http"</span><span class="p">,</span>
|
|
3192
|
+
</span><span id="__span-16-5"><a id="__codelineno-16-5" name="__codelineno-16-5" href="#__codelineno-16-5"></a><span class="w"> </span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s2">"https://mcp.example.com/mcp"</span><span class="p">,</span>
|
|
3193
|
+
</span><span id="__span-16-6"><a id="__codelineno-16-6" name="__codelineno-16-6" href="#__codelineno-16-6"></a><span class="w"> </span><span class="ss">session_id</span><span class="p">:</span><span class="w"> </span><span class="s2">"optional-session-id"</span>
|
|
3194
|
+
</span><span id="__span-16-7"><a id="__codelineno-16-7" name="__codelineno-16-7" href="#__codelineno-16-7"></a><span class="w"> </span><span class="p">}</span>
|
|
3195
|
+
</span><span id="__span-16-8"><a id="__codelineno-16-8" name="__codelineno-16-8" href="#__codelineno-16-8"></a><span class="p">)</span>
|
|
3196
|
+
</span></code></pre></div>
|
|
3197
|
+
<h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">¶</a></h2>
|
|
3198
|
+
<h3 id="basic-usage">Basic Usage<a class="headerlink" href="#basic-usage" title="Permanent link">¶</a></h3>
|
|
3199
|
+
<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">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Client</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
|
3200
|
+
</span><span id="__span-17-2"><a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"github"</span><span class="p">,</span>
|
|
3201
|
+
</span><span id="__span-17-3"><a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"stdio"</span><span class="p">,</span><span class="w"> </span><span class="ss">command</span><span class="p">:</span><span class="w"> </span><span class="s2">"mcp-server-github"</span><span class="w"> </span><span class="p">}</span>
|
|
3202
|
+
</span><span id="__span-17-4"><a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a><span class="p">)</span>
|
|
3203
|
+
</span><span id="__span-17-5"><a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a>
|
|
3204
|
+
</span><span id="__span-17-6"><a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a><span class="n">client</span><span class="o">.</span><span class="n">connect</span>
|
|
3205
|
+
</span><span id="__span-17-7"><a id="__codelineno-17-7" name="__codelineno-17-7" href="#__codelineno-17-7"></a>
|
|
3206
|
+
</span><span id="__span-17-8"><a id="__codelineno-17-8" name="__codelineno-17-8" href="#__codelineno-17-8"></a><span class="c1"># List available tools</span>
|
|
3207
|
+
</span><span id="__span-17-9"><a id="__codelineno-17-9" name="__codelineno-17-9" href="#__codelineno-17-9"></a><span class="n">tools</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">client</span><span class="o">.</span><span class="n">list_tools</span>
|
|
3208
|
+
</span><span id="__span-17-10"><a id="__codelineno-17-10" name="__codelineno-17-10" href="#__codelineno-17-10"></a><span class="n">tools</span><span class="o">.</span><span class="n">each</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">t</span><span class="o">|</span><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">"</span><span class="si">#{</span><span class="n">t</span><span class="o">[</span><span class="ss">:name</span><span class="o">]</span><span class="si">}</span><span class="s2">: </span><span class="si">#{</span><span class="n">t</span><span class="o">[</span><span class="ss">:description</span><span class="o">]</span><span class="si">}</span><span class="s2">"</span><span class="w"> </span><span class="p">}</span>
|
|
3209
|
+
</span><span id="__span-17-11"><a id="__codelineno-17-11" name="__codelineno-17-11" href="#__codelineno-17-11"></a>
|
|
3210
|
+
</span><span id="__span-17-12"><a id="__codelineno-17-12" name="__codelineno-17-12" href="#__codelineno-17-12"></a><span class="c1"># Call a tool</span>
|
|
3211
|
+
</span><span id="__span-17-13"><a id="__codelineno-17-13" name="__codelineno-17-13" href="#__codelineno-17-13"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">client</span><span class="o">.</span><span class="n">call_tool</span><span class="p">(</span><span class="s2">"search_repositories"</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">query</span><span class="p">:</span><span class="w"> </span><span class="s2">"ruby mcp"</span><span class="w"> </span><span class="p">})</span>
|
|
3212
|
+
</span><span id="__span-17-14"><a id="__codelineno-17-14" name="__codelineno-17-14" href="#__codelineno-17-14"></a><span class="nb">puts</span><span class="w"> </span><span class="n">result</span>
|
|
3213
|
+
</span><span id="__span-17-15"><a id="__codelineno-17-15" name="__codelineno-17-15" href="#__codelineno-17-15"></a>
|
|
3214
|
+
</span><span id="__span-17-16"><a id="__codelineno-17-16" name="__codelineno-17-16" href="#__codelineno-17-16"></a><span class="n">client</span><span class="o">.</span><span class="n">disconnect</span>
|
|
3215
|
+
</span></code></pre></div>
|
|
3216
|
+
<h3 id="from-a-server-object">From a Server Object<a class="headerlink" href="#from-a-server-object" title="Permanent link">¶</a></h3>
|
|
3217
|
+
<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">server</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Server</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
|
3218
|
+
</span><span id="__span-18-2"><a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"neon"</span><span class="p">,</span>
|
|
3219
|
+
</span><span id="__span-18-3"><a id="__codelineno-18-3" name="__codelineno-18-3" href="#__codelineno-18-3"></a><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"ws"</span><span class="p">,</span><span class="w"> </span><span class="ss">url</span><span class="p">:</span><span class="w"> </span><span class="s2">"ws://localhost:8080"</span><span class="w"> </span><span class="p">}</span>
|
|
3220
|
+
</span><span id="__span-18-4"><a id="__codelineno-18-4" name="__codelineno-18-4" href="#__codelineno-18-4"></a><span class="p">)</span>
|
|
3221
|
+
</span><span id="__span-18-5"><a id="__codelineno-18-5" name="__codelineno-18-5" href="#__codelineno-18-5"></a>
|
|
3222
|
+
</span><span id="__span-18-6"><a id="__codelineno-18-6" name="__codelineno-18-6" href="#__codelineno-18-6"></a><span class="n">client</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCP</span><span class="o">::</span><span class="no">Client</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="n">server</span><span class="p">)</span>
|
|
3223
|
+
</span><span id="__span-18-7"><a id="__codelineno-18-7" name="__codelineno-18-7" href="#__codelineno-18-7"></a><span class="n">client</span><span class="o">.</span><span class="n">connect</span>
|
|
3224
|
+
</span></code></pre></div>
|
|
3225
|
+
<h3 id="in-a-robot">In a Robot<a class="headerlink" href="#in-a-robot" title="Permanent link">¶</a></h3>
|
|
3226
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Robot</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
|
3227
|
+
</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="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"assistant"</span><span class="p">,</span>
|
|
3228
|
+
</span><span id="__span-19-3"><a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"You help with file operations."</span><span class="p">,</span>
|
|
3229
|
+
</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="ss">mcp</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
|
|
3230
|
+
</span><span id="__span-19-5"><a id="__codelineno-19-5" name="__codelineno-19-5" href="#__codelineno-19-5"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"fs"</span><span class="p">,</span><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"stdio"</span><span class="p">,</span><span class="w"> </span><span class="ss">command</span><span class="p">:</span><span class="w"> </span><span class="s2">"mcp-fs"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">}</span>
|
|
3231
|
+
</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="o">]</span>
|
|
3232
|
+
</span><span id="__span-19-7"><a id="__codelineno-19-7" name="__codelineno-19-7" href="#__codelineno-19-7"></a><span class="p">)</span>
|
|
3233
|
+
</span><span id="__span-19-8"><a id="__codelineno-19-8" name="__codelineno-19-8" href="#__codelineno-19-8"></a>
|
|
3234
|
+
</span><span id="__span-19-9"><a id="__codelineno-19-9" name="__codelineno-19-9" href="#__codelineno-19-9"></a><span class="c1"># MCP tools are automatically discovered and available to the LLM</span>
|
|
3235
|
+
</span><span id="__span-19-10"><a id="__codelineno-19-10" name="__codelineno-19-10" href="#__codelineno-19-10"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"Read the contents of /data/config.yml"</span><span class="p">)</span>
|
|
3236
|
+
</span><span id="__span-19-11"><a id="__codelineno-19-11" name="__codelineno-19-11" href="#__codelineno-19-11"></a><span class="nb">puts</span><span class="w"> </span><span class="n">result</span><span class="o">.</span><span class="n">last_text_content</span>
|
|
3237
|
+
</span></code></pre></div>
|
|
3238
|
+
<h3 id="error-handling">Error Handling<a class="headerlink" href="#error-handling" title="Permanent link">¶</a></h3>
|
|
3239
|
+
<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">begin</span>
|
|
3240
|
+
</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">client</span><span class="o">.</span><span class="n">connect</span>
|
|
3241
|
+
</span><span id="__span-20-3"><a id="__codelineno-20-3" name="__codelineno-20-3" href="#__codelineno-20-3"></a><span class="w"> </span><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">client</span><span class="o">.</span><span class="n">call_tool</span><span class="p">(</span><span class="s2">"unknown_tool"</span><span class="p">,</span><span class="w"> </span><span class="p">{})</span>
|
|
3242
|
+
</span><span id="__span-20-4"><a id="__codelineno-20-4" name="__codelineno-20-4" href="#__codelineno-20-4"></a><span class="k">rescue</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">MCPError</span><span class="w"> </span><span class="o">=></span><span class="w"> </span><span class="n">e</span>
|
|
3243
|
+
</span><span id="__span-20-5"><a id="__codelineno-20-5" name="__codelineno-20-5" href="#__codelineno-20-5"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">"MCP error: </span><span class="si">#{</span><span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="si">}</span><span class="s2">"</span>
|
|
3244
|
+
</span><span id="__span-20-6"><a id="__codelineno-20-6" name="__codelineno-20-6" href="#__codelineno-20-6"></a><span class="k">ensure</span>
|
|
3245
|
+
</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">client</span><span class="o">.</span><span class="n">disconnect</span>
|
|
3246
|
+
</span><span id="__span-20-8"><a id="__codelineno-20-8" name="__codelineno-20-8" href="#__codelineno-20-8"></a><span class="k">end</span>
|
|
3247
|
+
</span></code></pre></div>
|
|
3248
|
+
<h2 id="see-also">See Also<a class="headerlink" href="#see-also" title="Permanent link">¶</a></h2>
|
|
3249
|
+
<ul>
|
|
3250
|
+
<li><a href="../">MCP Overview</a></li>
|
|
3251
|
+
<li><a href="../server/">Server Configuration</a></li>
|
|
3252
|
+
<li><a href="../transports/">Transports</a></li>
|
|
3253
|
+
</ul>
|
|
3254
|
+
|
|
3255
|
+
|
|
3256
|
+
|
|
3257
|
+
|
|
3258
|
+
|
|
3259
|
+
|
|
3260
|
+
|
|
3261
|
+
|
|
3262
|
+
|
|
3263
|
+
|
|
3264
|
+
|
|
3265
|
+
|
|
3266
|
+
|
|
3267
|
+
<form class="md-feedback" name="feedback" hidden>
|
|
3268
|
+
<fieldset>
|
|
3269
|
+
<legend class="md-feedback__title">
|
|
3270
|
+
Was this page helpful?
|
|
3271
|
+
</legend>
|
|
3272
|
+
<div class="md-feedback__inner">
|
|
3273
|
+
<div class="md-feedback__list">
|
|
3274
|
+
|
|
3275
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
|
|
3276
|
+
<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>
|
|
3277
|
+
</button>
|
|
3278
|
+
|
|
3279
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
|
|
3280
|
+
<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>
|
|
3281
|
+
</button>
|
|
3282
|
+
|
|
3283
|
+
</div>
|
|
3284
|
+
<div class="md-feedback__note">
|
|
3285
|
+
|
|
3286
|
+
<div data-md-value="1" hidden>
|
|
3287
|
+
|
|
3288
|
+
|
|
3289
|
+
|
|
3290
|
+
|
|
3291
|
+
|
|
3292
|
+
|
|
3293
|
+
|
|
3294
|
+
|
|
3295
|
+
|
|
3296
|
+
Thanks for your feedback!
|
|
3297
|
+
</div>
|
|
3298
|
+
|
|
3299
|
+
<div data-md-value="0" hidden>
|
|
3300
|
+
|
|
3301
|
+
|
|
3302
|
+
|
|
3303
|
+
|
|
3304
|
+
|
|
3305
|
+
|
|
3306
|
+
|
|
3307
|
+
|
|
3308
|
+
|
|
3309
|
+
Thanks for your feedback! Help us improve by creating an issue.
|
|
3310
|
+
</div>
|
|
3311
|
+
|
|
3312
|
+
</div>
|
|
3313
|
+
</div>
|
|
3314
|
+
</fieldset>
|
|
3315
|
+
</form>
|
|
3316
|
+
|
|
3317
|
+
|
|
3318
|
+
|
|
3319
|
+
</article>
|
|
3320
|
+
</div>
|
|
3321
|
+
|
|
3322
|
+
|
|
3323
|
+
<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>
|
|
3324
|
+
|
|
3325
|
+
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
3326
|
+
</div>
|
|
3327
|
+
|
|
3328
|
+
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
|
3329
|
+
|
|
3330
|
+
<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>
|
|
3331
|
+
Back to top
|
|
3332
|
+
</button>
|
|
3333
|
+
|
|
3334
|
+
</main>
|
|
3335
|
+
|
|
3336
|
+
<footer class="md-footer">
|
|
3337
|
+
|
|
3338
|
+
|
|
3339
|
+
|
|
3340
|
+
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
|
3341
|
+
|
|
3342
|
+
|
|
3343
|
+
<a href="../" class="md-footer__link md-footer__link--prev" aria-label="Previous: MCP (Model Context Protocol)">
|
|
3344
|
+
<div class="md-footer__button md-icon">
|
|
3345
|
+
|
|
3346
|
+
<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>
|
|
3347
|
+
</div>
|
|
3348
|
+
<div class="md-footer__title">
|
|
3349
|
+
<span class="md-footer__direction">
|
|
3350
|
+
Previous
|
|
3351
|
+
</span>
|
|
3352
|
+
<div class="md-ellipsis">
|
|
3353
|
+
MCP (Model Context Protocol)
|
|
3354
|
+
</div>
|
|
3355
|
+
</div>
|
|
3356
|
+
</a>
|
|
3357
|
+
|
|
3358
|
+
|
|
3359
|
+
|
|
3360
|
+
<a href="../server/" class="md-footer__link md-footer__link--next" aria-label="Next: Server">
|
|
3361
|
+
<div class="md-footer__title">
|
|
3362
|
+
<span class="md-footer__direction">
|
|
3363
|
+
Next
|
|
3364
|
+
</span>
|
|
3365
|
+
<div class="md-ellipsis">
|
|
3366
|
+
Server
|
|
3367
|
+
</div>
|
|
3368
|
+
</div>
|
|
3369
|
+
<div class="md-footer__button md-icon">
|
|
3370
|
+
|
|
3371
|
+
<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>
|
|
3372
|
+
</div>
|
|
3373
|
+
</a>
|
|
3374
|
+
|
|
3375
|
+
</nav>
|
|
3376
|
+
|
|
3377
|
+
|
|
3378
|
+
<div class="md-footer-meta md-typeset">
|
|
3379
|
+
<div class="md-footer-meta__inner md-grid">
|
|
3380
|
+
<div class="md-copyright">
|
|
3381
|
+
|
|
3382
|
+
<div class="md-copyright__highlight">
|
|
3383
|
+
Copyright © 2025 Dewayne VanHoozer
|
|
3384
|
+
</div>
|
|
3385
|
+
|
|
3386
|
+
|
|
3387
|
+
Made with
|
|
3388
|
+
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
3389
|
+
Material for MkDocs
|
|
3390
|
+
</a>
|
|
3391
|
+
|
|
3392
|
+
</div>
|
|
3393
|
+
|
|
3394
|
+
|
|
3395
|
+
<div class="md-social">
|
|
3396
|
+
|
|
3397
|
+
|
|
3398
|
+
|
|
3399
|
+
|
|
3400
|
+
|
|
3401
|
+
<a href="https://github.com/madbomber/robot_lab" target="_blank" rel="noopener" title="RobotLab on GitHub" class="md-social__link">
|
|
3402
|
+
<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>
|
|
3403
|
+
</a>
|
|
3404
|
+
|
|
3405
|
+
|
|
3406
|
+
|
|
3407
|
+
|
|
3408
|
+
|
|
3409
|
+
<a href="https://rubygems.org/gems/robot_lab" target="_blank" rel="noopener" title="RobotLab on RubyGems" class="md-social__link">
|
|
3410
|
+
<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>
|
|
3411
|
+
</a>
|
|
3412
|
+
|
|
3413
|
+
</div>
|
|
3414
|
+
|
|
3415
|
+
</div>
|
|
3416
|
+
</div>
|
|
3417
|
+
</footer>
|
|
3418
|
+
|
|
3419
|
+
</div>
|
|
3420
|
+
<div class="md-dialog" data-md-component="dialog">
|
|
3421
|
+
<div class="md-dialog__inner md-typeset"></div>
|
|
3422
|
+
</div>
|
|
3423
|
+
|
|
3424
|
+
|
|
3425
|
+
|
|
3426
|
+
|
|
3427
|
+
|
|
3428
|
+
<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>
|
|
3429
|
+
|
|
3430
|
+
|
|
3431
|
+
<script src="../../../assets/javascripts/bundle.79ae519e.min.js"></script>
|
|
3432
|
+
|
|
3433
|
+
|
|
3434
|
+
</body>
|
|
3435
|
+
</html>
|