project-agents

Analyze codebases to extract API specifications and update AGENTS.md.

1|Updated Feb 15, 2026
One-click install
npx skills add https://github.com/haowang020110/my_codex_skills --skill project-agents
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: project-agents
Source: https://github.com/haowang020110/my_codex_skills/tree/main/project-agents
Command: npx skills add https://github.com/haowang020110/my_codex_skills --skill project-agents

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

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.

Frequently Asked Questions about project-agents

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically document a codebase and extract API specifications?

You can document a codebase and extract API specifications by analyzing the project to identify entry points, map module interactions, and summarize core logic into a structured AGENTS.md file. This provides a clear overview of system functionality and public interfaces.

What is the best way to generate an AGENTS.md file for agile development onboarding?

The best way to generate an AGENTS.md file for onboarding is scanning the codebase to extract API details, summarizing internal logic, and describing module dependencies. This creates structured project documentation that significantly reduces developer ramp-up time.

Can I analyze a specific subpath instead of an entire project for code documentation?

Yes, you can analyze a specific subpath instead of an entire project. The codebase analysis process scans specified directories to identify key components, extract API surfaces, and summarize logic for targeted documentation updates within your AGENTS.md file.

Does the codebase analysis respect .gitignore exclusions when mapping modules?

Yes, codebase analysis respects .gitignore exclusions when mapping modules. It identifies entry points and extracts API details while skipping files and directories specified in .gitignore, ensuring documentation only covers relevant project code.

How do I study a project to understand internal logic and module interactions?

To study a project and understand internal logic, you map the codebase to extract API interface specifications and summarize how modules interact. This process describes module dependencies and core responsibilities, outputting a comprehensive project overview for review.