Skip to content

Add studio report skill reference#86

Merged
tylerwray merged 2 commits into
mainfrom
twray/add-studio-report-skill-reference
Jun 5, 2026
Merged

Add studio report skill reference#86
tylerwray merged 2 commits into
mainfrom
twray/add-studio-report-skill-reference

Conversation

@tylerwray

@tylerwray tylerwray commented Jun 4, 2026

Copy link
Copy Markdown
Collaborator

Ticket

https://www.loom.com/share/31b76d8ede4a4fadb2a1359c694ea204

Summary

This adds Studio report creation guidance to the dx-cli skill so agents know how to create and update reports through the CLI without trying to assemble large payloads directly in shell arguments.

The report create and update commands take YAML payloads that include report metadata, access settings, SQL, chart types, and chart configuration. Without dedicated skill documentation, agents would have to infer the workflow from the command help or prior context, which makes it easier to miss the intended init/edit/create flow or the supported access and chart config values.

The root cause was that the dx-cli skill had references for catalog and scorecard management, but no comparable reference for Studio report creation. I added a new Report creation reference that mirrors the existing reference-doc pattern and moved the report-specific guidance out of the top-level skill file.

Changes

  • Add skills/dx-cli/references/report-creation.md with Studio report list, info, init, create, update, and stdin workflows.
  • Document the expected report YAML shape, access setting values, and tile chart configuration requirements.
  • Link the new Report creation reference from skills/dx-cli/SKILL.md alongside the existing catalog and scorecard references.

Validation

  • Ran pnpm format:check.

@tylerwray tylerwray marked this pull request as ready for review June 4, 2026 22:30

Supported tile `chart_type` values are `line`, `pie`, `stacked_bar`, `scatter`, and `table`.

`line`, `stacked_bar`, and `scatter` chart configs require `xAxis` and `yAxes`; `pie` chart configs require `labelColumn` and `valueColumn`; `table` chart configs can be `{}`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NB: Chart information looks a little sparse. Have agents done a good job setting the axes and labels correctly during development? If not, we might want to fill out some explicit examples.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I haven't seen any issues.

@tylerwray tylerwray merged commit 10509c6 into main Jun 5, 2026
6 checks passed
@tylerwray tylerwray deleted the twray/add-studio-report-skill-reference branch June 5, 2026 15:28
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.

2 participants