Use it to scaffold a new Spring Boot app, choose JDBC instead of JPA/Hibernate for database access, organise code by business feature, manage profiles and secrets, and check that required pieces are present.

It prevents different parts of a Spring Boot project from using conflicting patterns or unsafe defaults. It also gives an agent a clear entry point when creating or changing the application.

How lsampaioweb/ai-instructions configures GitHub Copilot

Q: What is ai-instructions spring-boot-project.instructions.md?

A project rulebook for Spring Boot, a Java framework for building web applications and services. It sets required architecture, configuration files, security practices, and the checklist for starting an empty application.

Reuse

Borrowing it

Nothing to install: this file belongs to lsampaioweb/ai-instructions. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/lsampaioweb/ai-instructions/main/.github/instructions/spring-boot-project.instructions.md

Clone the repo

git clone --depth 1 https://github.com/lsampaioweb/ai-instructions

Made for: GitHub Copilot.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/lsampaioweb/ai-instructions/spring-boot-project/github.svg)](https://agentmods.dev/instructions/lsampaioweb/ai-instructions/spring-boot-project)

Your own site

<a href="https://agentmods.dev/instructions/lsampaioweb/ai-instructions/spring-boot-project"><img src="https://agentmods.dev/badge/instructions/lsampaioweb/ai-instructions/spring-boot-project/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/lsampaioweb/ai-instructions/spring-boot-project"><img src="https://agentmods.dev/badge/instructions/lsampaioweb/ai-instructions/spring-boot-project.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 1,732 This file is loaded in full into every session.

When invoked 1,732 The same file — it is already loaded in full.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

Origin original No closer match found in the catalogue.

Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

Model	Per session	Once invoked
Fable 5.1	$0.01732	$0.01732
Opus 5.5	$0.00693	$0.00693
Sonnet 5.5	$0.00346	$0.00346
Haiku 4.5	$0.00173	$0.00173

Measured 1mo ago against content hash 96477a725c83, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

ai-instructions spring-boot-project.instructions.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 1mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.github/instructions/spring-boot-project.instructions.md · 133 lines

How it starts

The opening of the file, as written. The whole thing — 133 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Spring Boot Project Contract

Apply this file when creating or changing a Spring Boot application. For an empty repository, load it explicitly before scaffolding. Ignore it for Ansible and other non-Spring work.

Topic files own the full rules. This file is the empty-repo entry point: the stack that must not drift, which topic files to read, and what a new app must create before it is done.

Non-negotiables

Persistence is Spring JDBC, never JPA/Hibernate/@Entity (pom + architecture + JDBC contracts).
Package by business feature, not by technical layer (architecture contract).
Every feature uses <Feature>Service/ServiceImpl and <Feature>Mapper; persistence-backed features also use <Feature>Repository/RepositoryImpl (never *DtoMapper).
Controllers depend on service interfaces only.
Ship application.yml plus application-development.yml and application-production.yml. Use those full profile names. Committed default active profile is production (configuration contract).
Never commit secrets in YAML. Load them from the environment.
User-facing and log text go through i18n keys, not hardcoded English.
Real apps ship Actuator with health,info,metrics only (Actuator contract).
Private APIs and non-health Actuator paths use Spring Security (Security contract).
Constructor injection only. When Lombok is adopted by the module, use Lombok @Slf4j + @RequiredArgsConstructor on Spring-managed beans (Lombok contract).
Enable spring.threads.virtual.enabled: true in application.yml (virtual-threads contract).
Default runtime is Java 25 with the latest stable Spring Boot 4.x parent available at implementation time.

Topic files to read

Read the matching topic file before generating or reviewing that kind of file. Do not rely only on applyTo auto-loading, especially on an empty repository.

Concern	File
Maven coordinates, comments, JDBC-not-JPA deps	`spring-boot-pom.instructions.md`
Feature packages, services, repositories, mappers	`spring-boot-architecture.instructions.md`
Java style, JavaDoc, compile/test verification	`spring-boot-java-style.instructions.md`
YAML, profiles, DevTools, secrets	`spring-boot-config.instructions.md`
Virtual threads	`spring-boot-virtual-threads.instructions.md`
Lombok vs records	`spring-boot-lombok.instructions.md`
MapStruct processor and `@Mapper`	`spring-boot-mapstruct.instructions.md`
Logback and log message keys	`spring-boot-logging.instructions.md`
Bundles, locale, key-parity tests	`spring-boot-i18n.instructions.md`
`AppException`, advice, validation	`spring-boot-exception.instructions.md`
REST URLs, status, `Pageable`, OpenAPI	`spring-boot-controller.instructions.md`
Outbound `RestClient`	`spring-boot-http-client.instructions.md`
Application events and `@EventListener`	`spring-boot-events.instructions.md`
`@Async` workers and enablement	`spring-boot-async.instructions.md`
Embedded HTTPS / TLS	`spring-boot-tls.instructions.md`
Containers and Compose	`spring-boot-container.instructions.md`
Spring Cloud Config server/client	`spring-boot-cloud-config.instructions.md`
Spring Cloud Vault client	`spring-boot-vault.instructions.md`
RabbitMQ / AMQP	`spring-boot-rabbitmq.instructions.md`
Redis datastore, cache, pub/sub	`spring-boot-redis.instructions.md`
Traefik ingress labels	`spring-boot-traefik.instructions.md`
Micrometer Tracing / OTLP	`spring-boot-tracing.instructions.md`
`JdbcClient`, SQL XML, DBA-owned DDL	`spring-boot-jdbc.instructions.md`
Actuator exposure and probes	`spring-boot-actuator.instructions.md`
HTTP Basic, deny-by-default, credentials	`spring-boot-security.instructions.md`
Tests	`spring-boot-test.instructions.md`
README	`spring-boot-readme.instructions.md`
`.gitignore`	`spring-boot-gitignore.instructions.md`
Thymeleaf pages	`spring-boot-thymeleaf.instructions.md`
WebSocket/STOMP	`spring-boot-websocket.instructions.md`
HTTP load scripts (k6)	`spring-boot-k6.instructions.md`

Read the full file on GitHub · 133 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

1mo ago First seen · 133 lines · 1,732 tokens per session scan A 96477a725c83

Subscribe to this mod's changes

ai-instructions spring-boot-project.instructions.md is an instructions file published in the GitHub repository lsampaioweb/ai-instructions (1 stars, last pushed 5d ago), licensed MIT. It adds 1,732 tokens to every session, about $0.0069 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-30.

Backend and APIs

ai-instructions spring-boot-project.instructions.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
ai-instructions spring-boot-project.instructions.mdlsampaioweb/ai-instructions	Instructions file	1	5d ago	MIT	A	1,732	GitHub Copilot
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	today	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

ai-instructions: Instructions file for GitHub Copilot