Spring Boot + Docker rules for AI coding agents
Full stack: Java + Spring Boot + Docker
Ready-to-commit rules for Java + Spring Boot + Docker in every major format: AGENTS.md (Codex, Cursor, Copilot), CLAUDE.md (Claude Code), Cursor .mdc project rules, legacy .cursorrules, Copilot instructions, Windsurf rules and GEMINI.md. A Java Spring Boot REST service.
Last reviewed 2026-10-21 · Customise in the generator · Raw: AGENTS.md, CLAUDE.md
The mistake agents make most on this stack
Agents expose JPA entities directly and use field injection.
Generated files
AGENTS.md
# AGENTS.md - this project
Instructions for AI coding agents working in this repository.
## Project
A Java + Spring Boot + Docker project.
Stack: Java + Spring Boot, Docker.
## Commands
- Run: `./mvnw spring-boot:run`
- Tests: `./mvnw test`
- Local services: `docker compose up -d`
## Project structure
- Package by feature (`user/`, `order/`), each with controller, service, repository and DTOs.
## How to work in this repo
- Read the relevant files before editing. Follow the patterns already in the codebase over these generic rules.
- Make the smallest change that solves the task. Do not refactor or reformat unrelated code.
- Before saying a task is done, run the type-check, lint and tests listed under Commands and fix what you broke.
- If requirements are ambiguous, ask one clear question instead of guessing.
- Never commit secrets, API keys or `.env` files. Use env vars and keep `.env.example` up to date.
- Do not add a new dependency when the standard library or an existing dependency already covers it.
- Ask before adding, removing or upgrading any dependency.
- Ask before changing database schemas, auth, payments or CI configuration.
- Never delete files, drop data or run destructive commands (`rm -rf`, `git push --force`, `DROP TABLE`) without explicit approval.
- Keep each change under ~200 changed lines where possible; split larger work into steps.
## Java + Spring Boot
- Use constructor injection (final fields). No field `@Autowired`.
- Use Java records for DTOs; never expose JPA entities directly from controllers.
- Validate request bodies with Jakarta Bean Validation (`@Valid`, `@NotBlank`, ...).
- Put `@Transactional` on service methods, not controllers.
- Handle errors in one `@RestControllerAdvice` returning `ProblemDetail`.
- Configuration via `application.yml` plus env vars; no secrets in the repo.
- Use the build tool wrapper in the repo (`./mvnw` or `./gradlew`), whichever exists.
## Docker
- Use multi-stage builds and slim, pinned base images.
- Run the app as a non-root user in the final image.
- Keep a `.dockerignore` that excludes `.git`, `node_modules`, `.env` and build output.
- Never bake secrets into images; pass them at runtime.
## Reference docs
- [Spring Boot docs](https://docs.spring.io/spring-boot/)
- [Dockerfile best practices](https://docs.docker.com/build/building/best-practices/)
CLAUDE.md
# CLAUDE.md - this project
Project instructions for Claude Code.
## Project
A Java + Spring Boot + Docker project.
Stack: Java + Spring Boot, Docker.
## Commands
- Run: `./mvnw spring-boot:run`
- Tests: `./mvnw test`
- Local services: `docker compose up -d`
## Project structure
- Package by feature (`user/`, `order/`), each with controller, service, repository and DTOs.
## How to work in this repo
- Read the relevant files before editing. Follow the patterns already in the codebase over these generic rules.
- Make the smallest change that solves the task. Do not refactor or reformat unrelated code.
- Before saying a task is done, run the type-check, lint and tests listed under Commands and fix what you broke.
- If requirements are ambiguous, ask one clear question instead of guessing.
- Never commit secrets, API keys or `.env` files. Use env vars and keep `.env.example` up to date.
- Do not add a new dependency when the standard library or an existing dependency already covers it.
- Ask before adding, removing or upgrading any dependency.
- Ask before changing database schemas, auth, payments or CI configuration.
- Never delete files, drop data or run destructive commands (`rm -rf`, `git push --force`, `DROP TABLE`) without explicit approval.
- Keep each change under ~200 changed lines where possible; split larger work into steps.
## Java + Spring Boot
- Use constructor injection (final fields). No field `@Autowired`.
- Use Java records for DTOs; never expose JPA entities directly from controllers.
- Validate request bodies with Jakarta Bean Validation (`@Valid`, `@NotBlank`, ...).
- Put `@Transactional` on service methods, not controllers.
- Handle errors in one `@RestControllerAdvice` returning `ProblemDetail`.
- Configuration via `application.yml` plus env vars; no secrets in the repo.
- Use the build tool wrapper in the repo (`./mvnw` or `./gradlew`), whichever exists.
## Docker
- Use multi-stage builds and slim, pinned base images.
- Run the app as a non-root user in the final image.
- Keep a `.dockerignore` that excludes `.git`, `node_modules`, `.env` and build output.
- Never bake secrets into images; pass them at runtime.
## Reference docs
- [Spring Boot docs](https://docs.spring.io/spring-boot/)
- [Dockerfile best practices](https://docs.docker.com/build/building/best-practices/)
.cursor/rules/project.mdc
---
description: "Core rules for this project"
alwaysApply: true
---
# this project
A Java + Spring Boot + Docker project.
Stack: Java + Spring Boot, Docker.
## Commands
- Run: `./mvnw spring-boot:run`
- Tests: `./mvnw test`
- Local services: `docker compose up -d`
## How to work in this repo
- Read the relevant files before editing. Follow the patterns already in the codebase over these generic rules.
- Make the smallest change that solves the task. Do not refactor or reformat unrelated code.
- Before saying a task is done, run the type-check, lint and tests listed under Commands and fix what you broke.
- If requirements are ambiguous, ask one clear question instead of guessing.
- Never commit secrets, API keys or `.env` files. Use env vars and keep `.env.example` up to date.
- Do not add a new dependency when the standard library or an existing dependency already covers it.
- Ask before adding, removing or upgrading any dependency.
- Ask before changing database schemas, auth, payments or CI configuration.
- Never delete files, drop data or run destructive commands (`rm -rf`, `git push --force`, `DROP TABLE`) without explicit approval.
- Keep each change under ~200 changed lines where possible; split larger work into steps.
.cursor/rules/spring-boot.mdc
---
description: "Java + Spring Boot conventions: Spring Boot REST service on a modern JDK."
globs: src/**/*.java, src/main/resources/**
alwaysApply: false
---
# Java + Spring Boot
- Use constructor injection (final fields). No field `@Autowired`.
- Use Java records for DTOs; never expose JPA entities directly from controllers.
- Validate request bodies with Jakarta Bean Validation (`@Valid`, `@NotBlank`, ...).
- Put `@Transactional` on service methods, not controllers.
- Handle errors in one `@RestControllerAdvice` returning `ProblemDetail`.
- Configuration via `application.yml` plus env vars; no secrets in the repo.
- Use the build tool wrapper in the repo (`./mvnw` or `./gradlew`), whichever exists.
Docs: https://docs.spring.io/spring-boot/
.cursor/rules/docker.mdc
---
description: "Docker conventions: Containerised builds and local services with Docker."
globs: Dockerfile, **/Dockerfile, compose.yaml, docker-compose.yml, .dockerignore
alwaysApply: false
---
# Docker
- Use multi-stage builds and slim, pinned base images.
- Run the app as a non-root user in the final image.
- Keep a `.dockerignore` that excludes `.git`, `node_modules`, `.env` and build output.
- Never bake secrets into images; pass them at runtime.
Docs: https://docs.docker.com/build/building/best-practices/
.cursorrules
# Cursor rules - this project
You are an expert Java + Spring Boot, Docker engineer working on this codebase. Follow these rules.
## Project
A Java + Spring Boot + Docker project.
Stack: Java + Spring Boot, Docker.
## Commands
- Run: `./mvnw spring-boot:run`
- Tests: `./mvnw test`
- Local services: `docker compose up -d`
## Project structure
- Package by feature (`user/`, `order/`), each with controller, service, repository and DTOs.
## How to work in this repo
- Read the relevant files before editing. Follow the patterns already in the codebase over these generic rules.
- Make the smallest change that solves the task. Do not refactor or reformat unrelated code.
- Before saying a task is done, run the type-check, lint and tests listed under Commands and fix what you broke.
- If requirements are ambiguous, ask one clear question instead of guessing.
- Never commit secrets, API keys or `.env` files. Use env vars and keep `.env.example` up to date.
- Do not add a new dependency when the standard library or an existing dependency already covers it.
- Ask before adding, removing or upgrading any dependency.
- Ask before changing database schemas, auth, payments or CI configuration.
- Never delete files, drop data or run destructive commands (`rm -rf`, `git push --force`, `DROP TABLE`) without explicit approval.
- Keep each change under ~200 changed lines where possible; split larger work into steps.
## Java + Spring Boot
- Use constructor injection (final fields). No field `@Autowired`.
- Use Java records for DTOs; never expose JPA entities directly from controllers.
- Validate request bodies with Jakarta Bean Validation (`@Valid`, `@NotBlank`, ...).
- Put `@Transactional` on service methods, not controllers.
- Handle errors in one `@RestControllerAdvice` returning `ProblemDetail`.
- Configuration via `application.yml` plus env vars; no secrets in the repo.
- Use the build tool wrapper in the repo (`./mvnw` or `./gradlew`), whichever exists.
## Docker
- Use multi-stage builds and slim, pinned base images.
- Run the app as a non-root user in the final image.
- Keep a `.dockerignore` that excludes `.git`, `node_modules`, `.env` and build output.
- Never bake secrets into images; pass them at runtime.
## Reference docs
- [Spring Boot docs](https://docs.spring.io/spring-boot/)
- [Dockerfile best practices](https://docs.docker.com/build/building/best-practices/)
.github/copilot-instructions.md
# Copilot instructions - this project
A Java + Spring Boot + Docker project.
Stack: Java + Spring Boot, Docker.
## Commands
- Run: `./mvnw spring-boot:run`
- Tests: `./mvnw test`
- Local services: `docker compose up -d`
## How to work in this repo
- Read the relevant files before editing. Follow the patterns already in the codebase over these generic rules.
- Make the smallest change that solves the task. Do not refactor or reformat unrelated code.
- Before saying a task is done, run the type-check, lint and tests listed under Commands and fix what you broke.
- If requirements are ambiguous, ask one clear question instead of guessing.
- Never commit secrets, API keys or `.env` files. Use env vars and keep `.env.example` up to date.
- Do not add a new dependency when the standard library or an existing dependency already covers it.
- Ask before adding, removing or upgrading any dependency.
- Ask before changing database schemas, auth, payments or CI configuration.
- Never delete files, drop data or run destructive commands (`rm -rf`, `git push --force`, `DROP TABLE`) without explicit approval.
- Keep each change under ~200 changed lines where possible; split larger work into steps.
.github/instructions/spring-boot.instructions.md
---
applyTo: "src/**/*.java,src/main/resources/**"
---
# Java + Spring Boot
- Use constructor injection (final fields). No field `@Autowired`.
- Use Java records for DTOs; never expose JPA entities directly from controllers.
- Validate request bodies with Jakarta Bean Validation (`@Valid`, `@NotBlank`, ...).
- Put `@Transactional` on service methods, not controllers.
- Handle errors in one `@RestControllerAdvice` returning `ProblemDetail`.
- Configuration via `application.yml` plus env vars; no secrets in the repo.
- Use the build tool wrapper in the repo (`./mvnw` or `./gradlew`), whichever exists.
.github/instructions/docker.instructions.md
---
applyTo: "Dockerfile,**/Dockerfile,compose.yaml,docker-compose.yml,.dockerignore"
---
# Docker
- Use multi-stage builds and slim, pinned base images.
- Run the app as a non-root user in the final image.
- Keep a `.dockerignore` that excludes `.git`, `node_modules`, `.env` and build output.
- Never bake secrets into images; pass them at runtime.
.windsurf/rules/project.md
---
trigger: always_on
---
# this project
A Java + Spring Boot + Docker project.
Stack: Java + Spring Boot, Docker.
## Commands
- Run: `./mvnw spring-boot:run`
- Tests: `./mvnw test`
- Local services: `docker compose up -d`
## How to work in this repo
- Read the relevant files before editing. Follow the patterns already in the codebase over these generic rules.
- Make the smallest change that solves the task. Do not refactor or reformat unrelated code.
- Before saying a task is done, run the type-check, lint and tests listed under Commands and fix what you broke.
- If requirements are ambiguous, ask one clear question instead of guessing.
- Never commit secrets, API keys or `.env` files. Use env vars and keep `.env.example` up to date.
- Do not add a new dependency when the standard library or an existing dependency already covers it.
- Ask before adding, removing or upgrading any dependency.
- Ask before changing database schemas, auth, payments or CI configuration.
- Never delete files, drop data or run destructive commands (`rm -rf`, `git push --force`, `DROP TABLE`) without explicit approval.
- Keep each change under ~200 changed lines where possible; split larger work into steps.
.windsurf/rules/spring-boot.md
---
trigger: glob
globs: src/**/*.java, src/main/resources/**
---
# Java + Spring Boot
- Use constructor injection (final fields). No field `@Autowired`.
- Use Java records for DTOs; never expose JPA entities directly from controllers.
- Validate request bodies with Jakarta Bean Validation (`@Valid`, `@NotBlank`, ...).
- Put `@Transactional` on service methods, not controllers.
- Handle errors in one `@RestControllerAdvice` returning `ProblemDetail`.
- Configuration via `application.yml` plus env vars; no secrets in the repo.
- Use the build tool wrapper in the repo (`./mvnw` or `./gradlew`), whichever exists.
.windsurf/rules/docker.md
---
trigger: glob
globs: Dockerfile, **/Dockerfile, compose.yaml, docker-compose.yml, .dockerignore
---
# Docker
- Use multi-stage builds and slim, pinned base images.
- Run the app as a non-root user in the final image.
- Keep a `.dockerignore` that excludes `.git`, `node_modules`, `.env` and build output.
- Never bake secrets into images; pass them at runtime.
GEMINI.md
# GEMINI.md - this project
Project context for Gemini CLI.
## Project
A Java + Spring Boot + Docker project.
Stack: Java + Spring Boot, Docker.
## Commands
- Run: `./mvnw spring-boot:run`
- Tests: `./mvnw test`
- Local services: `docker compose up -d`
## Project structure
- Package by feature (`user/`, `order/`), each with controller, service, repository and DTOs.
## How to work in this repo
- Read the relevant files before editing. Follow the patterns already in the codebase over these generic rules.
- Make the smallest change that solves the task. Do not refactor or reformat unrelated code.
- Before saying a task is done, run the type-check, lint and tests listed under Commands and fix what you broke.
- If requirements are ambiguous, ask one clear question instead of guessing.
- Never commit secrets, API keys or `.env` files. Use env vars and keep `.env.example` up to date.
- Do not add a new dependency when the standard library or an existing dependency already covers it.
- Ask before adding, removing or upgrading any dependency.
- Ask before changing database schemas, auth, payments or CI configuration.
- Never delete files, drop data or run destructive commands (`rm -rf`, `git push --force`, `DROP TABLE`) without explicit approval.
- Keep each change under ~200 changed lines where possible; split larger work into steps.
## Java + Spring Boot
- Use constructor injection (final fields). No field `@Autowired`.
- Use Java records for DTOs; never expose JPA entities directly from controllers.
- Validate request bodies with Jakarta Bean Validation (`@Valid`, `@NotBlank`, ...).
- Put `@Transactional` on service methods, not controllers.
- Handle errors in one `@RestControllerAdvice` returning `ProblemDetail`.
- Configuration via `application.yml` plus env vars; no secrets in the repo.
- Use the build tool wrapper in the repo (`./mvnw` or `./gradlew`), whichever exists.
## Docker
- Use multi-stage builds and slim, pinned base images.
- Run the app as a non-root user in the final image.
- Keep a `.dockerignore` that excludes `.git`, `node_modules`, `.env` and build output.
- Never bake secrets into images; pass them at runtime.
## Reference docs
- [Spring Boot docs](https://docs.spring.io/spring-boot/)
- [Dockerfile best practices](https://docs.docker.com/build/building/best-practices/)
Commands your agent should run
| Task | Command |
|---|---|
| Run | ./mvnw spring-boot:run |
| Tests | ./mvnw test |
| Local services | docker compose up -d |
What the rules cover
Java + Spring Boot
Spring Boot REST service on a modern JDK. Scoped to src/**/*.java, src/main/resources/** in Cursor, Copilot and Windsurf.
- Use constructor injection (final fields). No field
@Autowired. - Use Java records for DTOs; never expose JPA entities directly from controllers.
- Validate request bodies with Jakarta Bean Validation (
@Valid,@NotBlank, ...). - Put
@Transactionalon service methods, not controllers. - Handle errors in one
@RestControllerAdvicereturningProblemDetail. - Configuration via
application.ymlplus env vars; no secrets in the repo. - Use the build tool wrapper in the repo (
./mvnwor./gradlew), whichever exists.
Source docs: Spring Boot docs
Docker
Containerised builds and local services with Docker. Scoped to Dockerfile, **/Dockerfile, compose.yaml, docker-compose.yml, .dockerignore in Cursor, Copilot and Windsurf.
- Use multi-stage builds and slim, pinned base images.
- Run the app as a non-root user in the final image.
- Keep a
.dockerignorethat excludes.git,node_modules,.envand build output. - Never bake secrets into images; pass them at runtime.
Source docs: Dockerfile best practices
How to install
- Copy
AGENTS.mdto your repo root. That covers Codex, Cursor, GitHub Copilot and most other agents. - Using Claude Code? Add a
CLAUDE.mdwith the single line@AGENTS.md, or use the standalone CLAUDE.md tab above. - Want rules that only load for certain files in Cursor? Add the
.cursor/rules/*.mdcfiles. - Commit the files so your whole team (and every agent) shares them.
FAQ
Where do I put the AGENTS.md for Java + Spring Boot + Docker?
Save it as AGENTS.md in the root of your repository, next to your main config file. Codex, Cursor and GitHub Copilot pick it up automatically. For Claude Code, add a CLAUDE.md containing @AGENTS.md (or use the standalone CLAUDE.md on this page).
What is the most common mistake AI agents make with Java + Spring Boot?
Agents expose JPA entities directly and use field injection.
Which commands should the agent run to check its work?
For this stack: ./mvnw spring-boot:run, ./mvnw test, docker compose up -d. They are listed in the generated files so the agent runs them before finishing a task.
Do these Java + Spring Boot + Docker rules work with Cursor and Claude Code?
Yes. This page includes the same rules as AGENTS.md, CLAUDE.md, Cursor .mdc project rules, a legacy .cursorrules file, GitHub Copilot instructions, Windsurf rules and GEMINI.md.
Can I customise these rules?
Yes. Open this stack in the generator to add or remove libraries, set your project name and package manager, switch beginner explanations on, and download everything as a zip.
Related stacks
Node.js + Express + Prisma + Zod validation + Vitest + Docker
A TypeScript REST API with Express 5, Prisma and Zod.
Node.js + Express + Drizzle ORM + Zod validation + Docker
An Express API on Drizzle ORM, packaged with Docker.
Python + FastAPI + SQLAlchemy 2 + Alembic + pytest + Docker
A production-style Python API: FastAPI, SQLAlchemy 2 and Alembic, tested with pytest.
Python + Django + pytest + Docker
A Django app tested with pytest.
Ruby on Rails + Tailwind CSS v4 + Docker
Ruby on Rails 8 with Hotwire and Tailwind.
Go + Docker
A Go HTTP service using the standard library router.