173-java-agents
npx machina-cli add skill jabrena/cursor-rules-java/173-java-agents --openclawAGENTS.md Generator for Java repositories
Generate a comprehensive AGENTS.md file for Java repositories through a modular, step-based interactive process that covers role definition, tech stack, file structure, commands, Git workflow, and contributor boundaries.
Core areas: AGENTS.md generation for Java repositories of any complexity, role and expertise definition for AI agents and contributors, tech stack documentation (language, build tool, frameworks, pipelines), file structure mapping with read/write boundaries, command catalogue for build/test/deploy/run workflows, Git workflow conventions (branching strategy, commit message format), and contributor boundaries using ✅ Always do / ⚠️ Ask first / 🚫 Never do formatting.
Prerequisites: No Maven validation is required before generating AGENTS.md. However, review the project structure and existing documentation before starting to provide accurate answers during Step 1.
Multi-step scope: Step 1 assesses project requirements through 6 targeted questions covering role/expertise, tech stack, directory layout, key commands, Git workflow, and contributor boundaries — all questions must be answered in strict order before proceeding. Step 2 generates the AGENTS.md file in the project root by mapping each answer to the corresponding section, handles existing files via overwrite/merge/backup strategies, validates that all 6 sections are present and correctly formatted, and confirms that boundaries use the required ✅ / ⚠️ / 🚫 icons.
Before applying changes: Read the reference for detailed good/bad examples, constraints, and safeguards for each AGENTS.md generation pattern.
Reference
For detailed guidance, examples, and constraints, see references/173-java-agents.md.
Source
git clone https://github.com/jabrena/cursor-rules-java/blob/main/skills/173-java-agents/SKILL.mdView on GitHub Overview
This skill guides you through creating a complete AGENTS.md for a Java project using a modular, step-based interactive process. It defines role expertise, tech stack, file structure, commands, Git workflow, and contributor boundaries tailored to your repo.
How This Skill Works
Step 1 asks 6 targeted questions to capture role, tech stack, layout, key commands, Git workflow, and contributor boundaries. Step 2 maps each answer to the corresponding AGENTS.md section, handles existing files with overwrite/merge/backup strategies, and validates that all sections are present and correctly formatted with the required icons.
When to Use It
- Starting a new Java repository and need a governance document
- Standardizing AGENTS.md for an existing Java project
- Onboarding new contributors to a Java project
- Updating AGENTS.md as tech stack or tooling evolves
- Consolidating project practices across multiple Java modules
Quick Start
- Step 1: Answer 6 targeted questions in strict order (role, tech stack, layout, commands, Git workflow, boundaries).
- Step 2: Generate AGENTS.md in the project root by mapping answers to sections.
- Step 3: Review, then apply overwrite/merge/backup rules and validate icons before finalizing.
Best Practices
- Answer the 6 questions in strict order to ensure all sections are complete
- Review the repository structure and existing docs before Step 1
- Be explicit about roles, expertise, and contributor boundaries
- Choose the appropriate file handling strategy (overwrite/merge/backup) for AGENTS.md
- Validate the final AGENTS.md to ensure required icons (✅/⚠️/🚫) are used
Example Use Cases
- A greenfield Java service with Maven, single-module structure
- A multi-module Spring Boot project migrating from Gradle to a new standard
- An open-source Java library requiring contributor boundaries and clear commands
- A legacy Java project needing a refreshed, standardized AGENTS.md
- A CI-driven repo where AGENTS.md documents build, test, and deploy commands
