Developer documentation
Automate Shuffl with the SDK, the CLI and the REST API, connect an agent over MCP, and receive webhooks.
API referenceSDK on npmCLI on npmAll guides as textAgent documentation indexShuffl skill for agents
Tutorials
A first walk through the product, from sign-in to a result.
How-to guides
Steps for one goal, in the order you do them.
Use the SDK and HTTP API
Install the TypeScript client from npm, select exact permissions and verify reads before writes.
For Developers and agent builders
Use the Shuffl CLI
Run Shuffl operations from scripts without a model, with JSON output and the same endpoint permissions as the SDK.
For Developers and automation owners
Connect an MCP client
Connect an agent to the Shuffl MCP server over Streamable HTTP with OAuth or an API key, whose permissions choose its tools.
For Workspace members and agent builders
Webhooks
Send signed events to your own systems when people, Knowledge, playbooks or the workspace change, and check each request came from Shuffl.
For Workspace administrators and developers
SDK and CLI recipes
Copyable recipes for common jobs, each with the SDK, the CLI and HTTP side by side.
For Developers and automation owners
Reference
Every setting, permission, operation and message, stated once.
API endpoint permissions
Choose Read and Write grants and look up the permission ID for every supported API operation.
For Administrators and integration developers
REST API reference
Every REST operation by area, with its permission, fields and examples, plus authentication, errors, rate limits and pagination.
For Developers and integration builders
MCP tool list
Every tool the Shuffl MCP server can offer, with what it does and the permission that turns it on.
For Agent builders and workspace administrators
SDK and CLI changelog
What changed in each version of @shuffl/sdk, @shuffl/cli and @shuffl/api-contracts, and how versions and breaking changes work.
For Developers who use the SDK, CLI or API contracts