| name | Power BI Documentation |
| description | Auto-document Power BI semantic models by extracting metadata, generating documentation, and cataloging all model objects using pbi-cli. Invoke this skill whenever the user says "document this model", "what's in this model", "list everything", "data dictionary", "model inventory", "audit contents", "catalog", "describe the model", or wants to understand what objects exist in a semantic model. |
| tools | pbi-cli |
Power BI Documentation Skill
Generate comprehensive documentation for Power BI semantic models.
Prerequisites
pipx install pbi-cli-tool
pbi-cli skills install
pbi connect
Quick Model Overview
pbi --json model get
pbi --json model stats
Catalog All Objects
pbi --json table list
pbi --json table get Sales
pbi --json table schema Sales
pbi --json measure list
pbi --json measure get "Total Revenue" --table Sales
pbi --json column list --table Sales
pbi --json column list --table Products
pbi --json relationship list
pbi --json security-role list
pbi --json hierarchy list --table Date
pbi --json calc-group list
pbi --json perspective list
pbi --json expression list
pbi --json partition list --table Sales
pbi --json calendar list
Export Full Model as TMDL
pbi database export-tmdl ./model-docs/
This creates a human-readable text representation of the entire model.
Workflow: Generate Model Documentation
Run these commands to gather all information needed for documentation:
pbi --json model get > model-meta.json
pbi --json model stats > model-stats.json
pbi --json table list > tables.json
pbi --json measure list > measures.json
pbi --json relationship list > relationships.json
pbi --json security-role list > security-roles.json
pbi --json column list --table Sales > columns-sales.json
pbi --json column list --table Products > columns-products.json
pbi database export-tmdl ./tmdl-export/
Then assemble these JSON files into markdown or HTML documentation.
Workflow: Data Dictionary
For each table, extract columns and their types:
pbi --json table schema Sales
pbi --json table schema Products
pbi --json table schema Calendar
Workflow: Measure Catalog
Create a complete measure inventory:
pbi --json measure list
pbi database export-tmdl ./tmdl-export/
Culture Management
For multi-language models:
pbi --json advanced culture list
pbi advanced culture create "fr-FR"
pbi advanced culture delete "fr-FR"
Best Practices
- Always use
--json flag for machine-readable output
- Export TMDL alongside JSON for complete documentation
- Run documentation generation as part of CI/CD pipeline
- Keep documentation in version control alongside TMDL exports
- Include relationship diagrams (generate from
pbi --json relationship list)
- Document measure business logic, not just DAX expressions
- Tag measures by business domain using display folders