agentleFS
Sign inStart free
harukikuriharukikuri/spotnote/AGENTS.md

spotnote

AGENTS.md25 starsChanged 24 days agoMITView on GitHub

Spotnote is a dev-only Vite plugin (package/, published as spotnote) and the MCP server agents start (mcp/, published as spotnote-mcp). The layout, the commands and the release steps are in DEVELOPMENT.md: read it first. Run all three for any change under package/ or mcp/. A UI change gets an E2E test in e2e/spotnote.spec.js (or e2e/agent.spec.js when the agent is in it). The E2E tests run in an app per framework version (React 17–19, Vue 3.2–3.5, Svelte 4–5, Solid, Astro 5–7,…

  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,700 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository7 other files it gives its agents.

The file

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

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run all three for any change under package/ or mcp/.

    line 16

≈ “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

Agent instructions

Spotnote is a dev-only Vite plugin (package/, published as spotnote) and the MCP server agents start (mcp/, published as spotnote-mcp). The layout, the commands and the release steps are in DEVELOPMENT.md: read it first.

Before you commit

pnpm lint        # Biome: format + lint (pnpm format applies the fixes)
pnpm test        # unit tests: package + mcp (node:test)
pnpm test:e2e    # browser tests, every example app (Playwright)

Run all three for any change under package/ or mcp/. A UI change gets an E2E test in e2e/spotnote.spec.js (or e2e/agent.spec.js when the agent is in it). The E2E tests run in an app per framework version (React 17–19, Vue 3.2–3.5, Svelte 4–5, Solid, Astro 5–7, on Vite 5–8; and SvelteKit, Nuxt, React Router and SolidStart, two majors each): pick elements through app.title / app.repeated, not one app's markup. Edit the newest app of a framework and run node examples/sync.mjs to copy it to the others.

Conventions

  • Pre-1.0: change the note format, the wire format and stored data directly. No fallbacks for an older spotnote-mcp or old saved notes; spotnote and spotnote-mcp always ship together, at the same version.
  • TypeScript that Node runs as is (type stripping, Node 22.18 or later): no build while you work. Only syntax Node can erase (no enums, namespaces or parameter properties), imports name their .ts files, and unknown over any. npm gets a build: tsc to dist/, swapped in by publishConfig when the release packs it. Both packages are TypeScript.
  • Comments say what a piece is for and why, in short plain sentences; match the density of the code around them.
  • A change users see updates its page in docs/content/docs/ in the same commit, and its screenshot in docs/public/ if it shows the change.
  • Commits: feat:, fix:, perf:, docs:, test:, ci:, chore:, release:. The release notes are made from feat:, fix: and perf:, so write those for users.

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.

Check your setup, free