Build with AI / Tools

Coding Agents

Set up Claude Code, Cursor, GitHub Copilot, or Codex to write code that matches the Egon API.

• Copy this page
  • View as Markdown
• Ask an AI assistant
  • Open in ChatGPT
  • Open in Claude
  • Open in Cursor

Add the Project Instructions

Coding agents read an instructions file in your repository. Add this block to AGENTS.md (Codex, Cursor, GitHub Copilot) or CLAUDE.md (Claude Code):

Prompt

## Egon API

- Documentation index: https://documentation.egon.com/llms.txt (add .md to any page URL for its markdown)
- OpenAPI schema: https://documentation.egon.com/openapi.json
- Authentication: use the header described in securitySchemes in the schema.
- Read the API key from the EGON_API_KEY environment variable. Never hardcode it and never call Egon from the browser.
- Check the quality indicators in each response before trusting the data: https://documentation.egon.com/docs/quality-indicators.md

Generate a Client

Then ask for what you need, for example:

Prompt

Using the Egon OpenAPI schema at https://documentation.egon.com/openapi.json,
write a typed TypeScript client for the endpoints this project uses.

For prompts on specific integrations, see the Prompt Library. To give your agent the same rules as an installable skill, see Agent Skills.