Z Tag

让 AI Agent 读取本手册

用只读 MCP、单页 Markdown 或 llms.txt 读取本手册;手册按 IM 平台分开,地址结构见本页。

适用于对接 Z Tag 的系统开发者

本页写给用 MCP、IDE 或其他 AI 工具读取本手册的人。网页和下面几种接口读到的是同一份内容。想在聊天里直接问 ZAI 产品用法,见直接问 ZAI。

地址结构

手册按 IM 平台分成飞书版和 Slack 版。同一主题在两个版本里的路径相同,只是平台段不同。下表的 <手册地址> 是手册的公开地址,例如 https://<手册域名>/docs;手册挂在其他网站的某个路径下时,这段路径也在其中,下文的地址都从它算起:

地址内容
<手册地址>手册首页,介绍两个版本
<手册地址>/feishu、<手册地址>/slack两个版本的首页
<手册地址>/feishu/<路径>、<手册地址>/slack/<路径>两个版本中的同一页

两个版本里同一路径的内容可能不同,例如命令写法和界面说法。只关心一个平台时,只读那个版本;页面里的站内链接带当前的平台段,顺着链接读会留在同一个版本,只有少数专门讲另一个平台的链接会明确指向那个版本。不带平台段的地址没有对应的页面。

单页 Markdown

在页面地址后加 .md 即可读取这一页的 Markdown 正文,例如 <手册地址>/feishu/capabilities/scopes.md。请求网页地址时,在 Accept 请求头里优先声明 text/markdown,也能拿到同样的内容。

每页 Markdown 以这样的头部开始:

# <标题>

<!-- ztag-manual {"url":"<网页路径>","platforms":["<平台键>"]} -->

> <描述>
> <适用读者>
> 适用平台:<平台名>
> 网页:<网页路径>

标题下的注释供程序读取,是一行 JSON:url 是这一页的网页路径,从域名之后算起,包含手册地址里的路径,引用时拼上手册的协议和域名即可;platforms 是这份正文所属版本的平台键(feishu 或 slack)。下面几行是给人看的同样信息,「适用平台」写平台名,「网页」与 url 相同。程序请读注释,不要按这几行的中文文字解析。正文中的站内链接同样是带平台段的网页路径。

llms.txt

地址内容
<手册地址>/llms.txt页面索引,飞书版与 Slack 版分节列出
<手册地址>/llms-full.txt整本手册的正文,两个版本分节拼接
<手册地址>/llms/feishu.txt、<手册地址>/llms/slack.txt只含一个版本的页面索引
<手册地址>/llms/feishu-full.txt、<手册地址>/llms/slack-full.txt只含一个版本的整本正文

整本正文里每一页都以单页 Markdown 那样的头部开始,可以按标题下的注释分页;代码块里的示例头部不是一页,分页时跳过代码块。只关心一个平台时用 <手册地址>/llms/<平台>.txt。整本正文会随内容增长,不适合作为每次任务的默认上下文,按需读取单页更合适。

只读 MCP

把下面配置中的 <手册地址> 替换为手册的公开地址,再加入 MCP 客户端配置:

{
  "mcpServers": {
    "z-tag-manual": {
      "url": "<手册地址>/api/mcp"
    }
  }
}

服务只提供三个文档工具。它不连接 Z Tag 控制台,不读取组织数据,也不能写入文档、操作资源或执行命令。

工具用途
list_pages浏览页面目录和网页地址
search按问题检索相关标题、段落和页面;可选参数 platform(feishu 或 slack)只检索一个版本。另有可选参数 locale,手册只有简体中文,传不传结果相同
get_page按网页地址读取一页的 Markdown 正文,返回内容与在该地址后加 .md 相同

推荐先用 search 检索(知道读者在哪个平台时带上 platform),再用 get_page 读取少量最相关的页面。回答时保留页面标题和网页地址;找不到时说明已经检查的范围,不要根据产品名称猜测行为。

内容边界

  • 手册只有简体中文,语言标识为 zh-Hans。在聊天里用其他语言问 ZAI 时,ZAI 会读中文手册,再按你要求或设置的回复语言作答,产品名称保持原样。
  • 手册讲怎样使用产品,不包含内部架构、运行环境地址、真实资源标识或凭证。
  • 组织当前有哪些资源、授权和设置,以控制台为准,不要从手册推断。打开控制台的方法见在控制台管理自己的资源。

本页目录