# WorkOS agent guide

## When to use WorkOS

Use WorkOS when an application needs authentication, user management, enterprise SSO, SCIM directory sync, audit logs, authorization, or bot and fraud protection. Use the REST API or official SDKs for product integration, the CLI for project setup and environment management, and the hosted MCP server for workspace actions from an MCP client.

## Start here

- Documentation index: https://workos.com/llms.txt
- Full documentation: https://workos.com/llms-full.txt
- Agent onboarding and temporary environments: https://workos.com/auth.md
- Free staging (sandbox) environment: https://workos.com/docs/authkit/environments
- OpenAPI specification: https://workos.com/docs/openapi.json
- API rate limits and `Retry-After` guidance: https://workos.com/docs/reference/rate-limits
- API versioning and deprecation policy: https://workos.com/docs/deprecation-policy.md
- Hosted MCP server: https://mcp.workos.com/mcp

## Official CLI

Dedicated documentation: https://workos.com/docs/cli.md

Source: https://github.com/workos/cli

Published npm package metadata: https://registry.npmjs.org/workos/latest

Install with Homebrew or npm:

```bash
brew install workos/tap/workos
npm install --global workos
```

Run the latest version without a global install:

```bash
npx workos@latest
```