help operations

The exact fields each help.* operation takes and returns.

Every op is POST /v1/<op> over HTTP and the MCP tool loom_<op>. The identity fields (org, namespace, agent, user_id, session_id) are filled from the token and the MCP session when a transport can; for an HTTP call with no token on a single-user server, the install's org on every op but code.* and tracker.* (which keep their plane's), and on some ops its namespace and agent; see identities and namespaces. The operations index explains role, kind and the MCP all listing. Unknown input fields are served and named in ignored_args.

help.get

Read one page of this build's documentation, or one section of it.

POST /v1/help.get · MCP loom_help_get · role viewer · read · not listed under the MCP all toolset

Input field	Type	Default	Meaning
org	str	''	The tenant (first element of the identity tuple).
path	str	required	The page, as help.search returns it (features/knowledge.md).
section	str	''	The section's headings, Title > A > B, as help.search returns it; empty for the whole page.
anchor	str	''	The section's anchor, as help.search returns it: read in place of section, since it is unique on its page where a heading may repeat.
offset	int	0	Where to start in the text read (the section, or the whole page), in characters: 0 by default; a cut read gives the offset its rest starts at.

Output field	Type	Meaning
available	bool	False when this build ships no documentation to read.
found	bool	False when the page, or the section on it, is not in this build's documentation.
path	str	The page, relative to the docs root.
title	str	The page's title.
section	str	The section read, Title > A > B; empty for the whole page.
anchor	str	The section heading's anchor on the rendered page; empty for the whole page.
audience	Literal['user', 'operator']	user for using Loom, operator for running or building it.
text	str	The section with its subsections as Markdown, or the whole page, from offset; cut at a limit.
truncated	bool	True when text was cut; read again from next_offset for the rest.
next_offset	int	Where the rest of a cut read starts; 0 when nothing was cut.
sections	list[HelpOutlineEntry]	Every section of the page, in order: for a whole-page read or a cut one, else empty.

help.search

Search this build's documentation.

POST /v1/help.search · MCP loom_help_search · role viewer · read · not listed under the MCP all toolset

Input field	Type	Default	Meaning
org	str	''	The tenant (first element of the identity tuple).
query	str	required	What to find, in words: a question, a feature, an op or setting name.
limit	int	5	How many sections to return, best first.

Output field	Type	Meaning
available	bool	False when this build ships no documentation to read; hits is then empty.
hits	list[HelpHit]	The best sections, best first, at most limit.