PlayerOS

What is PlayerOS?

PlayerOS is an MCP server for the PlayerOS casino marketing platform, providing AI agents with 25 tools and discoverable resources for managing player databases, multi-channel campaigns, journey automation, and TCPA/CCPA/GDPR compliance. It is exposed at https://api.playeros.ai/api/mcp alongside an official TypeScript/JavaScript SDK and CLI.

How to use PlayerOS?

AI agents connect to the MCP server at https://api.playeros.ai/api/mcp using the Model Context Protocol. For manual use, install the SDK with npm install @playeros/sdk, set the PLAYEROS_API_KEY environment variable (a property-scoped pk_... key from Settings → API & MCP), and import PlayerOS to call resources like players, campaigns, or compliance. A CLI command (playeros) is also available after installation, or via npx @playeros/sdk --help.

Key features of PlayerOS

• Zero runtime dependencies; uses Node 18+ built-in fetch
• Property-scoped API keys with read and/or write scopes
• Idempotency support for campaign sends to prevent duplicates
• Structured error handling with PlayerOSError and stable error codes
• CLI outputs JSON for piping to tools like jq
• MCP server with 25 tools and discoverable resources

Use cases of PlayerOS

• List, create, update, and delete players from a unified gaming operator database
• Send email or SMS campaigns with idempotency keys for reliable delivery
• Check compliance (e.g., channel opt-in) and record player consent
• Handle CCPA/GDPR data export or deletion requests
• Manage property-scoped API keys and webhooks programmatically

FAQ from PlayerOS

What runtime is required for PlayerOS?

Node 18+ is required, as the SDK relies on the built-in fetch API and has zero external dependencies.

How do I authenticate with the PlayerOS MCP server?

Create a property-scoped API key (pk_…) in the PlayerOS dashboard under Settings → API & MCP. The key is sent as the X-Api-Key header; the SDK and CLI handle this automatically.

How does PlayerOS handle errors?

Non-2xx HTTP responses throw a PlayerOSError with a stable .code (e.g., insufficient_scope) and .status. The response also includes requestId and rateLimit hints; clients should back off on HTTP 429.

Can I use the PlayerOS CLI without installing it?

Yes, run npx @playeros/sdk --help to execute one-off commands without a permanent install.

Where is the MCP server hosted?

The MCP server is hosted at https://api.playeros.ai/api/mcp and its manifest is available at https://playeros.ai/.well-known/mcp.json.