Skip to main content

Build with AI / Tools

Agent Skills

Install the Egon skills once, and your coding agent knows where the documentation is, how to authenticate, how to run a batch job, and how to keep your data safe.

Each skill is a single SKILL.md file that links to the markdown pages of this site, and egon-api also to the OpenAPI schema, so the agent always reads the current documentation.

The egon-api Skill​

The egon-api skill gives your agent the base URL, the authentication header, the key safety rules, and every service of the Egon API.

The egon-batch Skill​

The egon-batch skill teaches your agent how Egon Batch works on this site: how to prepare the address file, run the job, and read the output, with links to every Batch page.

Install with the Skills CLI​

Run this in your project. The CLI asks which skills and agents to set up, then copies each skill into the folder each agent reads.

npx skills add https://documentation.egon.com

The CLI finds the skills through /.well-known/agent-skills/index.json, which every build of this site publishes.

Install Manually​

Copy each SKILL.md into a folder named after its skill:

AgentFolder
Claude Code.claude/skills/<name>/
Codex, Cursor, and other agents that read .agents/skills/.agents/skills/<name>/

For Claude Code, run this in your project. For other agents, replace .claude with .agents.

mkdir -p .claude/skills/egon-api && curl -fsSLo .claude/skills/egon-api/SKILL.md https://documentation.egon.com/skills/egon-api/SKILL.md
mkdir -p .claude/skills/egon-batch && curl -fsSLo .claude/skills/egon-batch/SKILL.md https://documentation.egon.com/skills/egon-batch/SKILL.md

Check the Setup​

Start a new session and ask:

Prompt
Do you have the egon-api and egon-batch skills? Show the base URL and the authentication header the egon-api skill tells you to use, and the steps the egon-batch skill gives to run a batch job.

To add Egon to your project instructions instead, see Coding Agents.