Visual Studio Code + Raims
Set up the VS Code agent with instructions and documentation for your Raims integration.
Quick start
Prepare the agent
Install VS Code and follow the official GitHub Copilot setup. This guide uses Copilot in the editor; sign in with the appropriate GitHub account.
Open your project
Open the application folder in VS Code and start a Chat conversation. Use the Copilot agent with access to your backend project.
Add the documentation
Ask the agent to read Raims' documentation index and open the relevant guides. llms-full.txt provides the consolidated content. Start with authentication and charges.
Try a prompt
Read https://docs.raims.com/llms.txt and the authentication and charges guides. Inspect this application's backend and propose a plan to retrieve an existing Sandbox charge with GET /v1/charges/{id}. Prepare an example using protected server configuration for the key. Do not send requests or use real credentials. Show the sources and the files you would change before editing.
Project context
Create or update .github/copilot-instructions.md at the application root. This is the general instruction file for Copilot in this guide. If you choose another agent in VS Code, follow its documented instruction format.
# Raims integration
- Read https://docs.raims.com/llms.txt before choosing endpoints and fields.
- Use https://docs.raims.com/llms-full.txt for the consolidated documentation.
- API base URL: https://api.raims.com.
- In Raims product installation examples, select the latest stable version
through the package manager (`latest` where supported).
- Prepare examples for Sandbox, with Bearer authentication in the backend.
- Keep the key in protected server configuration. Never put secrets in code,
prompts, logs, or browser applications.
- Explain the plan and request authorization before sending API requests.Verify the setup
Ask the agent to identify the guides it read, the API base URL, and the place in your backend where the key will be loaded. It should prepare the plan and example without asking you to paste a real credential.
Reading the documentation does not authenticate the application. Requests use a Raims API key for the intended company and environment.
Common issues
Check which agent is active in Chat. This guide uses Copilot instructions; Claude and Codex have their own formats described in the VS Code documentation.
Open the relevant guide in your browser and provide the public excerpt as context. Ask the agent to identify any missing information before suggesting code.
Ask the agent to review the authentication guide. The backend sends the Raims key with Bearer authentication; an AI provider credential does not replace it.