Skip to main content
kitlocal.dev

AGENTS.md for a Spring Boot service

A starting AGENTS.md for a Spring Boot service: build and test commands, layering and transaction rules, and the safety rules agents should follow.

Type: AGENTS.md

KitLocal never writes files to your computer. Copy the result or download it yourself.

Fill in the variables

What you type stays in this browser. It is not added to the URL, saved, or sent anywhere.

Preview

Still needed: Service name, Base package

# {{serviceName}}: agent guide

Spring Boot service on Java 21, built with Maven. Base package: `{{basePackage}}`.

## Commands
- Build and verify: `./mvnw -q verify`
- Tests: `./mvnw -q test`
Run the tests for the code you changed before declaring a task complete.

## Layering
- Controllers handle HTTP only: validate input (Bean Validation), call a service, map to a DTO.
- Business logic lives in services; transactions are declared on service methods, not controllers.
- Never return JPA entities from controllers; use DTOs.
- Repositories contain queries only. Watch for N+1 queries and unbounded result sets.

## Safety
- Do not log secrets, tokens or personal data.
- Schema changes go through migrations; never edit applied migrations.
- Do not add dependencies, change the Java version or alter security configuration without asking.
- Do not commit, push or deploy.

## Project-specific rules

About this catalog

Bundled snapshot · published Nov 15, 2026, 6:05 AM · Catalog revision 5bc079fe355af2214bc0

Showing the snapshot bundled with this app (no content source is configured). Newer content may exist at the source.