Add ODD to AGENTS.md, CLAUDE.md, or SKILL.md
Best-practice templates for telling coding agents (Claude Code, Cursor, Antigravity, etc.) when and how to consult Open Data Dictionary.
Coding agents read instruction files like AGENTS.md, CLAUDE.md, and SKILL.md before they touch your codebase. Adding a short, well-placed section that points at Open Data Dictionary turns "the agent guesses a column definition" into "the agent calls get_word and uses the canonical one."
This page gives you copy-pasteable templates and the principles behind them.
Which file should I use?
| File | Read by | Purpose |
|---|---|---|
AGENTS.md | Most coding agents (Antigravity, Cursor, Codex, etc.) following the emerging AGENTS.md convention | A human-readable README aimed at agents. Commit it at the repo root. |
CLAUDE.md | Claude Code | Claude Code's project-specific instruction file. Lives at the repo root (or in ~/.claude/ for user-level). |
SKILL.md | Claude Skills | Describes a single skill — required frontmatter (name, description) plus freeform body. Lives in a skill directory. |
These files are not mutually exclusive. Many projects ship a primary AGENTS.md and a thin CLAUDE.md that says "see AGENTS.md." Agents that read neither will just ignore the file.
Principles
- Be specific about when to call ODD. Agents over-consult any tool you describe vaguely. Tell them the trigger: "when you need a column definition, data type, or synonym."
- Point at the tools by name.
search_words,get_word,list_categories,get_synonyms, andget_schemaare the MCP tool names — agents use them verbatim. - Distinguish MCP from the public API. If the agent already has an MCP client, prefer MCP. If it only has HTTP (no MCP runtime), use the REST API with a Bearer token.
- Never put the token in the file. Always reference an environment variable. Committed tokens get revoked.
- Keep it short. Instruction files compete for context-window budget. A 10-line section that the agent actually reads beats a 200-line one it truncates.
Template: AGENTS.md section
Drop this into an existing AGENTS.md under a heading such as ## Data terminology.
Template: CLAUDE.md section
Same content, tuned for Claude Code's tone. Claude Code follows imperative "when X, do Y" style well.
See the Claude Desktop Setup, Claude Code (docs), Cursor IDE, and Google Antigravity pages for client-specific configuration.
Template: SKILL.md for a Claude Skill
If you package ODD lookup as a Claude Skill, the skill directory needs a SKILL.md with YAML frontmatter. The frontmatter is mandatory; the body is freeform instructions the skill owner can load.
Token hygiene
- Store the token in an environment variable such as
ODD_API_TOKEN. - Reference the variable name in your instruction file, not the value.
- Rotate the token immediately via Settings if it is ever pasted into a chat, issue, or commit.