agentleFS
Sign inStart free
VercelKnown publishervercel-labs/eve-sre-agent-template/AGENTS.md

eve-sre-agent-template

AGENTS.md13 starsChanged 3 months agoMITView on GitHub

Guidance for AI coding agents working in this repository. sre is a Slack incident response agent built on eve. It pulls evidence from Datadog, GitHub, Slack, and Vercel. The agent lives under agent/. When the user asks you to set up the project, follow docs/setup-for-agents.md. You are already at the repo root. Do not use the Deploy button. When the user asks for automated investigations, follow docs/automate-investigations.md only after Slack replies work.

  • Reads credentials
  • Installs packages
  • 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 repository4 other files it gives its agents.

The file

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

7 rules. About 1 is common, 1 is distinctive, and 5 are very specific to this project.

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 5

    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:

    When the user asks you to set up the project, follow docs/setup-for-agents.md.

    line 11
  2. Very specific:

    When the user asks for automated investigations, follow docs/automate-investigations.md only after Slack replies work.

    line 13
  3. Distinctive:

    Do not hard-wrap prose in markdown files.

    line 31
  4. Common:

    Never ask the user to paste secrets into chat.

    line 35
  5. Very specific:

    Never commit secrets. .env* is gitignored.

    line 37
  6. Very specific:

    If you build a RegExp from data, escape it for a literal match and bound the input length.

    line 40
  7. Very specific:

    No secrets, node_modules, or build output (.eve, .vercel, .output) staged.

    line 45

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

AGENTS.md

Guidance for AI coding agents working in this repository.

Project overview

sre is a Slack incident response agent built on eve. It pulls evidence from Datadog, GitHub, Slack, and Vercel. The agent lives under agent/.

Setup & commands

When the user asks you to set up the project, follow docs/setup-for-agents.md. You are already at the repo root. Do not use the Deploy button.

When the user asks for automated investigations, follow docs/automate-investigations.md only after Slack replies work.

pnpm install          # Node 24.x (see .nvmrc)
pnpm dev              # eve TUI; run /model once to link a provider
pnpm typecheck        # tsc (TypeScript, no emit)
pnpm check            # ultracite (Biome) lint + format check
pnpm fix              # ultracite (Biome) auto-fix
pnpm test             # agent/**/*.test.ts
pnpm validate         # check + typecheck + eve info
pnpm exec eve deploy  # production deploy; do not use raw vercel deploy --prod

Code style

  • Linting and formatting are handled by Ultracite (a Biome preset). Run pnpm check before you finish. Run pnpm fix to auto-fix. Config is in biome.jsonc. The kebab-case filename rule is off because eve tools use snake_case names.
  • TypeScript is strict. The project uses ESM with NodeNext resolution. Relative imports use a .ts extension (allowImportingTsExtensions). Prefer const, arrow functions, optional chaining, and nullish coalescing.
  • Validate tool input and output with zod schemas.
  • Do not hard-wrap prose in markdown files. Write each paragraph or bullet as one line.

Security

  • Never ask the user to paste secrets into chat.
  • The user sets secrets with vercel env add or the Vercel project env UI. Never read .env files.
  • Never commit secrets. .env* is gitignored. .env.example is the exception.
  • Connector UIDs come from env (SLACK_CONNECTOR, GITHUB_CONNECTOR, DATADOG_CONNECTOR). Auth is brokered by Vercel Connect. Tokens are resolved per call and are not exposed to the model.
  • WEBHOOK_SECRET is a shared secret for POST /v1/investigate. Do not put it in chat, commits, or logs.
  • If you build a RegExp from data, escape it for a literal match and bound the input length.

Before committing

  • pnpm validate passes (Ultracite check, tsc, and eve info with 0 errors / 0 warnings).
  • No secrets, node_modules, or build output (.eve, .vercel, .output) staged.

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