Installing the Skill
Installing the Skill
The skill is one folder — skills/quayel-gateway/ containing a single SKILL.md — from the Quayel-Gateway repository. Any tool that supports the Agent Skills format can use it.
Claude Code
Project scope — shared with your team through git (recommended for a gateway config repo):
git clone --depth 1 https://github.com/quayel/Quayel-Gateway.git
mkdir -p .claude/skills
cp -r Quayel-Gateway/skills/quayel-gateway .claude/skills/
rm -rf Quayel-Gateway
User scope — available in all your projects:
git clone --depth 1 https://github.com/quayel/Quayel-Gateway.git
cp -r Quayel-Gateway/skills/quayel-gateway ~/.claude/skills/
rm -rf Quayel-Gateway
Claude Code discovers skills in these directories automatically — no other configuration is needed. Start a new session and the skill activates whenever you ask for gateway configuration work.
Other agents and tools
The package follows the Agent Skills standard (a folder with SKILL.md and YAML name/description frontmatter), so any compatible tool works:
# e.g. a tool that reads skills from .agents/skills/
cp -r Quayel-Gateway/skills/quayel-gateway .agents/skills/
Copy skills/quayel-gateway/ into whatever skills directory your tool documents (.agents/skills/, ~/.agents/skills/, or a configured skills path). The skill's name is quayel-gateway.
Tools without skills support: paste SKILL.md into the conversation, or point the agent at the AI Agent Guide — it contains the same contract in full. Working inside the repository? AGENTS.md already directs agents to the right files.
Verify the install
1. Ask for a config
Create a quayel gateway config that proxies api.example.com to 127.0.0.1:3000
2. Check the response
The agent should produce a complete config.json with all required top-level fields (gateway_id, gateway_name, server_name, config_version, listen, plugins) and exact snake_case enums — no invented values like "health_check": {"mode": "http"}.
3. Check the validation loop
A well-behaved run validates before declaring success: JSON syntax → config.schema.json → the gateway's own parser (timeout -k 2 3 ./target/release/quayel-gateway config.json) → smoke test. See the AI Agent Guide for the loop.
Example prompts
- "Add a rate limit: 100 requests per minute per IP on /api/ only."
- "Block Tor, VPN, and datacenter IPs from /admin, but allow my office IP."
- "Cache static assets for 1 hour at the edge and 5 minutes in the browser."
- "Why isn't my cache rule firing? Here is the config and a log line…"
- "Convert this nginx location block into a quayel config."
Keeping the skill current
The skill ships with the gateway repository and is versioned alongside the binary. When you upgrade Quayel Gateway, re-copy skills/quayel-gateway/ from the matching release so new fields and enum values are covered.