jamesblackwelljamesblackwell/falcondeck/extensions/AGENTS.md

falcondeck / extensions

AGENTS.md7 starsChanged 16 days agoMITView on GitHub

Read ../docs/EXTENSIONS.md before changing or creating an extension. - Import only @falcondeck/extension-sdk; never reach into app, daemon, SDK source paths, or private package modules. - Declare every action and published view in falcondeck.extension.json. - Put declarative contribution UI in the manifest's ui field and use only the versioned public vocabulary documented in docs/EXTENSIONS.md; defineExtensionUi is available when constructing the same documents in TS. - Declare a titled panels entry for a full-main-area surface. Desktop and web render the bounded document;…

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,542 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 repository25 other files it gives its agents.
- .agents/AGENTS.mdAGENTS.md
- AGENTS.mdAGENTS.md
- .agents/skills/autoreview/AGENTS.mdAGENTS.md
- .agents/skills/vercel-react-best-practices/AGENTS.mdAGENTS.md
- .agents/skills/vercel-react-native-skills/AGENTS.mdAGENTS.md
- autoreviewSkill
- axe-ios-simulatorSkill
- desktop-mac-releaseSkill
- deslopSkill
- dopplerSkill
- github-reference-finderSkill
- goal-writerSkill
- humanizerSkill
- just-say-no-to-process-pornSkill
- mobile-testflightSkill
- ntfySkill
- publish-reportSkill
- qa-spiderSkill
- rust-best-practicesSkill
- skill-creatorSkill
- systematic-debuggingSkill
- tldrSkill
- vercel-react-best-practicesSkill
- vercel-react-native-skillsSkill
- verified-bug-campaignSkill

The file

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

6 rules. About 0 are common, 0 are distinctive, and 6 are 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.
6
Very specific
Tied to their project's names, files or tools. Probably skip.

Common
Distinctive
Very specific

Very specific:
Read ../docs/EXTENSIONS.md before changing or creating an extension.
line 3
Very specific:
Import only @falcondeck/extension-sdk.
line 5
Very specific:
Put declarative contribution UI in the manifest's ui field and use only the versioned public vocabulary documented in docs/EXTENSIONS.md.
line 8
Very specific:
Keep private data in context.storage.
line 16
Very specific:
Use context.events.on(...) only for identifier-only lifecycle signals.
line 18
Very specific:
Run npm run extension:validate -- <package> --json, deno check --import-map=extensions/import-map.json on the entrypoint, and the relevant …
line 25

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

FalconDeck Extension Authoring

Read ../docs/EXTENSIONS.md before changing or creating an extension.

Import only @falcondeck/extension-sdk; never reach into app, daemon, SDK source paths, or private package modules.
Declare every action and published view in falcondeck.extension.json.
Put declarative contribution UI in the manifest's ui field and use only the versioned public vocabulary documented in docs/EXTENSIONS.md; defineExtensionUi is available when constructing the same documents in TS.
Declare a titled panels entry for a full-main-area surface. Desktop and web render the bounded document; mobile deliberately shows a visible fallback. The host owns the compact chrome (icon + title). Do not draw a second page h1. Directory panels use an inner max-w-4xl px-6 py-6 scroller; spatial tools (boards, split editors) fill the frame. See DESIGN.md “Main views”.
Keep private data in context.storage; publish only bounded, non-secret view projections needed by clients.
Use context.events.on(...) only for identifier-only lifecycle signals; dispose temporary subscriptions and query permission-gated facets for any user-visible thread data instead of assuming events contain it.
Declare threads:read before calling context.threads.list(). The call is denied until the user grants it and returns only bounded summaries, never prompts, messages, previews, or transcripts.
Request no permissions unless the capability genuinely needs them.
Run npm run extension:validate -- <package> --json, deno check --import-map=extensions/import-map.json on the entrypoint, and the relevant daemon/client tests before handoff.
Exercise backend behavior through @falcondeck/extension-testing; pass the manifest's declared action/view ids and permission grants to the fake host so undeclared work, denied reads, size limits, failures, and atomic rollback are tested.
Official extensions must prove public API behavior. Do not add a private daemon method or core thread field for their data.

Starter prompt for another coding agent:

Build a FalconDeck extension in this repository. Read docs/EXTENSIONS.md and extensions/AGENTS.md, use only packages/extension-sdk, declare every action and view in the manifest, validate it with npm run extension:validate, and test persistence, disabled behavior, malformed input, and every supported client presentation.

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