Add Metabase exploration recipes cookbook#33
Merged
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #16. Adds
docs/RECIPES.md— a cookbook of six workedend-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:
database list→schemas→schema→table metadata→table fks→field summary/valuessearch→card get→card get --full→card runcard params→card run --param, including the actionable invalid-parameter errordashboard get→analyze→cardsdashboard params list/values/search→run-card --paramquery filter/query sqlwithredaction, what it misses, and blocked exports
Changes
docs/RECIPES.md— new cookbook (six recipes)README.md— new## Recipessection linking to the cookbookCHANGELOG.md— entry under[Unreleased]Verification
output format and behavior. Examples use generic e-commerce-style
data but reproduce the actual output shapes mb-cli
v0.2.0produces(column headers, JSON keys, footer hints, redaction markers).
make testpasses. Docs-only change — no Go code touched.Acceptance criteria