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

# SKILL

# AUVY Synapse — agent integrator skill

Use this skill when building on AUVY Synapse from an AI coding agent, MCP client, or automation script.

## Doc index

* Curated: [https://docs.auvy.ai/llms.txt](https://docs.auvy.ai/llms.txt)
* Introduction: [https://docs.auvy.ai/docs/intro](https://docs.auvy.ai/docs/intro)
* SDK source of truth: [https://docs.auvy.ai/sdk/source-of-truth](https://docs.auvy.ai/sdk/source-of-truth)
* Jobs, streaming, errors: [https://docs.auvy.ai/sdk/jobs-and-streaming](https://docs.auvy.ai/sdk/jobs-and-streaming)
* OpenAPI: [https://docs.auvy.ai/openapi.json](https://docs.auvy.ai/openapi.json)

## Credentials

1. Human creates an API key at [https://cortex.auvy.ai](https://cortex.auvy.ai) (Admin → API keys).
2. Set environment variables:

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
export AUVY_API_KEY=ak_live_...
export AUVY_API_URL=https://api.auvy.ai   # optional override
export AUVY_BRAIN_ID=...                  # optional brain scope
```

Send `Authorization: Bearer $AUVY_API_KEY`. Brain-scoped calls also send `X-Brain-Id`.

## Fastest paths

### MCP (no SDK code)

```json theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "mcpServers": {
    "auvy": {
      "url": "https://mcp.auvy.ai/mcp",
      "headers": { "Authorization": "Bearer ak_live_YOUR_API_KEY" }
    }
  }
}
```

Tools: `get_session`, `grep`, `search`, `read`, `delegate`, `connect_execute`, …

### TypeScript SDK

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
npm install @auvy-synapse/client
```

```typescript theme={"theme":{"light":"github-light","dark":"github-dark"}}
import { fromApiKey } from '@auvy-synapse/client'

const auvy = await fromApiKey()
const { receptor } = await auvy.receptors.get(auvy.workspaceSlug!, 'YOUR_SLUG')
const { job_id } = await auvy.receptors.fire(receptor.id, { message: 'Hello' })
```

### CLI

```bash theme={"theme":{"light":"github-light","dark":"github-dark"}}
npm install -g @auvy-synapse/cli
auvy login --api-key ak_live_...
auvy receptors execute YOUR_SLUG --message "Hello"
```

## Rules

* Prefer **`auvy.resources.browse`** and **`auvy.resources.search`** for discovery.
* Integrations OAuth live on **Connect** (`@auvy-synapse/connect-client`), not `@auvy-synapse/client`.
* After invoke, use **`createStream`**, **`invokeAndStream`**, or **`jobs.getStatus`** — see [https://docs.auvy.ai/sdk/jobs-and-streaming](https://docs.auvy.ai/sdk/jobs-and-streaming)
* Handle **`AUVYError`**: use `AUVYError.isRetryableError` and honor rate limits — same page
* List `limit` max **100** per request (`API_MAX_LIST_LIMIT`).

## Verification checklist

1. `await fromApiKey()` or explicit API key string
2. Await async list/get before nested ids
3. Catch `AUVYError`; pass `AbortSignal` for cancellation
4. For long runs: stream or poll `jobs.getStatus`
5. Use `resources.browse` for catalog; `resources.search.searchSemantic` for hybrid search