Use a documentação do Asaas com assistentes de IA

O Asaas disponibiliza dois recursos para facilitar o uso da documentação por ferramentas de inteligência artificial:

• MCP Server: conecta assistentes compatíveis à documentação e à referência da API;
• LLMs.txt: apresenta um índice estruturado dos conteúdos públicos do portal.

Conecte seu assistente ao MCP Server

O Model Context Protocol, ou MCP, permite que ferramentas de IA consultem recursos externos de forma estruturada.

O MCP Server do Asaas utiliza a documentação e a especificação OpenAPI para fornecer informações sobre os endpoints disponíveis.

O que o assistente pode consultar

Dependendo dos recursos disponíveis na ferramenta utilizada, o assistente poderá:

• pesquisar conteúdos da documentação;
• listar endpoints da API;
• consultar parâmetros e schemas;
• visualizar estruturas de requisição e resposta;
• gerar exemplos de integração;
• auxiliar na análise de erros;
• executar requisições quando a ferramenta estiver autenticada e permitir esse tipo de ação.

Configure o MCP Server

Utilize o seguinte endereço:

https://docs.asaas.com/mcp

Adicione essa URL à configuração MCP da sua ferramenta.

{
  "mcpServers": {
    "asaas": {
      "url": "https://docs.asaas.com/mcp"
    }
  }
}

Consulte também os exemplos de configuração do MCP Server.

Proteja sua chave de API

O MCP Server é público para consulta da documentação. No entanto, operações autenticadas na API exigem uma chave válida do Asaas.

Antes de permitir a execução de requisições:

• utilize uma chave de Sandbox durante os testes;
• limite as permissões da chave;
• evite disponibilizar credenciais de Produção;
• revise cada operação antes da execução;
• não permita que a ferramenta exponha a chave em logs ou respostas.

Consulte Chaves de API e Gerenciamento de permissões.

Teste a configuração

Após conectar o servidor, faça perguntas como:

• Como criar um cliente no Asaas?
• Qual endpoint cria uma assinatura?
• Quais campos são necessários para tokenizar um cartão?
• Quais eventos de Webhook estão relacionados a cobranças?

Confira se as respostas apresentam endpoints, campos e links compatíveis com a documentação atual.

Consulte outra branch da documentação

Por padrão, o MCP Server utiliza a versão principal publicada.

Para consultar outra branch disponível, acrescente o parâmetro branch:

https://docs.asaas.com/mcp?branch=nome_da_branch

Consulte o arquivo LLMs.txt

O arquivo llms.txt apresenta links e descrições da documentação em um formato estruturado para ferramentas compatíveis.

Acesse:

https://docs.asaas.com/llms.txt

Esse arquivo pode ajudar ferramentas de IA a:

• localizar páginas relevantes;
• identificar conteúdos atualizados;
• utilizar a terminologia da documentação;
• encontrar guias e endpoints relacionados.

Reporte informações incorretas

Caso identifique uma resposta inconsistente com a documentação, envie os detalhes para:

Sempre que possível, informe:

• ferramenta utilizada;
• pergunta enviada;
• resposta recebida;
• página ou endpoint relacionado;
• informação que precisa ser corrigida.

Próximos passos

• Consulte o arquivo LLMs.txt
• Acesse a referência da API
• Configure a autenticação
• Gerencie as permissões das chaves de API