Uso com agentes de IA
Dê estes docs ao Claude Code, ao Cursor ou a qualquer agente de programação, junto com um prompt que adiciona o Lyrelog ao seu projeto.
Toda página daqui também existe em Markdown puro, então um agente de programação pode ler os docs em vez de adivinhar de memória, e de memória ele erra num serviço novo como o Lyrelog.
Arquivos para agentes
| Endereço | O que contém |
|---|---|
/llms.txt | Um índice de todas as páginas com a descrição de cada uma, cada qual com link para o seu Markdown. É o formato llms.txt que os agentes procuram. |
/llms-full.txt | Todas as páginas num arquivo só, para colocar os docs inteiros no contexto de um agente de uma vez. |
/<page>.md | Uma página, por exemplo /sdks/go.md. |
Cada página também tem, abaixo do título, Copy Markdown e Open, para enviá-la ao ChatGPT, ao Claude ou ao Cursor.
Um prompt para adicionar o Lyrelog ao seu projeto
Cole-o no seu agente, com a sua chave de ingestão no lugar de lyr_ing_... (na página
API keys do projeto, veja Chaves; ela só escreve, então é seguro
distribuí-la num app). Se preferir manter a chave fora do repositório, coloque-a numa variável de
ambiente e diga ao agente o nome dela.
Add Lyrelog logging to this project. Read https://docs.lyrelog.com/llms.txt first, then the
page of the SDK for this project's language (or the HTTP API page if there's no SDK for it).
Don't rely on what you remember about Lyrelog: follow the docs.
1. Install the SDK and start it once, where the app or service starts, with the ingest key
lyr_ing_... (or from the environment variable LYRELOG_KEY). Keep the default endpoint.
2. Make sure queued events are sent before the process ends: flush or close the client as the
SDK page says for this kind of program (server, CLI, serverless function, app).
3. Capture errors: unhandled ones the way the SDK page shows, and the places in this code that
catch an error and carry on.
4. Log a few events where something happens to a person: sign in, a payment, a sync, a failed
request. Use a stable snake_case name as the message (payment_declined), a level, an area
(category) and attributes with the details to filter by.
5. Identify the person with our own user id (setUser or the SDK's equivalent), never an email
address, and clear it on sign-out.
6. Never put passwords, tokens, keys, cookies, full request bodies or personal data in messages,
attributes or payloads.
7. Tell me which environment the events will arrive under, so I can pick it in the dashboard.Os SDKs ainda não foram publicados, então hoje um agente não consegue instalá-los: o prompt funciona quando eles forem publicados. Até lá, o agente pode enviar eventos pela API HTTP.
Deixe um agente ler os seus eventos
A ferramenta de linha de comando permite que um agente de programação pesquise eventos,
leia erros e acompanhe uma pessoa ao longo de uma sessão, autenticado como você. Ela gera JSON
quando é um agente que a executa. Você entra uma vez com lyrelog login; o agente não consegue
entrar sozinho. Veja Para agentes e scripts, com um prompt para investigar um erro.
Dicas
- Diga qual é a página. "Leia https://docs.lyrelog.com/sdks/python.md e adicione o Lyrelog ao app FastAPI" é mais rápido e mais preciso do que uma busca.
- Peça um evento de teste. Faça o agente registrar um evento quando o app iniciar, rodar o app e conferir se o evento chega (veja o Início rápido): é o jeito mais rápido de pegar uma chave ou um ambiente errados.
- Revise o que ele registra. Agentes costumam registrar logs demais. Um evento por coisa que aconteceu, com um nome estável, é mais fácil de pesquisar, de colocar num gráfico e de pagar do que uma linha por chamada de função.