Visual Studio Code + Raims
Configure o agente no VS Code com instruções e documentação para integrar a Raims.
Já usa este agente? Vá para Contexto do projeto e preserve sua configuração atual. Este tutorial configura o GitHub Copilot no VS Code. O guia do Copilot usa o mesmo arquivo de instruções.
Início rápido
Prepare o agente
Instale o VS Code e siga a configuração oficial do GitHub Copilot. Este guia usa o Copilot no editor; conclua o login com a conta GitHub apropriada.
Abra seu projeto
Abra a pasta da aplicação no VS Code e inicie uma conversa no Chat. Use o agente do Copilot com acesso ao projeto do seu backend.
Adicione a documentação
Peça ao agente para ler o índice da documentação Raims e abrir os guias relevantes. O llms-full.txt reúne o conteúdo completo. Comece por autenticação e cobranças.
Experimente um prompt
Leia https://docs.raims.com/llms.txt e os guias de autenticação e cobranças. Analise o backend desta aplicação e proponha um plano para consultar uma cobrança existente em Sandbox com GET /v1/charges/{id}. Prepare um exemplo com a chave em configuração protegida do servidor. Não envie requisições nem use credenciais reais. Apresente as fontes e os arquivos que pretende alterar antes de editar.
Contexto do projeto
Crie ou complemente .github/copilot-instructions.md na raiz da aplicação. Esse é o arquivo de instruções gerais para o Copilot neste guia. Se escolher outro agente no VS Code, siga o formato de instruções documentado para ele.
O arquivo de instruções fica junto do seu projeto. Esta árvore mostra sua localização:
# Integração Raims
- Consulte https://docs.raims.com/llms.txt antes de escolher endpoints e campos.
- Use https://docs.raims.com/llms-full.txt para a documentação completa.
- URL base da API: https://api.raims.com.
- Nos exemplos de instalação de produtos Raims, obtenha a versão estável mais
recente pelo gerenciador de pacotes (`latest` quando disponível).
- Prepare exemplos para Sandbox, com autenticação Bearer no backend.
- Mantenha a chave em configuração protegida do servidor. Não coloque segredos
no código, em prompts, logs ou aplicações de navegador.
- Explique o plano e peça autorização antes de enviar requisições à API.Verificar a configuração
Peça ao agente para indicar os guias lidos, a URL base e o ponto do backend em que a chave será carregada. Ele deve preparar o plano e o exemplo sem solicitar uma credencial real no chat.
Ler a documentação não autentica a aplicação. As requisições usam uma chave de API Raims da empresa e do ambiente desejados.
Reconhecer a configuração concluída
Um plano revisável para consultar uma cobrança existente no Sandbox, com fontes públicas e os arquivos de backend propostos. O prompt pede somente planejamento, sem requisição à API nem credencial real no chat.
| Conferência | O que o plano deve mostrar |
|---|---|
| Instruções do projeto | O agente considerou .github/copilot-instructions.md e manteve as convenções da aplicação. |
| Fontes | Guias de autenticação e cobranças, com os links que realmente leu. |
| Ambiente e endpoint | Sandbox e GET /v1/charges/{id}, usando um ID da sua integração. |
| Segredo | Um ponto de configuração protegido no backend, sem chave no código ou no prompt. |
| Trabalho proposto | Os arquivos a alterar e o resultado a conferir antes de autorizar um teste. |
Se faltar um item, peça ao agente para completar o plano antes de editar ou autorizar uma requisição. Se ele não conseguiu ler uma fonte, forneça o trecho público relevante e mantenha explícito o que ainda falta.
Problemas comuns
Confira qual agente está ativo no Chat. As instruções deste guia usam Copilot; Claude e Codex têm formatos próprios descritos na documentação do VS Code.
Abra o guia relevante no navegador e forneça o trecho público como contexto. Peça ao agente para apontar o que falta antes de sugerir código.
Peça ao agente para revisar o guia de autenticação. O backend envia a chave Raims com Bearer; uma credencial do provedor de IA não a substitui.