Skip to content

Add Metabase exploration recipes cookbook#33

Merged
andreagrandi merged 1 commit into
masterfrom
dashboard-card-schema-recipes
May 21, 2026
Merged

Add Metabase exploration recipes cookbook#33
andreagrandi merged 1 commit into
masterfrom
dashboard-card-schema-recipes

Conversation

@andreagrandi

Copy link
Copy Markdown
Owner

Summary

Closes #16. Adds docs/RECIPES.md — a cookbook of six worked
end-to-end recipes for common Metabase exploration tasks, addressing
the need for clearer recipes for users and agents.

Each recipe states a goal and walks a command sequence where every
step feeds an ID or name into the next, with trimmed sample output and
a concise agent note where relevant:

  1. Discover a database schemadatabase listschemas
    schematable metadatatable fksfield summary/values
  2. Inspect a saved question (card)searchcard get
    card get --fullcard run
  3. Run a parameterized saved questioncard params
    card run --param, including the actionable invalid-parameter error
  4. Analyze a dashboarddashboard getanalyzecards
  5. Run a parameterized dashboard carddashboard params list/values/searchrun-card --param
  6. PII-safe ad-hoc queryingquery filter/query sql with
    redaction, what it misses, and blocked exports

Changes

  • docs/RECIPES.md — new cookbook (six recipes)
  • README.md — new ## Recipes section linking to the cookbook
  • CHANGELOG.md — entry under [Unreleased]

Verification

  • Every command was run against a live Metabase instance to confirm
    output format and behavior. Examples use generic e-commerce-style
    data but reproduce the actual output shapes mb-cli v0.2.0 produces
    (column headers, JSON keys, footer hints, redaction markers).
  • make test passes. Docs-only change — no Go code touched.

Acceptance criteria

  • Docs include practical Metabase workflows
  • Examples match current CLI behavior
  • Agent-specific guidance remains concise and actionable

Add docs/RECIPES.md with six worked end-to-end recipes: schema
discovery, saved-question inspection, parameterized card runs,
dashboard analysis, parameterized dashboard card runs, and PII-safe
querying. Each recipe is a command sequence with trimmed sample
output and a concise agent note. Link it from the README.

Closes #16
@andreagrandi andreagrandi merged commit f454baf into master May 21, 2026
7 checks passed
@andreagrandi andreagrandi deleted the dashboard-card-schema-recipes branch May 21, 2026 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Metabase dashboard, card, and schema exploration recipes

1 participant