generate_documentation
Generate a Markdown documentation skeleton from Git changes. Use glob filtering, select diff source, and produce a template-based Markdown file with placeholders.
Instructions
Generate a Markdown documentation skeleton from Git changes.
Args: project_path: Path to the Git repository. Defaults to the server's current working directory (the project Claude Code is running in). include: Glob patterns; only matching changed files are documented (e.g. [".py", "src/**"]). If omitted, all changed files match. exclude: Glob patterns to drop from the result (e.g. [".css"]), applied after include. output_file: Path (relative to project_path, unless absolute) for the generated Markdown file. language: Skeleton language, "en" or "pt". title: Document title. Defaults to a language-appropriate title. template: Template name to render (see templates/ directory). mode: Diff source — "working_tree" (uncommitted changes, default), "commit" (a single commit), or "branch" (current branch vs base_branch). commit_hash: Commit to document when mode="commit". Defaults to HEAD. base_branch: Base branch to diff against when mode="branch" (uses base_branch...HEAD). Defaults to "origin/main".
Returns: {"success": bool, "output_file": str | None, "files_processed": int, "files_ignored": int, "error": str (only on failure)}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | working_tree | |
| title | No | ||
| exclude | No | ||
| include | No | ||
| language | No | en | |
| template | No | default | |
| base_branch | No | origin/main | |
| commit_hash | No | ||
| output_file | No | documentation.md | |
| project_path | No |