fayzfayz sdk

Conecte seu agente

Este site foi feito para ser lido por humanos e por agentes. Se você usa o Claude Code, o Cursor, o Codex ou qualquer agente para construir com a Fayz SDK, aponte a ferramenta para os artefatos abaixo — assim o agente responde com a estrutura real do SDK em vez de chutar.

Esta página é sobre conectar o agente ao Dev Center. Se você quer entender como o seu próprio app vira uma superfície que um agente lê e opera, veja Seu app como camada de dados.

Todo app gerado já vem com um AGENTS.md

Quando você roda fayz create, o scaffold inclui um AGENTS.md na raiz do projeto: um guia de agente neutro de fornecedor que descreve a estrutura do app, a checklist de personalização e o passo a passo do Supabase. Qualquer agente que respeite a convenção AGENTS.md lê esse arquivo e já sabe que "personalizar = editar o manifesto, não escrever código novo", onde ficam os arquivos e como conectar um banco real.

O scaffold também gera um CLAUDE.md — mas ele é só um ponteiro para o AGENTS.md, para o Claude Code não duplicar guia. A fonte da verdade é uma só.

O AGENTS.md gerado aponta o agente de volta para este Dev Center — para o llms.txt (o mapa) e para o site (a referência humana). Então o agente que abre o seu app já sabe onde buscar o resto.

O ponto de entrada: /llms.txt

Comece pelo /llms.txt. Ele lista a árvore de navegação inteira do Dev Center em texto puro, com um resumo de cada área — o mapa que um agente lê primeiro para saber o que existe.

curl https://developers.fayz.ai/llms.txt

Se o agente precisar de tudo de uma vez, existe o /llms-full.txt: o Markdown cru de todas as páginas concatenado em ordem de navegação. É pesado — prefira o llms.txt como índice e puxe páginas específicas sob demanda.

Cada página em Markdown

Toda página de documentação tem uma versão em Markdown cru, servida no mesmo caminho com sufixo .md. No rodapé de cada página existe o link "Ver esta página em Markdown" — é exatamente esse arquivo. Aponte o agente para o .md da página relevante quando quiser dar contexto específico sem o HTML no meio.

Por exemplo, esta página em Markdown está em /pt-BR/docs/ia/conecte-seu-agente.md.

Exemplos de prompt

Depois de dar o llms.txt ao agente, prompts curtos em português funcionam bem:

Leia https://developers.fayz.ai/llms.txt. Depois adicione o plugin crm
ao meu app.manifest.json e rode o fayz doctor para validar.

Meu npm run dev abre uma tela em branco. Leia a página de troubleshooting
do Dev Center em Markdown e me explique se isso é esperado.

Conecte este app a um Supabase real seguindo o AGENTS.md: preencha o
.env.local e rode o fayz db apply --dry-run antes de aplicar de verdade.

Leia /pt-BR/docs/ia/seu-app-como-camada-de-dados.md. Meu plugin próprio
tem um registry de pedidos — proponha as aiTools que eu deveria declarar
no manifesto, com mode e permission.

Boas práticas

  • Dê ao agente o llms.txt primeiro, depois páginas específicas sob demanda.
  • Prefira a versão Markdown de cada página ao HTML renderizado.
  • Deixe o AGENTS.md do app no contexto — ele carrega as convenções específicas do projeto.
  • Peça para o agente citar o slug da página que usou, para você conferir.
  • Depois de conectado, aponte-o para os procedimentos prontos em Skills — skills oficiais Fayz e da comunidade.

MCP: em breve

Um MCP server dedicado da Fayz — para o agente consultar catálogo e docs sem colar URLs — está em breve (em design). Por enquanto, o llms.txt mais as páginas .md são o caminho oficial.

Próximo: Seu app como camada de dados · Conectores e canais.