agentleFS
NeoVandNeoVand/op-xy-agent/AGENTS.md

op-xy-agent

AGENTS.md1 starsChanged 48 days agoMITView on GitHub

An open-source, browser-only (static SvelteKit) app: a pixel-perfect interactive replica of the Teenage Engineering OP-XY plus an AI agent that answers anything from the official manual, teaches, and programs the real device over Web MIDI / USB. Bring-your-own API keys (Claude first, OpenAI realtime voice second). After any context reset, re-read in order: docs/VISION.md (north star) → docs/PLAN.md (roadmap + current phase) → docs/research/INDEX.md (what we know and where) → docs/QUESTIONS.md. Before writing code, read docs/ARCHITECTURE.md (layers, safety choke point,…

  • Reads credentials

The file

We split this AGENTS.md into the rules it gives an agent

9 rules. About 0 are common, 5 are distinctive, and 4 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Very specific:

    Before writing code, read docs/ARCHITECTURE.md (layers, safety choke point, conventions).

    line 10
  2. Very specific:

    Device safety: read-only probes are fine.

    line 26
  3. Very specific:

    After changing the agent, its tools or skills, or the app around them, probe it: talk to the real agent on the built site (node …

    line 31
  4. Very specific:

    Never print or commit .env values (ANTHROPIC_API_KEY, OPENAI_API_KEY).

    line 35
  5. Distinctive:

    Commit and push to main at milestones (pre-production).

    line 38
  6. Distinctive:

    Use this FIRST to discover all available documentation sections.

    line 54
  7. Distinctive:

    When asked about Svelte or SvelteKit topics, ALWAYS use this tool at the start of the chat to find relevant sections.

    line 55
  8. Distinctive:

    After calling the list-sections tool, you MUST analyze the returned documentation sections (especially the use_cases field) and then use …

    line 60
  9. Distinctive:

    After completing the code, ask the user if they want a playground link.

    line 70

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

OP-XY Agent — read this first

An open-source, browser-only (static SvelteKit) app: a pixel-perfect interactive replica of the Teenage Engineering OP-XY plus an AI agent that answers anything from the official manual, teaches, and programs the real device over Web MIDI / USB. Bring-your-own API keys (Claude first, OpenAI realtime voice second).

After any context reset, re-read in order: docs/VISION.md (north star) → docs/PLAN.md (roadmap + current phase) → docs/research/INDEX.md (what we know and where) → docs/QUESTIONS.md. Before writing code, read docs/ARCHITECTURE.md (layers, safety choke point, conventions).

Where things live:

  • docs/research/NN-*.md — our research notes (committed). docs/research/90-device-probe.md logs every message ever sent to the owner's device.
  • knowledge/ — curated machine-readable data the app ships (CC maps, schemas, …). knowledge/official/ is the verbatim scrape of TE's manual: always git-ignored, source material only. The app ships our own reworded, agent-friendly manual (knowledge/manual/, see docs/DECISIONS.md D2). Never commit or ship verbatim TE manual text.
  • Reference firmware: OS 1.1.33 (owner's device). Decisions log: docs/DECISIONS.md.
  • research/repos/ — shallow clones of community projects (git-ignored; scripts/fetch-research.sh). research/firmware/ — public firmware downloads (git-ignored). research/device/ — probe scripts.

Rules:

  • Device safety: read-only probes are fine; announce anything that changes device state (settings, projects, files, playback) to the owner first and log it in 90-device-probe.md. Never flash firmware or send firmware-updater SysEx.
  • The LLM never writes raw bytes: it emits typed intent; deterministic, tested TS code produces MIDI, .xy and preset files.
  • After changing the agent, its tools or skills, or the app around them, probe it: talk to the real agent on the built site (node evals/agent/probe.mjs serve, then say, press, debrief) with real user tasks, read every tool result, and end with the debrief question. Unit tests check what we imagined; the owner's own sessions found what they missed.
  • Never print or commit .env values (ANTHROPIC_API_KEY, OPENAI_API_KEY).
  • Code from repos without a license is reference-only; MIT code (e.g. kmorrill/xy-format) may be ported with attribution.
  • Commit and push to main at milestones (pre-production).

Project Configuration

  • Language: TypeScript
  • Package Manager: pnpm
  • Add-ons: prettier, eslint, vitest, playwright, tailwindcss, sveltekit-adapter, ai-tools

You are able to use the Svelte MCP server, where you have access to comprehensive Svelte 5 and SvelteKit documentation. Here's how to use the available tools effectively:

Available Svelte MCP Tools:

1. list-sections

Use this FIRST to discover all available documentation sections. Returns a structured list with titles, use_cases, and paths. When asked about Svelte or SvelteKit topics, ALWAYS use this tool at the start of the chat to find relevant sections.

2. get-documentation

Retrieves full documentation content for specific sections. Accepts single or multiple sections. After calling the list-sections tool, you MUST analyze the returned documentation sections (especially the use_cases field) and then use the get-documentation tool to fetch ALL documentation sections that are relevant for the user's task.

3. svelte-autofixer

Analyzes Svelte code and returns issues and suggestions. You MUST use this tool whenever writing Svelte code before sending it to the user. Keep calling it until no issues or suggestions are returned.

4. playground-link

Generates a Svelte Playground link with the provided code. After completing the code, ask the user if they want a playground link. Only call this tool after user confirmation and NEVER if code was written to files in their project.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.