analyze_project
Analyze project directories to extract structured data and generate README templates with recommended sections based on detected technologies, dependencies, and configuration files.
Instructions
Analyze a project directory and return structured data about the project along with a README template. Returns: (1) A template structure with recommended README sections (some required, some optional), and (2) Detailed project analysis including detected technologies, package.json data, directory structure, scripts, dependencies, and configuration files. The LLM should use this information to construct a comprehensive README following the template structure as a guide, adapting sections based on what's relevant for the specific project.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| projectPath | Yes | The absolute path to the project directory |
Input Schema (JSON Schema)
{
"properties": {
"projectPath": {
"description": "The absolute path to the project directory",
"type": "string"
}
},
"required": [
"projectPath"
],
"type": "object"
}