Docs Write
CheckedAutomatically generates clear, concise documentation from Metabase data explorations and dashboards.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add metabase/metabase --skill docs-write -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
metabase
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned metabase/metabase at 674c8b8dc6.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 674c8b8dc6
- Scanned
- 1 file, 95 lines
About this skill
What it does
The docs-write skill allows AI agents to generate documentation from Metabase data. It can create initial drafts of user guides, API references, or internal knowledge base articles based on structured information within Metabase. The agent can also update existing documentation with new findings and insights derived from the data.
When to use it
- Automated User Guide Creation: Generate a first draft of your application's user guide by extracting relevant information about features and workflows directly from Metabase dashboards.
- API Documentation Updates: Keep API reference materials current by automatically updating descriptions, parameters, and examples based on changes reflected in Metabase data models.
- Internal Knowledge Base Population: Populate an internal knowledge base with documentation derived from frequently asked questions or common troubleshooting steps tracked within Metabase.
- Documentation for Data Changes: Automatically update documentation when underlying data structures or business logic change as reflected in Metabase.
Key capabilities
- Generates documentation drafts
- Updates existing documentation
- Extracts information from Metabase dashboards
- Supports user guides, API references, and knowledge base articles
Example prompts
- "Write a draft of the user guide for the 'Orders' feature based on the data in the Orders dashboard."
- "Update the API reference documentation for the
/productsendpoint with the latest information from the Product Data Model in Metabase." - "Create a knowledge base article explaining how to troubleshoot slow query performance, using insights from the Query Performance dashboard."
Tips & gotchas
- The quality of generated documentation depends heavily on the clarity and structure of data within Metabase. Ensure your dashboards are well-organized and contain descriptive labels.