Utilizar a documentação de forma eficaz

Este guia explica como qualquer pessoa — desenvolvedores, produto, suporte ou integração — pode utilizar a documentação da API, com foco em:

Como acessar e usar o arquivo llms.txt

Como copiar a documentação em formato texto simples (.txt)

Como enviar esse conteúdo para chatbots/LLMs

Como utilizar o recurso Testar diretamente na documentação

Integrar a documentação com IDEs assistidas por IA via MCP Server (Model Context Protocol)

Boas práticas para uso da documentação com agentes de IA

1. 📄 O que é o llms.txt?

O arquivo llms.txt é um índice especial gerado automaticamente pela documentação. Ele contém:

Lista de todas as páginas da documentação da API

Cada página em formato Markdown (.md)

Um formato limpo, sem HTML, ideal para IA interpretar

Exemplo real

https://api.abcevo.com/llms.txt

Esse arquivo funciona como um "mapa" que aponta para todas as páginas da documentação em formato bruto e amigável para LLMs.

2. 🤖 Para que serve o llms.txt?

Ele permite que:

Chatbots e LLMs entendam toda a documentação da API sem interferência de HTML, menus ou scripts.

Você copie a documentação como texto simples (.txt) e envie para qualquer chatbot (ex: ChatGPT, Claude, agentes internos).

Você alimente sistemas RAG / vetorização. Perfeito para bases de conhecimento internas.

Use a documentação para criar agentes automáticos

Por exemplo

Assistente que responde dúvidas sobre API

Agente que escreve integrações

Checker automático de requisições

3. 📥 Como baixar e usar a documentação via llms.txt

Você consegue obter os arquivos .txt da documentação diretamente dos endpoints, clicando na seta em "Copiar Página".

A partir disso você consegue acessar os arquivos. Siga o passo a passo abaixo.

3.1. Acesse o arquivo

Abra no navegador: https://api.abcevo.com/llms.txt

Você verá uma lista de URLs.

3.2. Cada URL é uma página da documentação em Markdown (.md)

Exemplo típico:
https://api.abcevo.com/docs/endpoint-get-sales.md
https://api.abcevo.com/docs/authentication.md
https://api.abcevo.com/docs/errors.md

3.3. Copie ou baixe cada arquivo .md

Você pode:

Abrir cada URL e copiar o texto

Baixar tudo usando script (curl, wget, etc.)

Juntar os MDs em um único arquivo

3.4. Como converter para .txt (opcional)

Se quiser mandar para um chatbot como texto simples:

Copie o conteúdo da página

Cole em um editor como Notepad / VSCode

Salve como: documentacao-api.txt

3.5. Como enviar para um chatbot

Você pode enviar:

O arquivo .txt completo

As páginas individuais

O link do .md específico

Ou simplesmente colar o conteúdo

LLMs entendem perfeitamente o formato Markdown.

4. ✨ Usando o "Testar" na documentação da API

A documentação inclui um recurso interativo chamado Try It Out, que permite testar os endpoints diretamente da documentação, sem precisar abrir Postman, Insomnia ou terminal.

4.1. Como usar

Abra a página de um endpoint

Clique no botão Testar

Preencha os campos conforme o caso:

Query Params

Body

Headers

Auth

Clique em Send e veja:

Request enviada

Response body

Headers

Status code

4.2. Dicas importantes

Certifique-se de configurar a autenticação antes (Bearer token, API Key, etc.).

Utilize valores válidos para evitar erros.

Ótimo para validar comportamento real de endpoints.

Útil para times de QA, produto ou integrações externas.

5. 🤝 Como usar a documentação com ChatGPT ou outros LLMs

Aqui estão algumas formas práticas:

5.1. Enviar a documentação completa

Baixe todos os .md listados no llms.txt

Junte tudo em um arquivo só

Envie para o chatbot

5.2. Pedir para o LLM ajudar a explorar a API

Perguntas úteis:

“Explique como funciona este endpoint.”

“Quais parâmetros são obrigatórios?”

“Gere uma collection completa com base nesses arquivos.”

“Valide se a minha requisição está correta.”

“Compare dois endpoints parecidos.”

5.3. Criar agentes internos inteligentes

Usando RAG + o conteúdo do llms.txt, você pode criar:

Bot de suporte técnico

Assistente para integração de parceiros

Guia automatizado para desenvolvedores

Verificador de chamadas incorretas

Gerador automático de código de integração

6. ⚙️ Integração com IA via MCP Server da documentação

Permita que IDEs como Cursor acessem automaticamente a documentação da API.

A documentação oferece um servidor MCP (Model Context Protocol) que permite que ferramentas como Cursor e VS Code + extensões MCP acessem diretamente:

A especificação da API

A documentação publicada

Esquemas

Endpoints

Componentes

Autenticação

Exemplos

Ou seja: a IA dentro da IDE consegue ler e usar toda a sua API para gerar código automaticamente.

6.1. O que o MCP Server permite fazer?

Com o MCP da Apidog, você pode:

Gerar código pronto baseado em qualquer endpoint

Atualizar DTOs automaticamente

Criar serviços, controllers, rotas e chamadas de API

Inserir comentários baseados na documentação

Procurar endpoints pela descrição

Validar requisições

Criar testes baseados no schema

E muito mais — tudo sem copiar e colar documentação manualmente!

A IA passa a ter memória local da sua API.

6.2. Como funciona?

O MCP Server:

Baixa e cacheia localmente toda a documentação da API

A IA da sua IDE acessa esses dados nativamente

Você só pede:

“Gere o serviço para o endpoint /appointments/schedule/detail usando o schema da API.”

E o Cursor / VSCode gera TUDO automaticamente.

6.3. Configuração com 1 clique

Você pode configurar com o JSON abaixo.

Este exemplo usa o site ID 759651:

{
  "mcpServers": {
    "EVO API": {
      "command": "cmd",
      "args": [
        "/c",
        "npx",
        "-y",
        "apidog-mcp-server@latest",
        "--site-id=759651"
      ]
    }
  }
}

📌 Requisitos:

Node.js >= 18

IDE com suporte a MCP:

Cursor

VS Code (via plugins como Cline ou AI MCP)

6.4. Configuração manual (caso queira personalizar)

Você pode ajustar:

Portas

Cache

Access tokens (para docs privadas)

Fonte dos dados (OpenAPI / Swagger / docs online .txt)

Exemplo

Ou, se for ambiente On-Premise:

6.5. O que fazer após colar o JSON?

No Cursor ou VSCode:

Abra Settings → MCP Servers

Cole o JSON acima

Reinicie a IDE

A IA passa a responder com base na documentação real:

Exemplo de prompt útil:

“Use o MCP para buscar o schema de Sales e gerar uma classe TypeScript com tipagem completa.”

6.6. Documentação oficial do MCP Server

A Apidog, fornecedora da hospedagem da documentação da EVO API, mantém documentação completa sobre:

Como funciona o MCP

Como conectar projetos

Como usar documentação publicada como fonte

Como conectar Swagger / OpenAPI

Ler referência completa.

6. 🧭 Boas práticas

Sempre utilize o llms.txt como ponto de partida. Ele garante que o conteúdo está atualizado.

Atualize o chatbot sempre que a documentação mudar. Basta substituir os arquivos .md.

Prefira Markdown → LLMs entendem perfeitamente.

Use o Try It Out para validar antes de abrir um ticket.

Para grandes volumes, prefira dividir em múltiplos arquivos.

7. 📂 Exemplo de fluxo rápido (resumo)

Acesse: https://api.abcevo.com/llms.txt

Baixe os MDs

Salve como .txt (se preferir)

Envie para o chatbot

Use o Try It Out na interface para validar

Deixe o LLM te auxiliar na integração, análise, exemplos e debugging

Utilizar a documentação de forma eficaz

1. 📄 O que é o llms.txt?#

Exemplo real#

2. 🤖 Para que serve o llms.txt?#

Por exemplo#

3. 📥 Como baixar e usar a documentação via llms.txt#

3.1. Acesse o arquivo#

3.2. Cada URL é uma página da documentação em Markdown (.md)#

3.3. Copie ou baixe cada arquivo .md#

3.4. Como converter para .txt (opcional)#

3.5. Como enviar para um chatbot#

4. ✨ Usando o "Testar" na documentação da API#

4.1. Como usar#

4.2. Dicas importantes#

5. 🤝 Como usar a documentação com ChatGPT ou outros LLMs#

5.1. Enviar a documentação completa#

5.2. Pedir para o LLM ajudar a explorar a API#

5.3. Criar agentes internos inteligentes#

6. ⚙️ Integração com IA via MCP Server da documentação#

6.1. O que o MCP Server permite fazer?#

6.2. Como funciona?#

6.3. Configuração com 1 clique#

📌 Requisitos:#

6.4. Configuração manual (caso queira personalizar)#

Exemplo#

6.5. O que fazer após colar o JSON?#

6.6. Documentação oficial do MCP Server#

6. 🧭 Boas práticas#

7. 📂 Exemplo de fluxo rápido (resumo)#