Skip to main content

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

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.
1

Install the SDK

npm install github:Nippy-Tech/gamification_nippy_sdk
2

Initialize the client

import { NippyClient } from '@nippy/sdk'

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

Run a spin

const result = await nippy.spin({
  userId: 'user-123',
  campaignId: 'camp-abc'
})

SDK reference

Continue with SDK concepts, authentication, and method reference.

Authentication

Review API keys and headers for SDK calls.

​
MCP

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

Get your API key

Create a key with the npk_ prefix from the console.
https://console.nippy.la/settings/api-keys
2

Configure the MCP server

Use this endpoint in your MCP client:
https://ms.nippy.la/cognitive-layer/mcp
3

Add the authentication header

{
  "headers": {
    "X-API-Key": "npk_your_api_key_here"
  }
}

MCP reference

Continue with MCP concepts, authentication, and available tools.

Available tools

Query analytics, roulettes, flows, learning, and supply.

​
Next step

SDK authentication

Review API keys and headers for calls from your application.

MCP authentication

Review how to authenticate MCP clients with X-API-Key.