ASP.NET CORE AGENTS.MD

An ASP.NET Core web API in C# on current .NET. The rules make sure an agent respects nullable reference types, async all the way down, Entity Framework Core migrations and the built-in dependency injection.

Zero retention: everything you type stays in this browser. Verify it yourself in DevTools.
The ASP.NET Core filesCustomize in the generator
AGENTS.mdFor Codex, Cursor, Copilot, Jules, Windsurf and more
# AGENTS.md

Project: dotnet-api. An ASP.NET Core web API in C# with Entity Framework Core and SQL Server.

This file is the single source of truth for every coding agent working in this repository. The tool-specific files (CLAUDE.md, GEMINI.md, .github/copilot-instructions.md and .cursor/rules/project.mdc) point here. Edit this file, not those.

## Stack

- Language: C#
- Framework: ASP.NET Core
- Database: SQL Server
- Hosting: Azure
- Tests: xUnit
- Package manager: dotnet CLI / NuGet

## Commands

Run these from the repository root.

- Install dependencies: `dotnet restore`
- Run locally: `dotnet watch --project src/Api`
- Build: `dotnet build --no-restore`
- Run all tests: `dotnet test`
- Run one test file: `dotnet test --filter "FullyQualifiedName~OrderServiceTests"`
- Lint: `dotnet format --verify-no-changes`
- Format: `dotnet format`

## Project layout

- `src/Api/`: ASP.NET Core host: Program.cs, endpoints, middleware
- `src/Application/`: Use cases and services
- `src/Infrastructure/`: EF Core DbContext, migrations, external clients
- `tests/`: xUnit test projects
- `Directory.Build.props`: Shared build settings (Nullable, TreatWarningsAsErrors)

## Code style

- Indent with 4 spaces. Never tabs.
- Match the style and patterns of the surrounding code, even where you would personally choose differently.
- Prefer small pure functions and immutable data; keep side effects at the edges (handlers, jobs, I/O modules).
- Never swallow an error. Handle it where you can act on it, or rethrow it with context about what failed.
- Commit messages follow Conventional Commits: `feat:`, `fix:`, `refactor:`, `test:`, `docs:`, `chore:`, with an imperative summary under 72 characters.

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.

## Product constraints

- Validate all input at the boundary, use parameterized queries only, and treat every external payload as untrusted.

## Project-specific notes

- Nullable reference types are enabled. Do not silence warnings with `!` or `#nullable disable`; fix the nullability.
- Async all the way: never call `.Result` or `.Wait()` on a Task; pass `CancellationToken` through.
- Register services in `Program.cs` with the built-in container; never `new` up services that have dependencies.
- Schema changes use `dotnet ef migrations add <Name> --project src/Infrastructure --startup-project src/Api`; never edit an applied migration.
- Secrets come from user-secrets in development and environment variables or Key Vault in production, never `appsettings.json`.
- Endpoints take request DTOs and return response DTOs, never EF entities.
- Use `AsNoTracking()` for read-only queries.

## Project phase

This project is in active development. Follow the patterns that already exist; consistency beats novelty.
CLAUDE.mdFor Claude Code
# CLAUDE.md

@AGENTS.md

## Claude Code

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file, so every agent stays in sync.
- Put Claude-only preferences below this line. Personal, uncommitted notes belong in CLAUDE.local.md.
GEMINI.mdFor Gemini CLI
# GEMINI.md

@./AGENTS.md

## Gemini CLI

- The shared project instructions are imported from AGENTS.md on the line above. Edit AGENTS.md, not this file.
- Alternative: delete this file and set "context": { "fileName": ["AGENTS.md"] } in .gemini/settings.json so Gemini CLI reads AGENTS.md directly.
.github/copilot-instructions.mdFor GitHub Copilot
# Copilot instructions

Project: dotnet-api. An ASP.NET Core web API in C# with Entity Framework Core and SQL Server.

The full instructions are in AGENTS.md at the repository root. Read it before you change code; if anything here disagrees with it, AGENTS.md wins. The essentials are repeated below for Copilot surfaces that only read this file.

## Stack

- Language: C#
- Framework: ASP.NET Core
- Database: SQL Server
- Hosting: Azure
- Tests: xUnit
- Package manager: dotnet CLI / NuGet

## Commands

- Install dependencies: `dotnet restore`
- Run locally: `dotnet watch --project src/Api`
- Build: `dotnet build --no-restore`
- Run all tests: `dotnet test`
- Run one test file: `dotnet test --filter "FullyQualifiedName~OrderServiceTests"`
- Lint: `dotnet format --verify-no-changes`
- Format: `dotnet format`

## Working rules

- Before you say a task is done, run the test, lint and type-check commands above and make sure they pass. If you could not run them, say so.
- For a bug fix or behavior change, first write or update a test that fails, then make it pass.
- Never write secrets, API keys, tokens or passwords into code, tests, fixtures, logs or commits. Read them from environment variables, and never commit `.env` files.
- Do not add a new dependency without asking first. Prefer the standard library and what is already installed.
- Ask before creating, editing or running database migrations, and never edit a migration that has already been applied.
- Change only what the task needs. Do not refactor, rename or reformat unrelated code.
.cursor/rules/project.mdcFor Cursor
---
description: Project instructions for every task (mirrors AGENTS.md)
globs:
alwaysApply: true
---

# Project rules

The project instructions live in @AGENTS.md at the repository root, which Cursor loads automatically. They are not repeated here, so they cost context only once. Edit AGENTS.md, not this rule.

Before you change code, check the Commands and Working rules sections of AGENTS.md, and run its test and lint commands before you say a task is done.

Put Cursor-only rules below, or add scoped rules as more .mdc files with `globs` (for example `src/components/**/*.tsx`).

These are the exact files the generator writes for this preset. Change any command or rule in the generator and download your own set.

About the ASP.NET Core preset

What Is in the ASP.NET Core AGENTS.md?

The preset describes a an ASP.NET Core web API in C# with Entity Framework Core and SQL Server. Its AGENTS.md is 50 non-empty lines with 7 exact commands, 5 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: dotnet restore, dotnet watch --project src/Api, dotnet build --no-restore, dotnet test, dotnet test --filter "FullyQualifiedName~OrderServiceTests", dotnet format --verify-no-changes, dotnet format.
  • Layout: src/Api/, src/Application/, src/Infrastructure/, tests/, Directory.Build.props.
  • Wrappers: CLAUDE.md and GEMINI.md import AGENTS.md; the Copilot file repeats the essentials; the Cursor rule points to AGENTS.md.

Why These Rules for ASP.NET Core?

The null-forgiving operator hides bugs

Agents sprinkle ! to make warnings disappear. The warning was the bug report. Banning the shortcut forces a real fix such as a guard clause or a correct type.

Sync over async deadlocks

Blocking on a task with .Result can deadlock and always wastes a thread. It shows up when an agent calls async code from a sync method it did not want to change.

appsettings.json is committed

Connection strings with passwords end up in source control because the file is the obvious place to put them. User-secrets keep development values out of the repo.

EF entities are not contracts

Serializing entities exposes navigation properties and can cause cycles or huge payloads.

Which Stack Rules Does the File Add?

  • Nullable reference types are enabled. Do not silence warnings with ! or #nullable disable; fix the nullability.
  • Async all the way: never call .Result or .Wait() on a Task; pass CancellationToken through.
  • Register services in Program.cs with the built-in container; never new up services that have dependencies.
  • Schema changes use dotnet ef migrations add <Name> --project src/Infrastructure --startup-project src/Api; never edit an applied migration.
  • Secrets come from user-secrets in development and environment variables or Key Vault in production, never appsettings.json.
  • Endpoints take request DTOs and return response DTOs, never EF entities.
  • Use AsNoTracking() for read-only queries.

How Do You Add These Files to a ASP.NET Core Repository?

  1. Download the zip above. It is laid out exactly as the files go into the repository.
  2. Unzip it at the repository root. AGENTS.md, CLAUDE.md and GEMINI.md go next to your README; the Copilot file goes in .github/ and the Cursor rule in .cursor/rules/.
  3. Open AGENTS.md and check every command against your package scripts or Makefile.
  4. Delete wrappers for tools your team does not use, and any old .cursorrules or .windsurfrules file.
  5. Commit, then run the linter on AGENTS.md whenever you change it.

Want different commands or rules? Load this preset into the generator, change anything, and download your own set.

Which Agents Will Read These Files?

AGENTS.md is read directly by Codex, Cursor, Windsurf, Cline, Zed and Jules, and by GitHub Copilot's cloud agent, code review and CLI. Claude Code reads it through the generated CLAUDE.md, and Gemini CLI through GEMINI.md. See the compatibility table for details, last verified 2026-11-13.

Where Are the Other Stacks?

All presets are on the stacks page.

Frequently Asked Questions

Which .NET version is this for?

Current .NET with minimal APIs or controllers. The rules are version-independent; set your target framework in Directory.Build.props.

Why is lint dotnet format --verify-no-changes?

It checks formatting and analyzer style rules without changing files, so it fails when code is not formatted, which is what a lint step should do.

Does it work with NUnit or MSTest?

Yes. Choose the runner in the generator; dotnet test runs all of them and the filter syntax is the same.

Are these ASP.NET Core files free to use?

Yes. Copy them into any project, commercial or not, without attribution. They are a starting point: adjust the commands and rules to match your repository.

How Can You Verify That Nothing Leaves This Browser?

You do not have to take our word for it. Developer tools show every request a page makes, so you can watch this page work and confirm that nothing you type is sent. The check takes under a minute.

  1. Open your browser developer tools with F12, or Cmd+Option+I on a Mac, and select the Network tab.
  2. Reload the page and let it finish. You will see the page's own files, its web fonts, and one anonymous page-view request. Nothing has been typed yet, so none of them can contain your input.
  3. Click the clear icon in the Network tab so that the log is empty.
  4. Switch between the file tabs, copy a file and download the zip.
  5. Look at the Network tab again. It is still empty. Downloads are built in the page as Blob URLs, so even the zip never touches a server. For extra proof, turn on offline mode after the page loads: everything keeps working.

Only the feedback form can add a line to that log, and it sends only the vote and comment you type into it. 2prompt has no server code at all: no API, no model and no database of your files. The production site also sends a Content-Security-Policy header that tells your browser to refuse connections to anywhere except this site, the fonts and the anonymous analytics endpoint.

Was this helpful?