What problem does it solve?
This Skill automates the process of understanding and documenting complex codebases, ensuring that API specifications, core logic, and module interactions are clearly recorded and up-to-date.
Core Features & Use Cases
- Codebase Analysis: Scans entire projects or specified subpaths to identify key components.
- API Specification Extraction: Extracts details about public API surfaces (HTTP, RPC, CLI, etc.).
- Logic and Interaction Summarization: Summarizes core module responsibilities, functions, and how modules interact.
- AGENTS.md Generation/Update: Creates or updates a project's
AGENTS.md file with structured documentation.
- Use Case: When onboarding a new developer to a large project, use this Skill to generate a comprehensive
AGENTS.md file that details the project's architecture and interfaces, significantly reducing ramp-up time.
Quick Start
Use the project-agents skill to study the codebase in the current directory and update AGENTS.md.