> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cakto.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Ferramentas de Descoberta

> As ferramentas do CaktoMCP que funcionam sem nenhuma credencial.

<Note>
  Nenhuma ferramenta desta página precisa de Chave de API. Elas leem só
  material público — o contrato da API (o mesmo schema que gera esta
  documentação) e as páginas desta documentação — por isso funcionam mesmo
  antes de você configurar qualquer credencial.
</Note>

## `cakto_search_api`

Busca endpoints por intenção, em português ou inglês. É o ponto de entrada
quando a IA (ou você) não sabe o nome exato da operação.

| Parâmetro | Tipo    | Obrigatório              | Descrição                                                                                          |
| --------- | ------- | ------------------------ | -------------------------------------------------------------------------------------------------- |
| `query`   | string  | Sim                      | O que se quer fazer — ex.: "criar link de checkout", "cancelar assinatura", "listar vendas do mês" |
| `limit`   | integer | Não (default 8, máx. 25) | Quantos resultados retornar                                                                        |

**Exemplo:**

```
cakto_search_api(query: "reembolsar um pedido")
```

Retorna uma lista ordenada por relevância com `operation_id`, método, path
e resumo de cada operação candidata — pronta para ser detalhada com
`cakto_get_endpoint`.

## `cakto_list_endpoints`

Lista o catálogo completo de operações disponíveis, agrupado por recurso
(produtos, ofertas, pedidos, assinaturas, webhooks, clientes, pagamentos,
checkouts, order bumps). Útil para ter uma visão geral do que a API
oferece, ou quando a busca não encontra nada relevante.

| Parâmetro | Tipo                                    | Obrigatório | Descrição                                            |
| --------- | --------------------------------------- | ----------- | ---------------------------------------------------- |
| `tag`     | string                                  | Não         | Filtra por recurso. Sem valor, retorna tudo agrupado |
| `method`  | `GET`\|`POST`\|`PUT`\|`PATCH`\|`DELETE` | Não         | Filtra por método HTTP                               |

<Info>
  Esta lista reflete só as operações realmente documentadas no contrato da
  API. Ela nunca inclui algo que não esteja confirmado no contrato — a IA
  não inventa cobertura que a API não tem.
</Info>

## `cakto_get_endpoint`

A ferramenta mais importante da descoberta: o contrato completo de uma
operação específica. É sempre chamada antes de qualquer execução — a IA
nunca monta um payload por adivinhação.

| Parâmetro      | Tipo   | Obrigatório | Descrição                                                                          |
| -------------- | ------ | ----------- | ---------------------------------------------------------------------------------- |
| `operation_id` | string | Sim         | Identificador da operação, obtido via `cakto_search_api` ou `cakto_list_endpoints` |

Retorna, para a operação pedida:

* Método, URL completa e caminho
* Parâmetros de path e query — tipo, obrigatoriedade, enum, valor default
* Schema completo do corpo da requisição, com cada campo documentado
* Schema de cada resposta possível, com um exemplo gerado a partir do
  contrato (nunca um dado que pareça real)
* Se o campo não estiver documentado no contrato, a ferramenta diz isso
  explicitamente em vez de inventar um valor

**Exemplo:**

```
cakto_get_endpoint(operation_id: "products_create")
```

## `cakto_list_webhook_events`

Catálogo de eventos de webhook disponíveis — nome do evento e se ele é
efetivamente testável pela API. Use quando for configurar um webhook, ou
para investigar por que um evento esperado não chegou.

Sem parâmetros.

## `cakto_search_docs`

Busca nesta documentação por título e descrição — conceitos, guias de início,
SDK do checkout, referência de API e as páginas do próprio CaktoMCP. É o
catálogo: é aqui que a IA descobre qual página existe antes de pedir o texto.

| Parâmetro | Tipo    | Obrigatório              | Descrição                                                                   |
| --------- | ------- | ------------------------ | --------------------------------------------------------------------------- |
| `query`   | string  | Não                      | Assunto procurado. Sem valor, devolve o catálogo inteiro agrupado por seção |
| `limit`   | integer | Não (default 8, máx. 25) | Quantos resultados retornar                                                 |

## `cakto_get_guide`

Lê uma página inteira desta documentação, pelo slug — para dúvida de
**conceito** (autenticação, idempotência, paginação, tratamento de erro,
webhooks, ambientes, Checkout Builder, SDK), em vez do contrato de um
endpoint específico.

| Parâmetro | Tipo   | Obrigatório | Descrição                                                                        |
| --------- | ------ | ----------- | -------------------------------------------------------------------------------- |
| `topic`   | string | Sim         | Slug da página — ex.: `conceitos/idempotencia`. Descubra com `cakto_search_docs` |

<Info>
  Estas duas ferramentas leem a documentação **publicada, em tempo de
  execução**: não existe cópia dos textos dentro do servidor, então a resposta
  da IA acompanha o que está no ar. Como funciona, e o que fazer quando o slug
  não é conhecido, em [Guias](/mcp/guias).
</Info>

## Próximos passos

<CardGroup cols={2}>
  <Card title="Ferramentas de Execução" icon="bolt" href="/mcp/ferramentas-de-execucao">
    Como funciona a execução real, com credencial
  </Card>

  <Card title="Guias" icon="book-open" href="/mcp/guias">
    Como o MCP lê esta documentação em tempo real
  </Card>
</CardGroup>