跳转至

尚无译文的页面会以英语打开,并标注为英语。

本页由机器从英文原文翻译,内容以英文原文为准。 Machine-translated from the English page, which is authoritative.

help 操作

每个 help.* 操作接受和返回的确切字段。

每个操作都是通过 HTTP 的 POST /v1/<op>,也是 MCP 工具 loom_<op>。身份字段(org、namespace、agent、user_id、session_id)会在传输层能够提供时,由令牌和 MCP 会话自动填入;对于单用户服务器上不带令牌的 HTTP 调用,除 code.* 和 tracker.*(它们沿用各自平面的 org)之外的所有操作都使用该安装的 org,而在部分操作上还会填入其命名空间和 agent;参见身份与命名空间。操作索引说明了角色、类型以及 MCP 的 all 列表。未知的输入字段仍会被处理,并在 ignored_args 中列出。

help.get

读取本版本文档的某一页,或其中的某一节。

POST /v1/help.get · MCP loom_help_get · 角色 viewer · 读取 · 不在 MCP all 工具集中列出

输入字段 类型 默认值 含义
org str '' 租户(身份元组的第一个元素)。
path str 必填 页面,与 help.search 返回的一致(features/knowledge.md)。
section str '' 该节的标题链,Title > A > B,与 help.search 返回的一致;为空则读取整页。
anchor str '' 该节的锚点,与 help.search 返回的一致:用于代替 section 读取,因为锚点在页面内是唯一的,而标题可能重复。
offset int 0 在所读文本(该节或整页)中开始读取的位置,以字符计:默认为 0;被截断的读取会给出其余部分的起始偏移量。
输出字段 类型 含义
available bool 当本版本未附带可读取的文档时为 False。
found bool 当该页面或页面上的该节不在本版本文档中时为 False。
path str 页面,相对于文档根目录。
title str 页面标题。
section str 所读取的节,Title > A > B;读取整页时为空。
anchor str 该节标题在渲染后页面上的锚点;读取整页时为空。
audience Literal['user', 'operator'] user 表示面向使用 Loom 的用户,operator 表示面向运行或构建它的运维人员。
text str 从 offset 开始的该节及其子节的 Markdown,或整页内容;超过限制时会被截断。
truncated bool 当 text 被截断时为 True;从 next_offset 再次读取可获得其余部分。
next_offset int 被截断的读取其余部分的起始位置;未截断时为 0。
sections list[HelpOutlineEntry] 该页面的所有节,按顺序排列:用于整页读取或被截断的读取,否则为空。

help.search

搜索本版本的文档。

POST /v1/help.search · MCP loom_help_search · 角色 viewer · 读取 · 不在 MCP all 工具集中列出

输入字段 类型 默认值 含义
org str '' 租户(身份元组的第一个元素)。
query str 必填 要查找的内容,用自然语言描述:问题、功能、操作名或设置名。
limit int 5 返回多少个节,按相关度从高到低。
输出字段 类型 含义
available bool 当本版本未附带可读取的文档时为 False;此时 hits 为空。
hits list[HelpHit] 最相关的节,按相关度从高到低,最多 limit 个。