README Generator
Analyze a project's structure and generate a comprehensive README
Example Prompt
Analyze my project in /apps/backend and generate a README for it
About
Examines a project's directory layout, reads key configuration and source files, and synthesizes a well-structured README. Covers installation, usage, project structure, and contribution guidelines based on what it discovers in the codebase.
Workflow Steps
List the top-level directory to understand the project structure and identify key files
📁 List DirectoryRead package manifests, config files, and entry points to extract project metadata
📄 Read FileRecursively list subdirectories to map out the full project architecture
📁 List DirectoryReason about the gathered information to compose a comprehensive README structure
🧠 Structured ReasoningWrite the generated README file to the project root
✏️ Write FileTools Used
List Directory
List all files and subdirectories in a given directory path
Read File
Read the contents of a file at a specified path on the local filesystem
Write File
Write or overwrite a file at a specified path with the given content
Structured Reasoning
Break down a complex problem into sequential reasoning steps with explicit chain-of-thought