> ## Documentation Index
> Fetch the complete documentation index at: https://docs.waterr.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Claude Code Skill

> Install the WaterrAI skill into Claude Code with one command so your agent knows the API, the resource model, and scopes every build before writing code.

## What this is

A [Claude Code](https://docs.claude.com/en/docs/claude-code) skill — listed on [skills.sh](https://www.skills.sh/waterrai/skills) — that teaches your local Claude agent to build on top of WaterrAI. Once installed, asking Claude things like *"build a candidate screening flow on Waterr"* or *"create a meeting and pull the analysis"* will trigger the skill — which then:

1. Internally runs a `generate-understanding` sub-skill to interview you and produce a written scope-of-work
2. Waits for your sign-off
3. Implements against the canonical API docs (it cites every endpoint URL it uses)

The skill is the same docs you're reading right now, packaged for the agent.

## Install

One command (works for Claude Code, Cursor, Windsurf, Copilot — any [SKILL.md](https://www.skills.sh)-compatible agent):

```bash theme={null}
npx skills add waterrai/skills
```

That installs the **`waterr-api`** skill. It loads on any "build/integrate/automate on WaterrAI" request and internally invokes the bundled `generate-understanding` sub-skill at the start of any non-trivial build — you never have to install or invoke the sub-skill yourself.

### Manual install (advanced)

If you'd rather manage the files yourself, clone the repo into your Claude Code skills directory:

```bash theme={null}
git clone https://github.com/waterrai/skills.git ~/.claude/skills/waterrai
```

Update later with `cd ~/.claude/skills/waterrai && git pull`.

## How it works

### 1. You describe what you want

```
> I want candidates to take an AI screening interview when they apply,
> and have the score land in our ATS.
```

### 2. Claude runs the `generate-understanding` sub-skill first

It asks at most three questions per round, across three rounds:

* **What & why** — user-facing outcome, trigger, where results land
* **The meeting** — persona reuse vs per-session, goals, recording, language
* **Integration shape** — sync vs async, webhooks vs polling, auth model

Then it writes `WATERR_BUILD_SCOPE.md` to your project root and asks you to confirm before any code is written.

### 3. You approve, Claude builds

Control returns to the parent `waterr-api` skill. It fetches the relevant [API reference](/api-reference/quickstart) pages, writes the integration code, and cites the docs URL next to every endpoint it calls.

## What the skill knows

The skill links to — and tells Claude to fetch before guessing — the full developer docs:

* [Authentication](/api-reference/authentication) — API secret vs JWT
* [Session lifecycle](/api-reference/session-lifecycle) — create → join → end → analyze
* [Personas](/api-reference/personas), [Scenarios](/api-reference/scenarios), [Meetings](/api-reference/meetings)
* [Post-Meeting Data](/api-reference/post-meeting) — transcript, recording, and analysis in one call
* [Goals](/api-reference/goals), [Voices](/api-reference/voices), [Users](/api-reference/users)
* [Webhooks](/api-reference/webhooks), [SDKs](/api-reference/sdks)
* [Prompting guide](/api-reference/prompting-guide) for persona/scenario authoring
* [Worked examples](/api-reference/examples)

It also encodes the common pitfalls — `membership_id` ≠ user ID, voice IDs must come from `/voices`, analyses are async, scenarios are workspace-scoped.

## Skip the scoping

If you already know exactly what you want, just tell Claude:

```
> Skip scoping. Give me the curl to create a meeting from scenario abc-123.
```

The skill will jump straight to implementation for single-endpoint asks.

## Source

Open source, MIT-licensed: [github.com/waterrai/skills](https://github.com/waterrai/skills). PRs welcome.