What is AgentX AGENTS.md?

Repository instructions for the lucky-aeon/AgentX project, covering its Java backend, Next.js frontend, deployment layout, commands, coding style, and tests. A repository is the project folder containing the code and its supporting files.

Finding the right source folders, building and testing the backend or frontend, running the application with Docker, and following naming and formatting rules.

They give an agent the project-specific rules and commands needed to make changes consistently and check them properly.

How lucky-aeon/AgentX configures Codex and OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to lucky-aeon/AgentX. 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/lucky-aeon/AgentX/master/AGENTS.md

Clone the repo

git clone --depth 1 https://github.com/lucky-aeon/AgentX

Made for: Codex, OpenCode.

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/lucky-aeon/agentx/agents-md/github.svg)](https://agentmods.dev/instructions/lucky-aeon/agentx/agents-md)

Your own site

<a href="https://agentmods.dev/instructions/lucky-aeon/agentx/agents-md"><img src="https://agentmods.dev/badge/instructions/lucky-aeon/agentx/agents-md/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/lucky-aeon/agentx/agents-md"><img src="https://agentmods.dev/badge/instructions/lucky-aeon/agentx/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 641 This file is loaded in full into every session.

When invoked 641 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.00641	$0.00641
Opus 5.5	$0.00256	$0.00256
Sonnet 5.5	$0.00128	$0.00128
Haiku 4.5	$0.00064	$0.00064

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

Security

Grade A, and why

AgentX AGENTS.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 2mo 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.

AGENTS.md · 39 lines

How it starts

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

Repository Guidelines

Project Structure & Module Organization

AgentX — Spring Boot (Java 17) backend. Source in AgentX/src/main, tests in AgentX/src/test. Built with Maven Wrapper (./mvnw).
agentx-frontend-plus — Next.js 15 + TypeScript UI. App routes under app/, shared UI in components/.
Deployment & ops: deploy/ (Docker Compose scripts), docker/, docs/, config/, production/. Logs in logs/.

Build, Test, and Development Commands

Backend (from AgentX):
- Build: ./mvnw -DskipTests package
- Run (dev): ./mvnw spring-boot:run -Dspring-boot.run.profiles=dev
- Test: ./mvnw test
- Format: ./mvnw spotless:apply
Frontend (from agentx-frontend-plus):
- Install deps: npm install (or pnpm install)
- Dev server: npm run dev (http://localhost:3000)
- Build/Start: npm run build && npm start
- Lint: npm run lint
All‑in‑one (Docker): cd deploy && ./start.sh to spin up backend, frontend, DB, MQ.

Coding Style & Naming Conventions

Java (backend): formatted via Spotless using AgentX/eclipse-formatter.xml. 4‑space indent, PascalCase classes, camelCase methods/fields, packages start with org.xhy.*.
TypeScript/React (frontend): 2‑space indent, React components PascalCase, files kebab‑case (e.g., model-select-dialog.tsx). Keep hooks in hooks/, UI in components/.
Run linters/formatters before pushing; keep functions small and cohesive.

Testing Guidelines

Backend: JUnit via Spring Boot starter. Place tests under AgentX/src/test/java, name *Test.java. Run with ./mvnw test and target service/controller layers.
Frontend: No default test runner configured; for UI changes include a minimal test plan or interactive demo steps in the PR.

Commit & Pull Request Guidelines

Use Conventional Commits: feat(scope): ..., fix(scope): ..., refactor: ..., docs: ..., chore: ....
PRs include: clear description, linked issues (Fixes #123), test plan (commands + expected result), and screenshots/GIFs for UI.
Keep PRs small and focused; update docs when behavior changes.

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

2mo ago First seen · 39 lines · 641 tokens per session scan A f91c41a1b9cf

Subscribe to this mod's changes

AgentX AGENTS.md is an instructions file published in the GitHub repository lucky-aeon/AgentX (850 stars, last pushed 4mo ago), licensed Apache-2.0. It adds 641 tokens to every session, about $0.0026 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-08-30.

AgentX AGENTS.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
AgentX AGENTS.mdlucky-aeon/AgentX	Instructions file	850	4mo ago	Apache-2.0	A	641	Codex, OpenCode
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

AgentX: Instructions file for Codex