Report · marked 25 Aug 2026
Stirling-Tools/Stirling-PDF
Solid foundations, held back in a few specific places.
Java · 90,411 stars · 6,863 files · branch main
71
/100
B+
Instructions
25/27Whether the repo tells an agent how to behave before it starts guessing. Losing marks on instruction quality.Setup
8/20Whether an agent can install the project and get it running without a human. Losing marks on deterministic install and environment config.Verification loop
19/22Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy. Losing marks on lint and format rules.Context economy
11/20Whether the repo fits in a context window, or fights it. Losing marks on file sizes fit in context and repository weight.Navigability
7/10How quickly anything new can orient itself. Losing marks on license.
Higher is better. Accent marks what is costing you most.
Fix these first
01
Deterministic install
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
02
File sizes fit in context
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
03
Environment config
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
The full marking
Every deduction below names the file or setting it came from.
Instructions 25/27 A+
Whether the repo tells an agent how to behave before it starts guessing.
✓Agent instruction file
12/12
AGENTS.md is present, which is the format the most tools read.
Also found: CLAUDE.md
✗Instruction quality
10/12
Specific enough that an agent can act on it.
Worth fixing: it's 28k characters, which burns context on every single turn.
names the actual commands to run
uses headings, so an agent can skim it
includes copyable code blocks
✓README as an entry point
3/3
README has a clear getting-started section.
Setup 8/20 C
Whether an agent can install the project and get it running without a human.
✗Deterministic install
0/6
No lockfile. An agent installing dependencies may not get what CI got.
Commit the lockfile your package manager generates. Without it, an agent's install and your install are different builds, and 'works on my machine' becomes unfalsifiable.
✓Discoverable commands
6/6
Commands are declared where an agent will look for them.
Taskfile
scripts/ directory
✗Environment config
0/4
Nothing documents the environment this needs. An agent will get a runtime error it can't diagnose.
Add a .env.example listing every variable with a safe placeholder value. It's the cheapest possible fix and it unblocks the whole first run.
✗Pinned runtime version
0/2
No pinned runtime version.
Add a .nvmrc, .python-version, or equivalent so the agent's toolchain matches yours.
✓Reproducible environment
2/2
.devcontainer/devcontainer.json gives a known-good environment.
Verification loop 19/22 A
Whether an agent can check its own work. This is the category that most decides whether agent output is trustworthy.
✓Tests exist
8/8
1359 test files against 5424 source files.
e.g. .github/workflows/db-migration-test.yml, app/common/src/test/java/stirling/software/SPDF/config/EndpointConfigurationGapTest.java, app/common/src/test/java/stirling/software/SPDF/config/EndpointConfigurationTest.java
✓Test command is discoverable
7/7
An agent can find and run `pytest`.
✓Continuous integration
4/4
41 GitHub Actions workflows define what "passing" means.
✗Lint and format rules
0/3
No linter or formatter config. Style is tribal knowledge, so agent output will drift from yours.
A formatter config is the cheapest way to stop reviewing whitespace in agent diffs. It moves style from opinion to a command.
–Static type checking
n/a
Not applicable — the Java compiler type checks every build.
Context economy 11/20 B-
Whether the repo fits in a context window, or fights it.
✓No committed build output
6/6
No generated directories committed.
✓.gitignore hygiene
3/3
.gitignore covers 190 patterns.
✗File sizes fit in context
0/6
8 source files are over 100KB.
A single file that fills the context window forces an agent to work from fragments, and it will confidently edit code it never saw. Splitting the worst offenders pays for itself immediately.
app/core/src/main/resources/static/pdfjs-legacy/pdf.worker.mjs — 2242KB
app/core/src/main/resources/static/pdfjs-legacy/pdf.sandbox.mjs — 904KB
app/core/src/main/resources/static/pdfjs-legacy/pdf.mjs — 723KB
✗Repository weight
2/5
About 416MB checked out. Large enough that cloning and searching are both slow.
Large binaries and vendored trees slow every operation an agent performs. Git LFS or a separate assets repo keeps the working tree navigable.
Here is your AGENTS.md
Drafted from what is actually in this repository: the install
command from your lockfile, the commands you already declare, your real directory layout. Anything
marked TODO needs a person. Save it at the root as AGENTS.md.
# AGENTS.md #1 PDF Application on GitHub that lets you edit PDFs on any device anywhere ## Setup ``` # TODO: the install command. No lockfile was found, so this could not be inferred. ``` ## Commands ``` # TODO: nothing declares a build or test command, so an agent has to guess. # This is the single most valuable section of this file. Fill it in. ``` ## Layout - `frontend/` 2949 source files - `app/` 2249 source files - `engine/` 138 source files - `scripts/` 39 source files - `testing/` 35 source files - `docker/` 3 source files ## Conventions - Tests live alongside the code they cover, following `.github/workflows/db-migration-test.yml`. - CI defines what passing means. See `.github/workflows/PR-Auto-Deploy-V2.yml`, and keep it green. - TODO: add the two or three conventions a newcomer always gets wrong here. ## Gotchas - `app/core/src/main/resources/static/pdfjs-legacy/pdf.worker.mjs` is 2242KB. It will not fit comfortably in context, so read it in parts. - No lockfile is committed, so an install here may not match what CI produced. --- Drafted by agentreadme.com from what is in this repository. Everything marked TODO needs a human. Check it in as AGENTS.md at the root.
Open the raw markdown
or
curl -o AGENTS.md agentreadme.com/draft/Stirling-Tools/Stirling-PDF.md
Show the mark
The badge re-checks daily, so it keeps up as the repository changes. Use mark again to force it now.
[](https://agentreadme.com/Stirling-Tools/Stirling-PDF)Other Java repositories, marked
Think this mark is wrong?
Every deduction above names the file it came from, so this can be settled by looking. If a check missed something, that is a rule worth fixing.