spring-boot-readme

spring-boot-readme is a cursor rule for Cursor from lsampaioweb/ai-instructions. It costs 0 tokens per session (571 once invoked), scanned A, original, MIT.

Rules for writing a project README, the document that explains how to use and develop a project.

In plain words
What is it for?
Structuring README files, documenting setup and configuration, and recording API or service URLs.
Why use it?
They prevent incomplete or vague documentation by requiring specific sections, versioned prerequisites, checks, commands, and access links.

Cursor rule for Cursor

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add rules/lsampaioweb/ai-instructions/spring-boot-readme
Clone the repo
git clone --depth 1 https://github.com/lsampaioweb/ai-instructions

Made for: Cursor.

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.

agentmods badge for spring-boot-readme

README.md
[![agentmods](https://agentmods.dev/badge/rules/lsampaioweb/ai-instructions/spring-boot-readme.svg)](https://agentmods.dev/rules/lsampaioweb/ai-instructions/spring-boot-readme)
Your own site
<a href="https://agentmods.dev/rules/lsampaioweb/ai-instructions/spring-boot-readme"><img src="https://agentmods.dev/badge/rules/lsampaioweb/ai-instructions/spring-boot-readme.svg" alt="Measured on agentmods" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 571 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
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.

ModelPer sessionOnce invoked
Fable 5 $0.00000 $0.00571
Opus 5 $0.00000 $0.00285
Sonnet 5 $0.00000 $0.00114
Haiku 4.5 $0.00000 $0.00057

Measured 4d ago against content hash b0eba3002ea3, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

spring-boot-readme 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 4d 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.

.cursor/rules/spring-boot-readme.mdc · 45 lines

How it starts

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

README Engine

Rules

  • Include at minimum these sections in this order: (1) project title with one-line description, (2) Overview, (3) Prerequisites, (4) Getting Started, (5) Configuration reference.
  • Write the Overview as one paragraph.
  • Ensure the Overview answers what this service does.
  • Ensure the Overview answers who uses this service.
  • Ensure the Overview states the top one or two architectural decisions a developer will immediately encounter.
  • Do not repeat the title in the Overview.
  • Add an API reference section or link when the module exposes a public API.
  • Document only the project or module this README belongs to.
  • Do not describe cross-project dependencies or upstream systems inline.
  • Write only actionable content.
  • Omit prose that describes intent without providing executable or verifiable information.
  • State each prerequisite with its required version.
  • For each prerequisite, provide a verification command.
  • For each prerequisite, provide an install reference or link.
  • Write run instructions that can be executed verbatim without manual substitution.
  • After run instructions, list primary access URLs (API base URL, Swagger UI, Actuator health) so developers can immediately verify the running service.
  • Document required environment variables in Getting Started: each variable's name, purpose, and an example value.
  • Wrap all commands and code snippets in fenced code blocks with the appropriate language identifier.
  • Document Docker Compose run commands when the module includes a docker-compose.yml.
  • Document endpoint contracts or link to the canonical API documentation.
  • Document authentication and authorization behavior when applicable.
  • In the Configuration reference section, for each setting explain its operational purpose and when a developer would need to change it.
  • When the module has multiple runtime profiles, document the intended use case for each profile.
  • Include concise rationale for key architecture decisions.
  • In the Configuration reference section, each entry must state the file path.
  • In the Configuration reference section, each entry must state the property key or setting name.
  • In the Configuration reference section, each entry must state its effective value or behavior.
  • Omit entries that contain only a file path with no actionable detail.
  • Link to deeper technical documentation instead of duplicating long walkthroughs inline.
  • Include a Troubleshooting section covering common startup failures: database or broker connection errors, port conflicts, and missing environment variables.

Read the full file on GitHub · 45 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.

  1. 4d ago First seen · 45 lines · 0 tokens per session scan A b0eba3002ea3

Subscribe to this mod's changes

spring-boot-readme is a cursor rule published in the GitHub repository lsampaioweb/ai-instructions (1 stars, last pushed 12d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 571 tokens. 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-08-31.