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

# Get started

> Connect an MCP client to Pixy.

## Get A Key

Create an Automation key in the Pixy dashboard. The MCP server takes the same key as the REST API — if you already have one, use it.

<a className="pixy-docs-button" href="https://app.pixy.art/automations">
  Create automation key
</a>

## Connect Your Client

<CodeGroup>
  ```json Claude Code theme={null}
  {
    "mcpServers": {
      "pixy": {
        "type": "http",
        "url": "https://app.pixy.art/api/mcp",
        "headers": {
          "Authorization": "Bearer YOUR_API_KEY"
        }
      }
    }
  }
  ```

  ```json Cursor theme={null}
  {
    "mcpServers": {
      "pixy": {
        "url": "https://app.pixy.art/api/mcp",
        "headers": {
          "Authorization": "Bearer YOUR_API_KEY"
        }
      }
    }
  }
  ```

  ```json VS Code theme={null}
  {
    "servers": {
      "pixy": {
        "type": "http",
        "url": "https://app.pixy.art/api/mcp",
        "headers": {
          "Authorization": "Bearer YOUR_API_KEY"
        }
      }
    }
  }
  ```
</CodeGroup>

<Warning>
  The key goes in a configuration file on your machine. Treat it like any other credential — do not commit it, and revoke it from the dashboard if it leaks.
</Warning>

## Check It Works

Ask the assistant something that needs Pixy:

```txt theme={null}
List my Pixy brand kits.
```

It should call `list_brand_kits` and come back with your kits' colors and logos. If it reports an authentication failure, the key is wrong or has been revoked.

## A First Render

A useful prompt looks like this:

```txt theme={null}
Find a Pixy template for an Instagram post about a coffee shop,
show me what text elements it has, then render it with the
headline "Autumn drop is live" using my brand's colors.
```

The assistant will work through it in four calls: `list_templates` to find one, `get_template` to read its element ids, `list_brand_kits` for your colors, and `generate_image` to render.

<Note>
  Element ids are the one thing an agent cannot guess. A modification addressing an id that does not exist is ignored rather than rejected, so the design renders unchanged — which is why `get_template` comes before `generate_image`.
</Note>

## Verify Without A Client

The server answers a plain `GET` with its own description, which is the quickest way to check a key and see what is available:

```bash theme={null}
curl https://app.pixy.art/api/mcp
```

```bash theme={null}
curl -X POST https://app.pixy.art/api/mcp \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/list"}'
```

## Protocol

| | |
| - | - |
| Transport | Streamable HTTP, stateless |
| Protocol version | `2025-06-18` (also answers `2025-03-26` and `2024-11-05`) |
| Methods | `initialize`, `ping`, `tools/list`, `tools/call` |
| Authentication | Bearer token — a Pixy Automation key |

There is no SSE stream to subscribe to and no session to keep alive, so a client that reconnects mid-conversation loses nothing.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.