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