@ray-js/robot-map-sdk 0.0.17-beta.1 → 0.0.17-beta.3
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.
- package/bin/mcp-server.js +31 -15
- package/dist/constant/methods.js +1 -1
- package/dist/index.d.ts +164 -23
- package/dist/index.rjs.js +1 -1
- package/dist-app/assets/index-BVLfQBTu.js +1 -0
- package/dist-app/index.html +1 -1
- package/dist-docs/404.html +2 -2
- package/dist-docs/assets/{app.tuTOhCpg.js → app.C3BeeaYd.js} +1 -1
- package/dist-docs/assets/chunks/@localSearchIndexroot.BMKcHG_i.js +1 -0
- package/dist-docs/assets/chunks/{BitmapFont.Bn4Xj5K-.js → BitmapFont.BQzmxL0v.js} +1 -1
- package/dist-docs/assets/chunks/{BufferResource.DTCsTJzt.js → BufferResource.CNdzQT3n.js} +1 -1
- package/dist-docs/assets/chunks/{CanvasRenderer.DflYBGLD.js → CanvasRenderer.BfEovjEl.js} +1 -1
- package/dist-docs/assets/chunks/{RenderTargetSystem.DBrMOqFS.js → RenderTargetSystem.BsnW3px2.js} +1 -1
- package/dist-docs/assets/chunks/{VPLocalSearchBox.D4ShZjav.js → VPLocalSearchBox.BV6OAhiI.js} +1 -1
- package/dist-docs/assets/chunks/{WebGLRenderer.CmlR6hDG.js → WebGLRenderer.BziWi5pK.js} +1 -1
- package/dist-docs/assets/chunks/{WebGPURenderer.C7Xo_Nj6.js → WebGPURenderer.bELKl5QM.js} +1 -1
- package/dist-docs/assets/chunks/{browserAll.CIjY9VGZ.js → browserAll.Cbwmm72I.js} +1 -1
- package/dist-docs/assets/chunks/index.CsLbOa5r.js +744 -0
- package/dist-docs/assets/chunks/theme.BItp-bTH.js +4 -0
- package/dist-docs/assets/chunks/{webworkerAll.rjNztTjs.js → webworkerAll.BqQ8oBVT.js} +1 -1
- package/dist-docs/assets/{guide_advanced-usage.md.dxD8u9v3.js → guide_advanced-usage.md.BsGRhEuG.js} +12 -9
- package/dist-docs/assets/{guide_advanced-usage.md.dxD8u9v3.lean.js → guide_advanced-usage.md.BsGRhEuG.lean.js} +1 -1
- package/dist-docs/assets/{guide_getting-started.md.DcbNPHUc.js → guide_getting-started.md.DQIIL6ql.js} +1 -1
- package/dist-docs/assets/guide_mcp.md.BYlNOxMG.js +1 -0
- package/dist-docs/assets/{guide_mcp.md.CabCiX8Z.lean.js → guide_mcp.md.BYlNOxMG.lean.js} +1 -1
- package/dist-docs/assets/{reference_config.md.DpjGhNQS.js → reference_config.md.BslTlkKM.js} +3 -3
- package/dist-docs/assets/{reference_config.md.DpjGhNQS.lean.js → reference_config.md.BslTlkKM.lean.js} +1 -1
- package/dist-docs/assets/{reference_data.md.DL6rfzez.js → reference_data.md.jnSR7326.js} +8 -7
- package/dist-docs/assets/{reference_data.md.DL6rfzez.lean.js → reference_data.md.jnSR7326.lean.js} +1 -1
- package/dist-docs/assets/{reference_methods.md.yWEfqPKf.js → reference_methods.md.Cv8q9vtz.js} +8 -3
- package/dist-docs/assets/{reference_methods.md.yWEfqPKf.lean.js → reference_methods.md.Cv8q9vtz.lean.js} +1 -1
- package/dist-docs/assets/{reference_runtime.md.CE2QTAiD.js → reference_runtime.md.BFQ83m1B.js} +2 -2
- package/dist-docs/assets/{reference_runtime.md.CE2QTAiD.lean.js → reference_runtime.md.BFQ83m1B.lean.js} +1 -1
- package/dist-docs/assets/{reference_types.md.ZQU03iAA.js → reference_types.md.ifmL7IbS.js} +11 -10
- package/dist-docs/assets/{reference_types.md.ZQU03iAA.lean.js → reference_types.md.ifmL7IbS.lean.js} +1 -1
- package/dist-docs/guide/advanced-usage.html +15 -12
- package/dist-docs/guide/concepts.html +3 -3
- package/dist-docs/guide/getting-started.html +5 -5
- package/dist-docs/guide/mcp.html +5 -5
- package/dist-docs/guide/spot-room-binding.html +3 -3
- package/dist-docs/hashmap.json +1 -1
- package/dist-docs/index.html +3 -3
- package/dist-docs/plans/2026-03-04-detected-objects-visibility-design.html +3 -3
- package/dist-docs/plans/2026-03-04-show-detected-objects-implementation-plan.html +3 -3
- package/dist-docs/plans/2026-03-10-simulator-debug-design.html +3 -3
- package/dist-docs/plans/2026-03-10-simulator-events-console-design.html +3 -3
- package/dist-docs/plans/2026-03-10-simulator-events-console-implementation-plan.html +3 -3
- package/dist-docs/plans/2026-03-10-simulator-runtime-controls-design.html +3 -3
- package/dist-docs/plans/2026-03-10-simulator-runtime-controls-implementation-plan.html +3 -3
- package/dist-docs/plans/2026-03-10-testing-rollout-next-steps-plan.html +3 -3
- package/dist-docs/plans/2026-03-11-simulator-logger-dump-implementation-plan.html +3 -3
- package/dist-docs/reference/callbacks.html +3 -3
- package/dist-docs/reference/config.html +6 -6
- package/dist-docs/reference/data.html +11 -10
- package/dist-docs/reference/methods.html +11 -6
- package/dist-docs/reference/runtime.html +5 -5
- package/dist-docs/reference/types.html +14 -13
- package/dist-docs/reference/utils.html +3 -3
- package/dist-docs/simulator/index.html +3 -3
- package/package.json +1 -1
- package/dist-app/assets/index-BhBznOX2.js +0 -1
- package/dist-docs/adr/0001-threshold-mirrors-virtual-wall.html +0 -25
- package/dist-docs/adr/0002-threshold-edit-surface-quad-family.html +0 -25
- package/dist-docs/agents/domain.html +0 -39
- package/dist-docs/agents/issue-tracker.html +0 -25
- package/dist-docs/agents/triage-labels.html +0 -25
- package/dist-docs/assets/adr_0001-threshold-mirrors-virtual-wall.md.BGtyf9GS.js +0 -1
- package/dist-docs/assets/adr_0001-threshold-mirrors-virtual-wall.md.BGtyf9GS.lean.js +0 -1
- package/dist-docs/assets/adr_0002-threshold-edit-surface-quad-family.md.BlvHYJT5.js +0 -1
- package/dist-docs/assets/adr_0002-threshold-edit-surface-quad-family.md.BlvHYJT5.lean.js +0 -1
- package/dist-docs/assets/agents_domain.md.CYB9yWEy.js +0 -15
- package/dist-docs/assets/agents_domain.md.CYB9yWEy.lean.js +0 -1
- package/dist-docs/assets/agents_issue-tracker.md.CrjzmXmc.js +0 -1
- package/dist-docs/assets/agents_issue-tracker.md.CrjzmXmc.lean.js +0 -1
- package/dist-docs/assets/agents_triage-labels.md.Cmw0b5xB.js +0 -1
- package/dist-docs/assets/agents_triage-labels.md.Cmw0b5xB.lean.js +0 -1
- package/dist-docs/assets/chunks/@localSearchIndexroot.7eWxrBA2.js +0 -1
- package/dist-docs/assets/chunks/index.BCZVCQiT.js +0 -744
- package/dist-docs/assets/chunks/theme.BwMYfKet.js +0 -4
- package/dist-docs/assets/guide_mcp.md.CabCiX8Z.js +0 -1
- /package/dist-docs/assets/{guide_getting-started.md.DcbNPHUc.lean.js → guide_getting-started.md.DQIIL6ql.lean.js} +0 -0
|
@@ -1 +0,0 @@
|
|
|
1
|
-
import{_ as e,c as t,o as i,aq as s}from"./chunks/framework.CBLqO2Q1.js";const u=JSON.parse('{"title":"MCP","description":"","frontmatter":{},"headers":[],"relativePath":"guide/mcp.md","filePath":"guide/mcp.md","lastUpdated":1770722482000}'),o={name:"guide/mcp.md"};function l(r,a,n,d,h,p){return i(),t("div",null,[...a[0]||(a[0]=[s('<h1 id="mcp" tabindex="-1">MCP <a class="header-anchor" href="#mcp" aria-label="Permalink to "MCP""></a></h1><p>为 AI 助手集成地图分析工具。</p><h2 id="安装-installation" tabindex="-1">安装 (Installation) <a class="header-anchor" href="#安装-installation" aria-label="Permalink to "安装 (Installation)""></a></h2><h3 id="cursor-一键安装" tabindex="-1">Cursor (一键安装) <a class="header-anchor" href="#cursor-一键安装" aria-label="Permalink to "Cursor (一键安装)""></a></h3><p>Cursor 用户可以通过点击下方按钮直接安装 MCP 服务:</p><p><a href="https://cursor.com/cn/install-mcp?name=ray-robot-map-mcp&config=eyJjb21tYW5kIjoibnB4IC15IC1wIEByYXktanMvcm9ib3QtbWFwLXNkayByb2JvdC1tYXAtYW5hbHl6ZXIifQ%3D%3D" target="_blank" rel="noreferrer"><img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="安装 MCP 服务"></a></p><h3 id="claude-code" tabindex="-1">Claude Code <a class="header-anchor" href="#claude-code" aria-label="Permalink to "Claude Code""></a></h3><p>要在 Claude Code 中添加此服务,请使用 <code>mcp add</code> 指令。建议显式指定 <code>stdio</code> 传输模式:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">claude</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> mcp</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> add</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --transport</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> stdio</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> ray-robot-map-analyzer</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> npx</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -y</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -p</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> @ray-js/robot-map-sdk@latest</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> robot-map-analyzer</span></span></code></pre></div><div class="tip custom-block"><p class="custom-block-title">提示</p><p>如果您希望在所有项目中都能使用该工具(不仅限于当前目录),可以添加 <code>--scope user</code> 参数。</p></div><h3 id="antigravity" tabindex="-1">Antigravity <a class="header-anchor" href="#antigravity" aria-label="Permalink to "Antigravity""></a></h3><p>对于 Antigravity 用户,请使用 <code>--add-mcp</code> 指令并传入 JSON 配置:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">antigravity</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> --add-mcp</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '{"name": "ray-robot-map-analyzer", "command": "npx", "args": ["-y", "-p", "@ray-js/robot-map-sdk@latest", "robot-map-analyzer"]}'</span></span></code></pre></div><h3 id="环境要求" tabindex="-1">环境要求 <a class="header-anchor" href="#环境要求" aria-label="Permalink to "环境要求""></a></h3><ul><li>Node.js >= 16</li><li>网络连接(用于通过 npx 实时获取最新版 npm 包)</li></ul><h2 id="使用-usage" tabindex="-1">使用 (Usage) <a class="header-anchor" href="#使用-usage" aria-label="Permalink to "使用 (Usage)""></a></h2><h3 id="最佳实践-best-practices" tabindex="-1">最佳实践 (Best Practices) <a class="header-anchor" href="#最佳实践-best-practices" aria-label="Permalink to "最佳实践 (Best Practices)""></a></h3><p>为了获得最稳定的分析体验,建议遵循以下交互模式:</p><h4 id="_1-优先使用文件引用-推荐" tabindex="-1">1. 优先使用文件引用 (推荐) <a class="header-anchor" href="#_1-优先使用文件引用-推荐" aria-label="Permalink to "1. 优先使用文件引用 (推荐)""></a></h4><p>当您需要分析复杂的地图或长路径时,<strong>不要直接粘贴 Hex 字符串</strong>。请先将数据存为本地文件,然后在提问时提及该文件。</p><p><strong>操作示例:</strong></p><ol><li>在终端运行:<code>pbpaste > map.hex</code> (将剪贴板内容存入文件)</li><li>向 AI 提问:<em>“请分析一下当前目录下 <code>map.hex</code> 这个文件的地图概况。”</em></li></ol><p>AI 会识别到路径并自动调用工具的 <code>path</code> 参数进行处理,这样可以完全避免因 Hex 字符串过长导致的对话中断。</p><h4 id="_2-常见提问示例" tabindex="-1">2. 常见提问示例 <a class="header-anchor" href="#_2-常见提问示例" aria-label="Permalink to "2. 常见提问示例""></a></h4><p>您可以尝试以下提问方式:</p><ul><li><em>“帮我分析一下 <code>map.hex</code> 的概要信息。”</em></li><li><em>“结合 <code>map.hex</code> 和 <code>path.hex</code>,告诉我机器人现在在哪个房间?离充电桩有多远?”</em></li><li><em>“这个地图里有多少个房间?分布状况如何?”</em></li><li><em>“为什么 <code>map.hex</code> 右上角的障碍物有交错重叠的现象?”</em></li><li><em>“分析一下 <code>path.hex</code> 里的清扫路径轨迹。”</em></li></ul><h3 id="大数据处理指引" tabindex="-1">大数据处理指引 <a class="header-anchor" href="#大数据处理指引" aria-label="Permalink to "大数据处理指引""></a></h3><p>由于扫地机地图和路径数据(Hex)通常非常庞大,直接在聊天框中粘贴大数据可能导致 AI 响应中断或 Token 溢出。</p><ol><li><strong>存为文件</strong>:建议将 Hex 数据保存为本地文件(如 <code>map.hex</code> 或 <code>path.hex</code>)。</li><li><strong>文件分析</strong>:直接告知 AI 文件绝对路径,它将优先使用工具的 <code>path</code> 参数进行静默读取分析。</li><li><strong>支持 Hex</strong>:对于较小的数据(如 DP 命令),仍可直接粘贴进行分析。</li></ol>',29)])])}const k=e(o,[["render",l]]);export{u as __pageData,k as default};
|
|
File without changes
|