What is agent-kit AGENTS.md?

A repository instruction file for a project with a FastAPI backend, a Next.js frontend, database migrations, tests, and documentation. It describes the project layout, commands, coding rules, and testing practices.

Use it when installing, running, building, testing, linting, or modifying this full-stack project.

It gives the coding agent the project's working conventions and reduces errors when changing different parts of the application.

How leemysw/agent-kit configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to leemysw/agent-kit. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/leemysw/agent-kit/main/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/leemysw/agent-kit

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/leemysw/agent-kit/agents-md/github.svg)](https://agentmods.dev/instructions/leemysw/agent-kit/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/leemysw/agent-kit/agents-md"><img src="https://agentmods.dev/badge/instructions/leemysw/agent-kit/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/leemysw/agent-kit/agents-md"><img src="https://agentmods.dev/badge/instructions/leemysw/agent-kit/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 578 This file is loaded in full into every session.

When invoked 578 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.00578	$0.00578
Opus 5.5	$0.00231	$0.00231
Sonnet 5.5	$0.00116	$0.00116
Haiku 4.5	$0.00058	$0.00058

Measured 2mo ago against content hash a67572d4da08, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

agent-kit AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 44 lines

How it starts

The opening of the file, as written. The whole thing — 44 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Repository Guidelines

Project Structure & Module Organization

agent/ contains the FastAPI backend, WebSocket flow, session management, and persistence (service/, api/, shared/, utils/).
web/ is the Next.js frontend (src/components, src/hooks, src/lib, src/store).
alembic/ stores database migrations; keep schema changes and migration files in the same PR.
tests/ currently holds integration-style scripts and runtime logs (for example, interrupt/session behavior).
docs/ includes architecture and feature guides; update docs when behavior or API contracts change.

Build, Test, and Development Commands

make install: install backend (agent/requirements.txt) and frontend dependencies.
make dev: run backend (python main.py) and frontend (cd web && npm run dev) together.
make run-backend / make run-web: run one side only.
alembic upgrade head: apply latest DB migrations.
cd web && npm run build: production frontend build.
cd web && npm run lint: frontend lint check.
python -m py_compile agent/...: fast backend syntax smoke check.
cd web && npx tsc --noEmit: TypeScript type check.

Coding Style & Naming Conventions

Python: follow Google Python style, object-oriented design, and use Chinese comments for non-trivial logic. Use snake_case for functions/files and PascalCase for classes.
TypeScript/React: components in PascalCase, hooks in useXxx style, and keep message/session types centralized under web/src/types.
Prefer small, composable handlers/processors over monolithic functions.

Testing Guidelines

This repository mainly uses integration-style validation instead of heavy unit coverage.
Primary checks before PR:

backend compile smoke check (py_compile);
frontend type/lint checks (tsc, eslint);
targeted manual flow test for chat/interrupt/session history.
Add new tests under tests/ with test_<feature>.py naming.

Commit & Pull Request Guidelines

History favors emoji-prefixed Conventional-style subjects (for example, :sparkles:, :bug:, :recycle:, :memo:) with concise Chinese summaries.
PRs should include:

problem statement and scope;
key file/path changes;
commands run for validation;
screenshots for UI changes and sample logs for message/session pipeline updates;
migration/environment notes when applicable.

Read the full file on GitHub · 44 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

2mo ago First seen · 44 lines · 578 tokens per session scan A a67572d4da08

Subscribe to this mod's changes

agent-kit AGENTS.md is an instructions file published in the GitHub repository leemysw/agent-kit (57 stars, last pushed 7mo ago), licensed Apache-2.0. It adds 578 tokens to every session, about $0.0023 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

agent agent-kit ai claude-agent-sdk coworking tool

agent-kit AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
agent-kit AGENTS.mdleemysw/agent-kit	Instructions file	57	7mo ago	Apache-2.0	A	578	Codex, OpenCode
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

agent-kit: Instructions file for Codex