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

# Quickstart

> Choose SDK or MCP to get started with Nippy

# Quickstart

Nippy has two integration surfaces. Use the SDK when your product needs to run gamification mechanics. Use MCP when an agent or compatible client needs to operate Nippy tools.

## SDK

The SDK is the path for integrating campaigns, spins, claims, and webhooks into your application.

<Steps>
  <Step title="Install the SDK">
    ```bash theme={null}
    npm install github:Nippy-Tech/gamification_nippy_sdk
    ```
  </Step>

  <Step title="Initialize the client">
    ```typescript theme={null}
    import { NippyClient } from '@nippy/sdk'

    const nippy = new NippyClient({
      apiKey: process.env.NIPPY_API_KEY,
      baseUrl: 'https://ms.nippy.la'
    })
    ```
  </Step>

  <Step title="Run a spin">
    ```typescript theme={null}
    const result = await nippy.spin({
      userId: 'user-123',
      campaignId: 'camp-abc'
    })
    ```
  </Step>
</Steps>

<CardGroup cols={2}>
  <Card title="SDK reference" icon="book-open" href="/en/sdk/introduction">
    Continue with SDK concepts, authentication, and method reference.
  </Card>

  <Card title="Authentication" icon="key" href="/en/sdk/authentication">
    Review API keys and headers for SDK calls.
  </Card>
</CardGroup>

## MCP

MCP is the path for connecting clients like Claude Desktop, Cursor, OpenClaw, or Hermes Agent to the Nippy server.

<Steps>
  <Step title="Get your API key">
    Create a key with the `npk_` prefix from the console.

    ```text theme={null}
    https://console.nippy.la/settings/api-keys
    ```
  </Step>

  <Step title="Configure the MCP server">
    Use this endpoint in your MCP client:

    ```text theme={null}
    https://ms.nippy.la/cognitive-layer/mcp
    ```
  </Step>

  <Step title="Add the authentication header">
    ```json theme={null}
    {
      "headers": {
        "X-API-Key": "npk_your_api_key_here"
      }
    }
    ```
  </Step>
</Steps>

<CardGroup cols={2}>
  <Card title="MCP reference" icon="terminal" href="/en/mcp/introduction">
    Continue with MCP concepts, authentication, and available tools.
  </Card>

  <Card title="Available tools" icon="plug" href="/en/mcp/analytics">
    Query analytics, roulettes, flows, learning, and supply.
  </Card>
</CardGroup>

## Next step

<CardGroup cols={2}>
  <Card title="SDK authentication" icon="key" href="/en/sdk/authentication">
    Review API keys and headers for calls from your application.
  </Card>

  <Card title="MCP authentication" icon="key-round" href="/en/mcp/authentication">
    Review how to authenticate MCP clients with `X-API-Key`.
  </Card>
</CardGroup>