Metadata-Version: 2.5
Name: metabase-skill
Version: 1.0.0
Summary: Agent Skill that answers Metabase questions from a local copy of the official docs.
Project-URL: Homepage, https://github.com/IshanSarkar/metabase-skill
Project-URL: Repository, https://github.com/IshanSarkar/metabase-skill
Project-URL: Issues, https://github.com/IshanSarkar/metabase-skill/issues
Project-URL: Documentation, https://www.metabase.com/docs/latest/
Author: Ishan Sarkar
License-Expression: MIT
License-File: LICENSE
Keywords: agent-skill,claude,cursor,metabase
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Documentation
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# Metabase skill for any AI agent

An [Agent Skill](https://agentskills.io/specification) that answers Metabase questions from a local copy of the official Metabase docs. Author: Ishan Sarkar. Implementation: Cursor AI agent. Attribution: [CREDITS.md](CREDITS.md).

**OS:** macOS, Linux, Windows. The skill is files + Python stdlib — no Docker, no native binaries.

**Agents:** Cursor, Claude Code, Codex, GitHub Copilot, Gemini CLI, OpenCode, and any client that loads `SKILL.md`.

After install, start a new chat and ask in plain language. You do not need a slash command.

```
How do I give each customer only their own rows?
Embed a chart in our React app without making them log into Metabase.
SQL dropdown that lists product categories.
```

## Install (pick one)

### pip (no Node.js)

```bash
pip install "git+https://github.com/IshanSarkar/metabase-skill.git"
metabase-skill
```

After the package is on PyPI, that becomes `pip install metabase-skill` then `metabase-skill`. Same flags as the Python installer (`--project`, `--agent cursor`). `python -m metabase_skill` is equivalent.

Windows: `py -m pip install ...` then `metabase-skill` (or `py -m metabase_skill`).

### Clone + Python installer

Needs [Python 3.9+](https://www.python.org/downloads/) and git. Same idea on every OS.

macOS / Linux:

```bash
git clone https://github.com/IshanSarkar/metabase-skill.git
cd metabase-skill
python3 scripts/install.py
```

Windows (PowerShell or cmd):

```powershell
git clone https://github.com/IshanSarkar/metabase-skill.git
cd metabase-skill
py -3 scripts\install.py
```

If you already have the folder, skip clone and run the installer from inside it. Flags: `--project` (current repo only), `--agent cursor` (one product). Unix shortcut: `./install.sh` (calls the same Python installer).

No git: download the [ZIP](https://github.com/IshanSarkar/metabase-skill/archive/refs/heads/main.zip), unzip, then run the same `python3` / `py -3` command from that folder.

### Skills CLI (needs Node.js)

Needs [Node.js](https://nodejs.org/). Same command on macOS, Linux, and Windows:

```bash
npx skills add IshanSarkar/metabase-skill -g -y
```

Add `-a cursor -a claude-code -a codex` to target specific products.

From a local clone:

```bash
npx skills add . -g -y
```

### Cursor only — clone into the skills folder

| OS | Folder |
|----|--------|
| macOS / Linux | `~/.cursor/skills/metabase` |
| Windows | `%USERPROFILE%\.cursor\skills\metabase` |

```bash
git clone https://github.com/IshanSarkar/metabase-skill.git ~/.cursor/skills/metabase
```

Windows PowerShell:

```powershell
git clone https://github.com/IshanSarkar/metabase-skill.git "$env:USERPROFILE\.cursor\skills\metabase"
```

Then start a **new** Agent chat.

## Requirements

- **Python 3.9+** for lookup (standard library only: `pathlib`, `json`, `re`)
- Optional: **pip** if you install with `pip install ...` (then run `metabase-skill`)
- Optional: **git** if `source/` is missing (first lookup clones Metabase `docs/`)
- Optional: **Node.js** only if you install via `npx skills add`

| OS | Python command |
|----|----------------|
| macOS / Linux | `python3` |
| Windows | `py -3` or `python` |

## How to use it in conversation

1. Install the skill.
2. Open a **new** agent thread (so the skill is discovered).
3. Ask a Metabase question in your own words.

The agent should run `scripts/lookup.py`, read the few PRIMARY pages, and answer with official doc links. If it does not, say: `Use the metabase skill` or `/metabase` where your client supports slash skills.

## Layout

```
SKILL.md                 # router (small — loaded when the skill fires)
scripts/lookup.py        # run this; do not paste it into context
scripts/install.py       # cross-platform installer
graph/concepts.json      # slang → official Metabase concepts
source/                  # official docs snapshot
references/              # short topic cheat sheets
install.sh               # Unix wrapper around scripts/install.py
```

## Credits

See [CREDITS.md](CREDITS.md).

- **Documentation source:** [Metabase documentation](https://www.metabase.com/docs/latest/) and the `docs/` folder of [metabase/metabase](https://github.com/metabase/metabase)
- **Documentation copyright:** © Metabase, Inc.
- **Docs snapshot:** 2026-09-10; latest Metabase at that time: **63.17** (`v0.63.17` OSS, `v1.63.17` Pro/Enterprise)
- **Author:** Ishan Sarkar
- **Implementation:** Cursor AI agent

This skill is not affiliated with or endorsed by Metabase, Inc.

## License

Skill packaging: MIT (`LICENSE`), Copyright © 2026 Ishan Sarkar.  
`source/` is Metabase documentation, copyright © Metabase, Inc. (AGPL); see `NOTICE.md`.
