mcpField
A
AGILEX Docs

AGILEX Docs

远程服务
service.agilex.ai开发工具01 周前更新

关于 AGILEX Docs

AGILEX Docs 是只读 MCP 服务,用于搜索和读取 AgileX Robotics 的官方手册、协议参考、固件说明、SDK 文章及常见问题,帮助开发者在集成硬件时查阅资料。

主要功能

  1. 01全文搜索文档
  2. 02分页读取 Markdown 页面
  3. 03列出公开文档空间
  4. 04提供原始文档链接

适用场景

  1. 01集成前核对 CAN 帧格式
  2. 02查找产品手册和固件说明
  3. 03查询底盘故障排查步骤

MCP 相关

通过 Streamable HTTP 提供 search_docs、get_doc、list_docs 和 list_spaces 四种只读工具。MCP 客户端可查询 AgileX 公开文档并访问原始页面链接。

配置

远程服务无需本地安装。选择你使用的客户端,复制配置或使用一键安装。

服务地址https://service.agilex.ai/agilex-docs/mcp
一键复制安装命令
Claude CodeTerminal
Cursor.cursor/mcp.json
VS Code.vscode/mcp.json
Claude Desktopclaude_desktop_config.json
Windsurf~/.codeium/windsurf/mcp_config.json

命令在终端中运行;JSON 粘贴到对应客户端的 MCP 配置后重启。需要授权的服务会在首次连接时提示登录。

工具

详细介绍

AGILEX Docs MCP

MCP Registry License Auth

AgileX Robotics(松灵机器人) 官方产品文档——包括 piper、pika、 nero、ranger、limo、scout、bunker、hunter、tracer、 umr、cobot_magic 和 aloha 的用户手册、CAN 2.0B 协议参考、固件说明、 SDK 技术文章和售后常见问题。

在为 AgileX 硬件编写集成代码之前,请让 AI 编码助手连接此服务,以便它参考 真实手册,而不是猜测波特率、帧格式或引脚定义。

此代码库是公开的服务契约,而非实现。 它记录了端点、工具签名以及每种客户端配置。 索引服务本身不公开,和 Cloudflare、Sentry 与 Linear 发布其远程 MCP 服务的方式一样。


端点

MCP URLhttps://service.agilex.ai/agilex-docs/mcp
传输方式Streamable HTTP — 单一端点,无状态
协议2025-11-25(也支持 2025-06-18、2025-03-26、2024-11-05)
身份验证无。只读公共文档,按 IP 限流
注册表ai.agilex.service/docs
文档页面https://service.agilex.ai/agilex-docs/
运行状况https://service.agilex.ai/agilex-docs/health

无需 API 密钥、OAuth 或本地进程。只要你的客户端支持 Streamable HTTP, 就只需要这个 URL。


快速开始

# Claude Code
claude mcp add --transport http agilex-docs https://service.agilex.ai/agilex-docs/mcp

# Codex CLI  (writes ~/.codex/config.toml)
codex mcp add agilex-docs --url https://service.agilex.ai/agilex-docs/mcp

Cursor — 一键配置:

cursor://anysphere.cursor-deeplink/mcp/install?name=agilex-docs&config=eyJ1cmwiOiJodHRwczovL3NlcnZpY2UuYWdpbGV4LmFpL2FnaWxleC1kb2NzL21jcCJ9

任何可读取 mcpServers 的客户端(Claude Desktop、Cline、Windsurf、Cherry Studio、 Continue、Zed、LibreChat、Dify 等):

{
  "mcpServers": {
    "agilex-docs": {
      "url": "https://service.agilex.ai/agilex-docs/mcp"
    }
  }
}

各客户端的完整配置说明:docs/CLIENTS.md。


工具

提供四种只读工具。工具名称特意采用 verb_noun 格式,让模型无需先阅读架构即可 选择合适的工具。

工具用途参数
search_docs全文搜索。从这里开始。 先定位,再阅读。query(包含产品名称)、limit(1–25,默认 8)、space(可选)
get_doc以 Markdown 格式分页读取单个页面doc_id、max_chars(默认 20 000,最大 120 000)、offset
list_docs单个空间的目录space(可选)、limit(1–300,默认 50)、offset
list_spaces所有公开空间及其页面数—

search_docs 会返回 doc_id、title、space、url、score、chars 和 片段。将 doc_id 传入 get_doc。如果响应中包含 truncated: true, 请使用 next_offset 再次调用 get_doc。

响应格式
// search_docs("piper CAN 波特率")
{
  "query": "piper CAN 波特率",
  "count": 3,
  "results": [
    {
      "doc_id": "01a06659-2d4e-7029-bc64-63f9352b34a6",
      "title": "PIPER X 用户手册(CN)",
      "space": "AGX-机械臂产品手册",
      "url": "https://kb.agilex.ai/s/agx-robot-arm-products-cn-en/p/pWVjLJsYc0",
      "score": 18.42,
      "chars": 13264,
      "snippet": "...CAN通信标准采用的是CAN2.0B标准,通讯波特率为1000K..."
    }
  ]
}
// get_doc(doc_id="01a06659-…", max_chars=2000)
{
  "doc_id": "01a06659-2d4e-7029-bc64-63f9352b34a6",
  "title": "PIPER X 用户手册(CN)",
  "url": "https://kb.agilex.ai/s/agx-robot-arm-products-cn-en/p/pWVjLJsYc0",
  "chars": 13264,
  "offset": 0,
  "truncated": true,
  "next_offset": 2000,
  "content": "..."
}

url 始终指向原始 Docmost 页面——请引用该链接,以便用户核实。


客户端配置

Cursor

项目中的 .cursor/mcp.json,或全局配置 ~/.cursor/mcp.json:

{
  "mcpServers": {
    "agilex-docs": {
      "url": "https://service.agilex.ai/agilex-docs/mcp"
    }
  }
}

重新加载窗口(Ctrl+Shift+P → Reload Window)。Settings → MCP 中应显示包含 4 个工具的 agilex-docs。

Claude Code
# all projects
claude mcp add --transport http agilex-docs https://service.agilex.ai/agilex-docs/mcp

# this project only (writes .mcp.json, can be committed)
claude mcp add --scope project --transport http agilex-docs https://service.agilex.ai/agilex-docs/mcp

claude mcp list
Codex CLI
codex mcp add agilex-docs --url https://service.agilex.ai/agilex-docs/mcp

或在 ~/.codex/config.toml 中配置:

[mcp_servers.agilex-docs]
url = "https://service.agilex.ai/agilex-docs/mcp"

在 Codex 中,/mcp 会列出活动服务。Codex 会将服务的 instructions 字段用作全局指导,因此已内置先搜索再读取的工作流。

DeepSeek Harness (DSH)

DSH 通过 @deepseek-ai/dsh-mcp-client 连接,并配置为 Cordis overlay:

- insert:
    - id: agilex-docs
      name: '@deepseek-ai/dsh-mcp-client'
      config:
        serverName: agilex-docs
        transport: streamable-http
        url: https://service.agilex.ai/agilex-docs/mcp
dsh web --patch "$PWD/examples/agilex-docs.cordis.yml"

工具会显示为 mcp__agilex-docs__search_docs。

Claude Desktop (stdio bridge)
{
  "mcpServers": {
    "agilex-docs": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://service.agilex.ai/agilex-docs/mcp"]
    }
  }
}

保存后,请完全退出并重新打开应用。

VS Code / Copilot

.vscode/mcp.json — 注意,此处顶层键为 servers,而非 mcpServers:

{
  "servers": {
    "agilex-docs": {
      "type": "http",
      "url": "https://service.agilex.ai/agilex-docs/mcp"
    }
  }
}

或者按 Ctrl+Shift+P → MCP: Add Server → HTTP → 粘贴 URL。

Cherry Studio

Settings → MCP Servers → Add → 输入 streamableHttp,URL 使用上述地址。 Cherry Studio 也接受直接填写 mcpServers JSON。

ChatGPT custom connector

仅限付费方案和网页版:Settings → Connectors → Advanced → 启用 Developer mode → Create → 填入上述 URL,身份验证选择 No authentication。


示例提示词

我需要为 piper 机械臂编写 CAN 控制脚本。首先调用 search_docs 搜索 “piper CAN 报文”,然后对最佳结果调用 get_doc,并根据手册中的 帧格式和波特率编写代码。在注释中引用手册 URL。

我们的 ranger mini 出现底盘错误码。请搜索售后 FAQ 中的 错误码,引用故障排查步骤并附上页面链接。

由于服务包含一个 instructions 区块,指示模型先搜索并引用 URL,因此通常无需额外提示即可完成工作流。


范围与数据

语料库由标记为 「互联网所有人可访问」 的 Docmost 空间构建,这些内容已在 https://kb.agilex.ai 上公开。标记为 内部 / 非对外 的空间无法访问: 爬虫只使用 Docmost 的匿名分享端点,从不进行身份验证,因此即使发生错误,内部内容也不会泄露。

页面346
空间26
字符数~3.0 M
刷新每日 05:20 Asia/Shanghai
语言中文和英文

新的公开空间会自动纳入;撤销分享的内容会在下一次同步时移除。


速率限制

范围限制
每个 IP,每分钟60 个请求
每个 IP,每天3 000 个请求
超出限制HTTP 429 + Retry-After

如需更高配额或专用端点,请联系 AgileX(参见反馈)。


限制

  • 只读。 不提供写入工具;此处的任何内容都无法移动机器人。
  • 图片不会内嵌。 Docmost 会为附件 URL 签发较短的有效期,因此快照中会留下失效链接。图片显示为 (图:caption);打开页面的 url 即可查看。
  • 公开空间中的二进制附件(PDF/XLSX)不会解析 — 仅处理页面正文。
  • 词法匹配,而非语义匹配。使用 BM25 + CJK 二元组。若未匹配到某个词,请换种说法。
  • 每次查询一个产品系列效果最佳;跨产品问题需要 多次搜索。

验证是否正常

# health
curl -s https://service.agilex.ai/agilex-docs/health | jq

# MCP handshake
curl -s -X POST https://service.agilex.ai/agilex-docs/mcp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json, text/event-stream' \
  -d '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-06-18","capabilities":{},"clientInfo":{"name":"curl","version":"1"}}}' | jq

# full round trip (initialize → tools/list → tools/call)
./scripts/smoke-test.sh

仓库结构

README.md                    this file
server.json                  official MCP Registry manifest
LICENSE                      MIT (documentation + manifest)
docs/CLIENTS.md              per-client setup, long form
examples/                    copy-paste configs per client
scripts/smoke-test.sh        end-to-end check against the live endpoint

反馈

文档缺失或有误 → 通过 https://www.agilex.ai/ 联系 AgileX 支持,并附上页面 URL。

关于此仓库的问题(清单、文档、客户端配置)→ 在此处提交 issue。 关于文档内容的问题 → 联系支持渠道,因为文档存放在 内部知识库中,此仓库无法编辑这些内容。


许可证

MIT — 详见 LICENSE。此许可证适用于本仓库中的文档和清单。通过 MCP 提供的文档内容仍归 AgileX Robotics 所有。

评论

支持 Markdown

第一次接触 MCP?

从协议是什么,到在客户端里装上第一个服务,这几条回答覆盖了大多数入门问题。

一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。