grok-faf-mcp
AGENTS.md19 starsChanged 10 months agoMITView on GitHub
Persistent project context for xAI Grok. The first MCP for Grok — Grok asked for MCP on a URL. — TypeScript · type: mcp · v2.2.4 Authored by faf — do not edit the managed block; refresh with faf export --agents. Hand-written content outside the managed block is preserved. Done when: npm run lint exits 0 · npm run test passes · changes committed with a conventional message. Ask a clarifying question, propose a short plan, or open a draft…
- Reads credentials
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 33,315 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 repository2 other files it gives its agents.
- CLAUDE.mdCLAUDE.md
- faf-expertSkill
The file
We split this AGENTS.md into the rules it gives an agent
3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈1
Distinctive · estimate
This author's own choices. Worth a look.
2
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Very specific: line 44
Always OK: read the tree · run the tests (npm run test) · build the project · npm run lint.
- Distinctive: line 54
Ask a clarifying question, propose a short plan, or open a draft PR with notes — do not push large speculative changes to main.
- Very specific: line 64
If build/test scripts or layout change, refresh this file in the same PR (faf export --agents).
≈ “Common” is an estimate: at least 1 in 5 of the 42,283 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.
Files
<!-- faf:start --><!-- faf: grok-faf-mcp | TypeScript | mcp | Persistent project context for xAI Grok. The first MCP for Grok — Grok asked for MCP on a URL. --><!-- faf: claim=project.faf | family=FAF -->AGENTS.md — grok-faf-mcp
Persistent project context for xAI Grok. The first MCP for Grok — Grok asked for MCP on a URL. — TypeScript · type: mcp · v2.2.4
Authored by faf — do not edit the managed block; refresh with
faf export --agents. Hand-written content outside the managed block is preserved.
Setup & build
npm run build # build
npm run dev # dev
npm run start # startRun the tests
npm run test
npm run lintWhere things live
package.jsonsrc/index.tssrc/index.jssrc/cli.tsREADME.mdtsconfig.jsonwrangler.tomlvercel.json
Conventions
- TypeScript strict mode (tsconfig.json)
- Style enforced by ESLint · Prettier — obey the configs
Guardrails
- Always OK: read the tree · run the tests (
npm run test) · build the project ·npm run lint. - Ask first: dependency installs, deletions, migrations, schema changes, publish/release.
- Never: force-push · push straight to
main(branch and open a PR) · commit secrets.
Definition of Done
Done when: npm run lint exits 0 · npm run test passes · changes committed with a conventional message.
When stuck
Ask a clarifying question, propose a short plan, or open a draft PR with notes — do not push large speculative changes to main.
Security & secrets
- Secrets live in
.env. Never read or commit them.
Commit & PR
- Conventional Commits preferred (
feat:,fix:,chore:, …). - Branch off
mainand open a PR — never commit tomaindirectly. - If build/test scripts or layout change, refresh this file in the same PR (
faf export --agents).
Stack
- Backend: MCP SDK (TS)
- API: MCP (stdio + Streamable HTTP)
- Runtime: Node.js
- Hosting: Cloudflare Workers
- Build: TypeScript (tsc)
- CI/CD: GitHub Actions
<!-- faf:end -->Cursor Cloud specific instructions
- Node 22 or later matches the engine floor.
npm ciinstalls dependencies and builds through thepreparescript (npm run build). npm testrunsscripts/run-tests.shwith Bun 1.3.13, the version CI pins. Link that binary at/usr/local/bin/bun. Login shells skip~/.bashrc, where the Bun installer appends PATH.- The local server speaks MCP over stdio:
node dist/src/index.js.--versionand--helpprint and exit before the protocol starts. A working session is initialize,tools/list, thenfaf_scoreagainst this repo'sproject.faf.
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
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.

