> Source: https://clickhouse.github.io/loom/es/reference/operations/help/ (Markdown: https://clickhouse.github.io/loom/es/reference/operations/help.md)

<!-- i18n: source=docs/reference/operations/help.md blob=8942b4393f07a60988b7d8bac4f40f8467b6daa2 model=claude-sonnet-5-5 -->
> Esta página es una traducción automática de la [página en inglés](https://clickhouse.github.io/loom/reference/operations/help/), que prevalece.
> Machine-translated from the [English page](https://clickhouse.github.io/loom/reference/operations/help/), which is authoritative.

<a id="help-operations"></a>

# Operaciones de `help`

Los campos exactos que recibe y devuelve cada operación `help.*`.

<!-- Generated by `python scripts/codegen/docs_reference.py` from the op registry; edit the models, not this page. -->

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](https://github.com/ClickHouse/loom/blob/main/docs/reference/http-api.md#request) también su espacio de nombres y su agente; consulta [identidades y espacios de nombres](https://github.com/ClickHouse/loom/blob/main/docs/concepts/identities-and-namespaces.md). El [índice de operaciones](https://github.com/ClickHouse/loom/blob/main/docs/reference/operations.md) explica el rol, el tipo y el listado `all` de MCP. Los campos de entrada desconocidos se atienden y se indican en `ignored_args`.

<!-- prettier-ignore-start -->

<a id="helpget"></a>

## `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. |

<a id="helpsearch"></a>

## `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`. |

<!-- prettier-ignore-end -->
