Las páginas sin traducir se abren en inglés y se indican como inglés.
Esta página es una traducción automática de la página en inglés, que prevalece. Machine-translated from the English page, which is authoritative.
Operaciones de help
Los campos exactos que recibe y devuelve cada operación help.*.
Cada op es POST /v1/<op> por HTTP y la herramienta MCP loom_<op>. Los campos de identidad (org, namespace, agent, user_id, session_id) se rellenan a partir del token y de la sesión MCP cuando el transporte puede hacerlo; en una llamada HTTP sin token en un servidor de un solo usuario, se usa la org de la instalación en todas las ops salvo code.* y tracker.* (que conservan la de su plano), y en algunas ops también su espacio de nombres y su agente; consulta identidades y espacios de nombres. El índice de operaciones explica el rol, el tipo y el listado all de MCP. Los campos de entrada desconocidos se atienden y se indican en ignored_args.
help.get
Lee una página de la documentación de esta compilación, o una sección de ella.
POST /v1/help.get · MCP loom_help_get · rol viewer · lectura · no figura en el toolset all de MCP
| Campo de entrada | Tipo | Valor por defecto | Significado |
|---|---|---|---|
org |
str |
'' |
El tenant (primer elemento de la tupla de identidad). |
path |
str |
obligatorio | La página, tal como la devuelve help.search (features/knowledge.md). |
section |
str |
'' |
Los encabezados de la sección, Title > A > B, tal como los devuelve help.search; vacío para la página completa. |
anchor |
str |
'' |
El ancla de la sección, tal como la devuelve help.search: se lee en lugar de section, ya que es única en su página, mientras que un encabezado puede repetirse. |
offset |
int |
0 |
Dónde empezar en el texto leído (la sección o la página completa), en caracteres: 0 por defecto; una lectura cortada indica el offset en el que empieza el resto. |
| Campo de salida | Tipo | Significado |
|---|---|---|
available |
bool |
False cuando esta compilación no incluye documentación que leer. |
found |
bool |
False cuando la página, o la sección dentro de ella, no está en la documentación de esta compilación. |
path |
str |
La página, relativa a la raíz de la documentación. |
title |
str |
El título de la página. |
section |
str |
La sección leída, Title > A > B; vacío para la página completa. |
anchor |
str |
El ancla del encabezado de la sección en la página renderizada; vacío para la página completa. |
audience |
Literal['user', 'operator'] |
user para usar Loom, operator para ejecutarlo o compilarlo. |
text |
str |
La sección con sus subsecciones en Markdown, o la página completa, a partir de offset; cortado en un límite. |
truncated |
bool |
True cuando text se cortó; vuelve a leer desde next_offset para obtener el resto. |
next_offset |
int |
Dónde empieza el resto de una lectura cortada; 0 cuando no se cortó nada. |
sections |
list[HelpOutlineEntry] |
Todas las secciones de la página, en orden: para una lectura de la página completa o una cortada; en otro caso, vacío. |
help.search
Busca en la documentación de esta compilación.
POST /v1/help.search · MCP loom_help_search · rol viewer · lectura · no figura en el toolset all de MCP
| Campo de entrada | Tipo | Valor por defecto | Significado |
|---|---|---|---|
org |
str |
'' |
El tenant (primer elemento de la tupla de identidad). |
query |
str |
obligatorio | Qué buscar, con palabras: una pregunta, una funcionalidad, el nombre de una op o de un ajuste. |
limit |
int |
5 |
Cuántas secciones devolver, las mejores primero. |
| Campo de salida | Tipo | Significado |
|---|---|---|
available |
bool |
False cuando esta compilación no incluye documentación que leer; hits queda entonces vacío. |
hits |
list[HelpHit] |
Las mejores secciones, las mejores primero, como máximo limit. |