Agents
Runtimes & Install
The Topaz agent skill is runtime-neutral — every agent loads context a little differently. This page lists the three loading patterns, the conventional install paths per runtime, and the prompt templates that work.
Pick a loading pattern
Three patterns cover essentially every agent runtime that exists today:
| Parameter | Value | Description |
|---|---|---|
| Read from URL | https://topazdex.com/skill.md | Best for browser agents, chat agents, and anything with a web-fetch tool. |
| Clone the repo | github.com/topazdex/agent-skill | Best for coding agents and CLI agents. Includes references, examples, evals, and TypeScript helpers. |
| Native skill / rules | <runtime>/skills/topaz | For agents with their own skill, rule, or memory system — copy in and point at the repo for support files. |
Conventional install locations
If you want the skill on disk for an agent that reads from a well-known directory, these are the conventions per runtime. They are not requirements — any path works, as long as you point the agent at it.
| Parameter | Value |
|---|---|
| Claude Code (user-wide) | ~/.claude/skills/topaz |
| Claude Code (project-local) | <your-project>/.claude/skills/topaz |
| OpenCode | ~/.config/opencode/skills/topaz |
| Hermes | ~/.hermes/skills/defi/topaz |
| Codex / Cursor / Continue / Aider | any path — reference it explicitly |
| Browser-only agents | https://topazdex.com/skill.md (no install) |
One-line installer
The repo ships an installer that auto-detects an existing agent skills directory and installs there. Detection order:
~/.claude/skills/exists →~/.claude/skills/topaz~/.config/opencode/skills/exists →~/.config/opencode/skills/topaz~/.hermes/skills/exists →~/.hermes/skills/defi/topaz- None of the above → fallback to
~/.local/share/topaz-skill(installer prints a notice asking you to wire the agent at that path)
The installer prints its chosen destination and the reason before cloning. Pass an explicit path to override detection.
# auto-detect destination
curl -fsSL https://raw.githubusercontent.com/topazdex/agent-skill/main/install.sh | bash
# explicit path
curl -fsSL https://raw.githubusercontent.com/topazdex/agent-skill/main/install.sh \
| bash -s -- ~/some/other/pathManual install via git
Equivalent to the installer if you prefer to clone manually.
git clone https://github.com/topazdex/agent-skill.git <dest>
cd <dest>/scripts
cp .env.example .env # set BSC_RPC_URL; PRIVATE_KEY only needed for writes
yarn install --immutable
yarn validate && yarn smokeyarn smoke does a live read against BSC mainnet and confirms the helpers, ABIs, and subgraph queries work end-to-end. It requires BSC_RPC_URL in scripts/.env; no private key is needed for reads.Prompt templates
Generic prompts that work across runtimes. Adapt the wording to your agent's conventions if it prefers a specific style.
URL-reading agents
Read the official Topaz Dex agent skill at
https://topazdex.com/skill.md and follow it when working
with Topaz Dex swaps, pools, gauges, bribes, veNFTs,
rewards, quotes, routes, or integrations.Git-capable coding agents
Clone https://github.com/topazdex/agent-skill and follow
SKILL.md. Use references, examples, and scripts from the
cloned repo when available.Claude Code
Read https://topazdex.com/skill.md. If more detail is
needed, clone https://github.com/topazdex/agent-skill into
~/.claude/skills/topaz (or .claude/skills/topaz for
project-local) and follow SKILL.md as guidance for Topaz
Dex tasks.Codex / Cursor / Continue / generic
Use https://topazdex.com/skill.md as the Topaz Dex
protocol guide. For full references and scripts, clone
https://github.com/topazdex/agent-skill.Updating an installed skill
If you cloned the repo:
git -C <dest> pull --ff-only
# or the wrapper:
bash <dest>/update.sh
# check if an update is available without applying it
cd <dest> && bash tools/check_update.sh
# exit 0 = up to date, 10 = update availableAgents that loaded the skill from a URL can refetch /skill.md or compare their installed version against /skill.json.