generate_project_documentation

Analyze codebases to create structured project documentation with intelligent file discovery, supporting multiple languages and output formats.

Instructions

Generate comprehensive project documentation based on codebase analysis with intelligent file discovery and structured output

WORKFLOW: Ideal for creating production-ready code, tests, and documentation TIP: Generate unlimited iterations locally, then review with Claude SAVES: Claude context for strategic decisions

Input Schema

Name	Required	Description	Default
`analysisDepth`	No	Level of analysis detail	detailed
`analysisType`	No	Type of analysis to perform	comprehensive
`code`	No	The code to analyze (for single-file analysis)
`docStyle`	No	Documentation style to use	markdown
`filePath`	No	Path to single file to analyze
`files`	No	Array of specific file paths (for multi-file analysis)
`focusAreas`	No	Areas to focus on: api, architecture, setup, contributing
`includeExamples`	No	Include usage examples in documentation
`language`	No	Programming language	javascript
`maxDepth`	No	Maximum directory depth for discovery (1-5)
`projectPath`	No	Absolute path to project root directory

Input Schema (JSON Schema)

{
  "properties": {
    "analysisDepth": {
      "default": "detailed",
      "description": "Level of analysis detail",
      "enum": [
        "basic",
        "detailed",
        "comprehensive"
      ],
      "type": "string"
    },
    "analysisType": {
      "default": "comprehensive",
      "description": "Type of analysis to perform",
      "enum": [
        "api",
        "architecture",
        "comprehensive"
      ],
      "type": "string"
    },
    "code": {
      "description": "The code to analyze (for single-file analysis)",
      "type": "string"
    },
    "docStyle": {
      "default": "markdown",
      "description": "Documentation style to use",
      "enum": [
        "markdown",
        "jsdoc",
        "typedoc",
        "sphinx"
      ],
      "type": "string"
    },
    "filePath": {
      "description": "Path to single file to analyze",
      "type": "string"
    },
    "files": {
      "description": "Array of specific file paths (for multi-file analysis)",
      "type": "array"
    },
    "focusAreas": {
      "default": [
        "api",
        "architecture",
        "setup"
      ],
      "description": "Areas to focus on: api, architecture, setup, contributing",
      "type": "array"
    },
    "includeExamples": {
      "default": true,
      "description": "Include usage examples in documentation",
      "type": "boolean"
    },
    "language": {
      "default": "javascript",
      "description": "Programming language",
      "type": "string"
    },
    "maxDepth": {
      "default": 3,
      "description": "Maximum directory depth for discovery (1-5)",
      "type": "number"
    },
    "projectPath": {
      "description": "Absolute path to project root directory",
      "type": "string"
    }
  },
  "required": [],
  "type": "object"
}

Houtini-lm

generate_project_documentation

Instructions

Input Schema

Input Schema (JSON Schema)

Other Tools from Houtini-lm

Related Tools

MCP directory API