netresearch/agent-rules-skill / skills/agent-rules
agent-rules
FlaggedUse when creating or updating AGENTS.md files, .github/copilot-instructions.md, or other AI agent rule files, onboarding AI agents to a project, standardizing agent documentation, or when anyone mentions AGENTS.md, agent rules, project onboarding, or codebase documentation for AI agents.
references/examples/express-api-ts/src/AGENTS.md
View on GitHub<!-- Managed by agent: keep sections and order; edit content, not structure. Last updated: 2026-02-05 -->
# AGENTS.md — src
<!-- AGENTS-GENERATED:START overview -->
## Overview
Backend services (TypeScript/Node.js)
<!-- AGENTS-GENERATED:END overview -->
<!-- AGENTS-GENERATED:START filemap -->
## Key Files
| File | Purpose |
|------|---------|
| `src/config.ts` | (add description) |
| `src/routes/health.ts` | Add database connectivity check here |
| `src/routes/users.ts` | (add description) |
| `src/index.ts` | Middleware |
| `src/utils/logger.ts` | (add description) |
<!-- AGENTS-GENERATED:END filemap -->
<!-- AGENTS-GENERATED:START golden-samples -->
## Golden Samples (follow these patterns)
| Pattern | Reference |
|---------|-----------|
| Standard implementation | `src/controllers/userController.ts` |
<!-- AGENTS-GENERATED:END golden-samples -->
<!-- AGENTS-GENERATED:START setup -->
## Setup & environment
- Install: `pnpm install`
- Node version: >=20.0.0
- Package manager: pnpm
- Environment variables: See .env or .env.example
<!-- AGENTS-GENERATED:END setup -->
<!-- AGENTS-GENERATED:START commands -->
## Build & tests
- Typecheck (project-wide): `pnpm typecheck`
- Format: `pnpm format`
- Lint: `pnpm lint`
- Test: `pnpm test`
- Build: `pnpm build`
- Dev server: `pnpm dev`
<!-- AGENTS-GENERATED:END commands -->
<!-- AGENTS-GENERATED:START code-style -->
## Code style & conventions
- Use TypeScript strict mode (`strict: true` in tsconfig)
- No `any` without explicit justification comment
- Prefer `interface` over `type` for object shapes
- Naming: `camelCase` for functions/vars, `PascalCase` for classes/types
- Async/await over raw Promises
- Prefer `const` over `let`, never use `var`
- Destructure objects and arrays when appropriate
<!-- AGENTS-GENERATED:END code-style -->
<!-- AGENTS-GENERATED:START security -->
## Security & safety
- Validate all user inputs (use zod or similar)
- Parameterized queries only (no string concatenation)
- Never use dynamic code execution with user data
- Sensitive data: never log or expose in errors
- Environment: use dotenv, never hardcode secrets
- CORS: configure explicitly, no wildcard in production
- Rate limiting: implement for public endpoints
<!-- AGENTS-GENERATED:END security -->
<!-- AGENTS-GENERATED:START checklist -->
## PR/commit checklist
- [ ] Tests pass: `pnpm test`
- [ ] Type check clean: `pnpm typecheck`
- [ ] Lint clean: `pnpm lint`
- [ ] Formatted: `pnpm format`
- [ ] No `any` types without justification
- [ ] API endpoints have validation
- [ ] Error responses don't leak internals
<!-- AGENTS-GENERATED:END checklist -->
<!-- AGENTS-GENERATED:START examples -->
## Patterns to Follow
> **Prefer looking at real code in this repo over generic examples.**
> See **Golden Samples** section above for files that demonstrate correct patterns.
<!-- AGENTS-GENERATED:END examples -->
<!-- AGENTS-GENERATED:START help -->
## When stuck
- Check Node.js docs: https://nodejs.org/docs
- TypeScript handbook: https://www.typescriptlang.org/docs
- Review existing patterns in this codebase
- Check root AGENTS.md for project-wide conventions
<!-- AGENTS-GENERATED:END help -->
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 468k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 197k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 197k | Updated | Claude CodeCodex | Verified | Install |