svix

Files (50)

• SKILL.md
• CODEOWNERS · auth.md-main/.github/
• .gitignore · auth.md-main/
• .prettierignore · auth.md-main/
• .prettierrc.json · auth.md-main/
• AUTH.md · auth.md-main/
• LICENSE · auth.md-main/
• README.md · auth.md-main/
• .gitignore · auth.md-main/agent-providers/
• README.md · auth.md-main/agent-providers/
• package.json · auth.md-main/agent-providers/
• auth.ts · auth.md-main/agent-providers/src/
• config.ts · auth.md-main/agent-providers/src/
• index.ts · auth.md-main/agent-providers/src/
• jwts.ts · auth.md-main/agent-providers/src/
• keys.ts · auth.md-main/agent-providers/src/
• grants.ts · auth.md-main/agent-providers/src/routes/
• home.ts · auth.md-main/agent-providers/src/routes/
• session.ts · auth.md-main/agent-providers/src/routes/
• token.ts · auth.md-main/agent-providers/src/routes/
• well-known.ts · auth.md-main/agent-providers/src/routes/
• schemas.ts · auth.md-main/agent-providers/src/
• store.ts · auth.md-main/agent-providers/src/
• tsconfig.json · auth.md-main/agent-providers/
• .gitignore · auth.md-main/agent-services/
• README.md · auth.md-main/agent-services/
• package.json · auth.md-main/agent-services/
• auth.ts · auth.md-main/agent-services/src/
• config.ts · auth.md-main/agent-services/src/
• index.ts · auth.md-main/agent-services/src/
• mail.ts · auth.md-main/agent-services/src/
• matcher.ts · auth.md-main/agent-services/src/
• agent-auth.ts · auth.md-main/agent-services/src/routes/
• api.ts · auth.md-main/agent-services/src/routes/
• auth-md.ts · auth.md-main/agent-services/src/routes/
• home.ts · auth.md-main/agent-services/src/routes/
• mail.ts · auth.md-main/agent-services/src/routes/
• well-known.ts · auth.md-main/agent-services/src/routes/
• schemas.ts · auth.md-main/agent-services/src/
• store.ts · auth.md-main/agent-services/src/
• trust.ts · auth.md-main/agent-services/src/
• verify.ts · auth.md-main/agent-services/src/
• tsconfig.json · auth.md-main/agent-services/
• package.json · auth.md-main/
• pnpm-lock.yaml · auth.md-main/
• pnpm-workspace.yaml · auth.md-main/
• .gitignore · auth.md-main/shared/
• package.json · auth.md-main/shared/
• index.ts · auth.md-main/shared/src/
• tsconfig.json · auth.md-main/shared/

SKILL.md (first lines)

# Svix

Svix is a data management platform. Use the available actions to discover its full capabilities.

Official docs: https://www.svix.com/docs/

## Svix Overview

- **Application**
  - **Authentication Key**
- **Endpoint**
  - **Message Attempt**
- **Message**
- **Channel**
- **Event Type**
  - **Event Type Version**

Use action names and parameters as needed.

## Working with Svix

This skill uses the Membrane CLI to interact with Svix. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.

### Install the CLI

Install the Membrane CLI so you can run `membrane` from the terminal:

```bash
npm install -g @membranehq/cli@latest
```

### Authentication

```bash
membrane login --tenant --clientName=<agentType>
```

This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.

**Headless environments:** The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:

```bash
membrane login complete <code>
```

Add `--json` to any command for machine-readable JSON output.

**Agent Types** : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness

### Connecting to Svix

Use `membrane connection ensure` to find or create a connection by app URL or domain:

```bash
membrane connection ensure "https://svix.com/" --json
```
The user completes authentication in the browser. The output contains the new connection id.

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has `state: "READY"`, skip to **Step 2**.

#### 1b. Wait for the connection to be ready

If the connection is in `BUILDING` state, poll until it's ready:

```bash
npx @membranehq/cli connection get <id> --wait --json
```

The `--wait` flag long-polls (up to `--timeout` seconds, default 30) until the state changes. Keep polling until `state` is no longer `BUILDING`.

The resulting state tells you what to do next:

- **`READY`** — connection is fully set up. Skip to **Step 2**.
- **`CLIENT_ACTION_REQUIRED`** — the user or agent needs to do something. The `clientAction` object describes the required action:
  - `clientAction.type` — the kind of action needed:
    - `"connect"` — user needs to authenticate (OAuth, API key, etc.). This covers initial authentication and re-authentication for disconnected connections.
    - `"provide-input"` — more information is needed (e.g. which app to connect to).
  - `clientAction.description` — human-readable explanation of what's needed.
  - `clientAction.uiUrl` (optional) — URL to a pre-built UI where the user can complete the action. Show this to the user when present.
  - `clientAction.agentInstructions` (optional) — instructions for the AI agent on how to proceed programmatically.

  After the user completes the action (e.g. authenticates in the browser), poll again with `membrane connection get <id> --json` to check if the state moved to `READY`.

- **`CONFIGURATION_ERROR`** or **`SETUP_FAILED`** — something went wrong. Check the `error` field for details.

### Searching for actions

Search using a natural language description of what you want to do:

```bash
membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json
```

You should always search for actions in the context of a specific connection.

Each result includes `id`, `name`, `description`, `inputSchema` (what parameters the action accepts), and `outputSchema` (what it returns).

## Popular actions

Use `npx @membranehq/cli@latest action list --intent=QUERY --connectionId=CONNECTION_ID --json` to discover available actions.

### Running actions

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --json
```

To pass JSON parameters:

```bash
membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json
```

The result is in the `output` field of the response.


### Proxy requests

From woodman33/timmy-tui, MIT.