SPRING BOOT AGENTS.MD

A Spring Boot service in Java, built with Gradle. The rules keep an agent on constructor injection, explicit transactions and Flyway migrations, and give it the exact Gradle tasks that verify a change.

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

Project: spring-service. A Spring Boot REST service in Java with Spring Data JPA and PostgreSQL.

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: Java
- Framework: Spring Boot
- Database: PostgreSQL
- Hosting: AWS
- Tests: JUnit 5
- Package manager: Gradle

## Commands

Run these from the repository root.

- Install dependencies: `./gradlew dependencies`
- Run locally: `./gradlew bootRun`
- Build: `./gradlew build`
- Run all tests: `./gradlew test`
- Run one test file: `./gradlew test --tests "com.example.orders.OrderServiceTest"`
- Lint: `./gradlew spotlessCheck`
- Format: `./gradlew spotlessApply`

## Project layout

- `src/main/java/com/example/<feature>/`: Feature packages: controller, service, repository, entities, DTOs
- `src/main/resources/application.yml`: Configuration (no secrets)
- `src/main/resources/db/migration/`: Flyway migrations V<n>__description.sql
- `src/test/java/`: JUnit 5 tests

## 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.
- Changes must be backward compatible across a rolling deploy: old and new code run side by side, so migrations and API changes go in safe steps.

## Project-specific notes

- Use constructor injection with final fields; never `@Autowired` on fields.
- Controllers accept and return DTOs (records), never JPA entities.
- Validate request bodies with `@Valid` and Bean Validation annotations.
- Put `@Transactional` on service methods that write, not on controllers or repositories.
- Schema changes are new Flyway files `V<next>__<description>.sql`; never edit an applied migration. `spring.jpa.hibernate.ddl-auto` stays `validate`.
- Secrets come from environment variables or a secret manager referenced in `application.yml`, never literal values.
- Slice tests (`@WebMvcTest`, `@DataJpaTest`) for controllers and repositories; full `@SpringBootTest` only for integration tests.

## 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: spring-service. A Spring Boot REST service in Java with Spring Data JPA and PostgreSQL.

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: Java
- Framework: Spring Boot
- Database: PostgreSQL
- Hosting: AWS
- Tests: JUnit 5
- Package manager: Gradle

## Commands

- Install dependencies: `./gradlew dependencies`
- Run locally: `./gradlew bootRun`
- Build: `./gradlew build`
- Run all tests: `./gradlew test`
- Run one test file: `./gradlew test --tests "com.example.orders.OrderServiceTest"`
- Lint: `./gradlew spotlessCheck`
- Format: `./gradlew spotlessApply`

## 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 Spring Boot preset

What Is in the Spring Boot AGENTS.md?

The preset describes a a Spring Boot REST service in Java with Spring Data JPA and PostgreSQL. Its AGENTS.md is 50 non-empty lines with 7 exact commands, 4 key directories, and 7 stack-specific rules on top of the shared working rules.

  • Commands: ./gradlew dependencies, ./gradlew bootRun, ./gradlew build, ./gradlew test, ./gradlew test --tests "com.example.orders.OrderServiceTest", ./gradlew spotlessCheck, ./gradlew spotlessApply.
  • Layout: src/main/java/com/example/<feature>/, src/main/resources/application.yml, src/main/resources/db/migration/, src/test/java/.
  • 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 Spring Boot?

Field injection hides dependencies

It makes classes impossible to construct in a plain unit test and hides how many collaborators a class really has. Constructor injection is the Spring team recommendation and makes the code honest.

Entities in the API leak structure

Returning JPA entities couples the API to the schema, can trigger lazy-loading errors during serialization, and may expose fields you never meant to publish.

ddl-auto update is not a migration tool

Letting Hibernate alter the schema at startup works on a laptop and causes drift and data loss in production. Flyway makes changes explicit and ordered.

Slices keep tests fast

Agents default to @SpringBootTest for everything, which starts the whole context and makes the test suite slow enough that nobody runs it.

Which Stack Rules Does the File Add?

  • Use constructor injection with final fields; never @Autowired on fields.
  • Controllers accept and return DTOs (records), never JPA entities.
  • Validate request bodies with @Valid and Bean Validation annotations.
  • Put @Transactional on service methods that write, not on controllers or repositories.
  • Schema changes are new Flyway files V<next>__<description>.sql; never edit an applied migration. spring.jpa.hibernate.ddl-auto stays validate.
  • Secrets come from environment variables or a secret manager referenced in application.yml, never literal values.
  • Slice tests (@WebMvcTest, @DataJpaTest) for controllers and repositories; full @SpringBootTest only for integration tests.

How Do You Add These Files to a Spring Boot 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

Does this work with Maven?

Yes. Choose Maven in the generator and replace the Gradle commands with mvn verify, mvn test and so on.

What about Kotlin Spring Boot projects?

Most rules apply. Choose Kotlin as the language and add any Kotlin-specific conventions, such as data classes for DTOs, to the notes.

Why no type-check command?

The Java compiler type-checks as part of ./gradlew build, so a separate command is not needed.

Are these Spring Boot 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?