AGENTS.md Snippet

To let an AI coding agent work with Framedash in your repo, paste the block below into your AGENTS.md (for Codex and others) or CLAUDE.md (for Claude Code). It puts the docs, CLI, MCP server, and environment variables in one place.

## Framedash telemetry

Framedash is this project's game telemetry service.

- Docs: https://docs.framedash.dev
- Machine-readable index: https://docs.framedash.dev/llms.txt
- CLI: `npm i -g @framedash/cli`, then `framedash --help`
- MCP server (stdio): `npx -y @framedash/mcp-server`

Environment variables (never hardcode keys):

- FRAMEDASH_API_KEY: API key with the scopes you need
- FRAMEDASH_PROJECT_ID: default project UUID (optional)

To query telemetry, use `framedash query` or the MCP `query` tool.

Event columns: https://docs.framedash.dev/api/events-schema/

Do not commit FRAMEDASH_API_KEY; pass it via an environment variable or a secret manager.

Where It Goes per Agent

• Codex CLI: AGENTS.md at the repo root. See Codex CLI for setup.
• Claude Code: CLAUDE.md at the repo root, or the Claude Code Plugin.