Pular para conteúdo

As páginas sem tradução abrem em inglês e são identificadas como inglês.

Esta página é uma tradução automática da página em inglês, que prevalece. Machine-translated from the English page, which is authoritative.

Operações help

Os campos exatos que cada operação help.* recebe e retorna.

Toda op é POST /v1/<op> via HTTP e a ferramenta MCP loom_<op>. Os campos de identidade (org, namespace, agent, user_id, session_id) são preenchidos a partir do token e da sessão MCP quando o transporte consegue; em uma chamada HTTP sem token em um servidor de usuário único, vale a org da instalação em todas as ops, exceto code.* e tracker.* (que mantêm a do seu plano), e em algumas ops também o namespace e o agente; veja identidades e namespaces. O índice de operações explica role, kind e a listagem all do MCP. Campos de entrada desconhecidos são atendidos e listados em ignored_args.

help.get

Lê uma página da documentação desta build, ou uma seção dela.

POST /v1/help.get · MCP loom_help_get · role viewer · leitura · não listada no toolset all do MCP

Campo de entrada Tipo Padrão Significado
org str '' O tenant (primeiro elemento da tupla de identidade).
path str obrigatório A página, como help.search a retorna (features/knowledge.md).
section str '' Os títulos da seção, Title > A > B, como help.search os retorna; vazio para a página inteira.
anchor str '' A âncora da seção, como help.search a retorna: lida no lugar de section, pois é única na página, enquanto um título pode se repetir.
offset int 0 Onde começar no texto lido (a seção ou a página inteira), em caracteres: 0 por padrão; uma leitura cortada informa o offset em que o restante começa.
Campo de saída Tipo Significado
available bool Falso quando esta build não inclui documentação para leitura.
found bool Falso quando a página, ou a seção nela, não está na documentação desta build.
path str A página, relativa à raiz da documentação.
title str O título da página.
section str A seção lida, Title > A > B; vazio para a página inteira.
anchor str A âncora do título da seção na página renderizada; vazio para a página inteira.
audience Literal['user', 'operator'] user para usar o Loom, operator para executá-lo ou construí-lo.
text str A seção com suas subseções em Markdown, ou a página inteira, a partir de offset; cortada em um limite.
truncated bool Verdadeiro quando text foi cortado; leia de novo a partir de next_offset para obter o restante.
next_offset int Onde o restante de uma leitura cortada começa; 0 quando nada foi cortado.
sections list[HelpOutlineEntry] Todas as seções da página, em ordem: para uma leitura da página inteira ou cortada, senão vazio.

help.search

Pesquisa a documentação desta build.

POST /v1/help.search · MCP loom_help_search · role viewer · leitura · não listada no toolset all do MCP

Campo de entrada Tipo Padrão Significado
org str '' O tenant (primeiro elemento da tupla de identidade).
query str obrigatório O que encontrar, em palavras: uma pergunta, um recurso, o nome de uma op ou de uma configuração.
limit int 5 Quantas seções retornar, das melhores para as piores.
Campo de saída Tipo Significado
available bool Falso quando esta build não inclui documentação para leitura; hits fica então vazio.
hits list[HelpHit] As melhores seções, da melhor para a pior, no máximo limit.