generate_report

The generate_report tool creates detailed analysis reports about your codebase. Generate reports for quality assessments, architecture reviews, technical debt tracking, or comprehensive project overviews. Reports can be exported in multiple formats for documentation or stakeholder communication.

How It Works

Stellarion aggregates data from multiple analysis tools (complexity, structure, quality) and formats it into structured reports. Reports include metrics, findings, visualizations (chart configurations), and actionable recommendations.

When to Use

• Creating quality assessments: Document code quality for reviews
• Documenting architecture: Generate architecture diagrams and dependency reports
• Tracking technical debt over time: Create regular debt snapshots
• Reporting to stakeholders: Generate readable reports for non-technical audiences
• Sprint retrospectives: Summarize quality changes over time

Parameters

MCP Command Syntax

mcp__stellarion__generate_report reportType:quality outputFormat:markdown includeRecommendations:true

Report Types

Overview Report

High-level project summary with key metrics.

Natural Language:

Generate a project overview report

Direct MCP Call:

mcp__stellarion__generate_report reportType:overview includeMetrics:true

Contains:

• Project metrics (files, lines of code, languages)
• Test coverage summary
• Health score (0-100)
• Top issues at a glance

Quality Report

Detailed code quality analysis.

Natural Language:

Generate a code quality report for this project

Direct MCP Call:

mcp__stellarion__generate_report reportType:quality outputFormat:markdown includeRecommendations:true

Contains:

• Complexity metrics (cyclomatic, cognitive)
• Maintainability scores
• Code smells and anti-patterns
• Refactoring opportunities
• Prioritized improvement recommendations

Architecture Report

Dependency and structure analysis.

Natural Language:

Generate an architecture report showing dependencies

Direct MCP Call:

mcp__stellarion__generate_report reportType:architecture maxDepth:5 includeCharts:true

Contains:

• Layer structure (components, services, utilities)
• Module relationships and dependencies
• Coupling metrics between modules
• Circular dependencies
• Dependency visualization config

Technical Debt Report

Technical debt inventory and prioritization.

Natural Language:

Create a technical debt report with effort estimates

Direct MCP Call:

mcp__stellarion__generate_report reportType:technical_debt includeRecommendations:true

Contains:

• Debt items with descriptions
• Effort estimates per item
• Priority rankings
• ROI recommendations (high impact, low effort first)
• Total debt score

Full Report

Comprehensive report combining all types.

Natural Language:

Generate a full analysis report with everything

Direct MCP Call:

mcp__stellarion__generate_report reportType:full outputFormat:markdown includeMetrics:true includeRecommendations:true includeCharts:true

Contains: All sections from overview, quality, architecture, and technical debt reports combined.

Examples

Quality Report in Markdown

Natural Language:

Generate a quality report for src/ in markdown format with recommendations

Direct MCP Call:

mcp__stellarion__generate_report reportType:quality path:src/ outputFormat:markdown includeRecommendations:true

Save Report to File

Natural Language:

Create a technical debt report and save it to docs/tech-debt.md

Direct MCP Call:

mcp__stellarion__generate_report reportType:technical_debt outputFormat:markdown saveToFile:docs/tech-debt.md includeRecommendations:true

Architecture with Visualizations

Natural Language:

Generate an architecture report with chart configurations

Direct MCP Call:

mcp__stellarion__generate_report reportType:architecture includeCharts:true outputFormat:json

CSV Export for Spreadsheets

Natural Language:

Export complexity metrics to CSV for spreadsheet analysis

Direct MCP Call:

mcp__stellarion__generate_report reportType:quality outputFormat:csv saveToFile:metrics.csv

Output Formats

Report Sections

Metrics Section

Detailed measurements:

Issues Section

Problems identified:

Recommendations Section

Actionable improvements:

Chart Configurations

When includeCharts: true:

• Complexity distribution histogram
• Language breakdown pie chart
• Dependency graph visualization
• Trend lines (if historical data available)

Tips for Effective Reports

1. Use includeRecommendations: true for actionable reports: Get specific improvement suggestions
2. Save reports to version control: Track changes in docs/ over time
3. Use markdown format for GitHub/GitLab: Renders nicely in repos
4. Generate reports regularly: Weekly or per-sprint for tracking
5. Use CSV for detailed analysis: Import to spreadsheets for custom analysis

Automation Example

Generate weekly quality reports:

# Weekly quality snapshot
mcp__stellarion__generate_report reportType:quality outputFormat:markdown saveToFile:docs/quality-report.md includeMetrics:true includeRecommendations:true

Combining with Other Tools

1. Index first: Run index_project before generating reports
2. Quality + Refactoring: Use quality report to identify issues, then find_refactoring for specific fixes
3. Track over time: Save reports regularly to measure improvement