Get started

Introduction

Everything you need to connect your agent and build with Caroush.

Take the docs with youMarkdown for your editor or agent.

Caroush brings your content, carousels, publishing, and analytics into one workspace. The Caroush MCP server connects that workspace to agents such as Codex, Claude Code, and Cursor, so you can work with Caroush from the tools you already use.

These docs cover the connection setup, authentication, and all 49 tools in the current catalog. Each connection belongs to one user and one workspace, with access controlled by 23 permission scopes.

Quick start guide

Connect a compatible MCP client using the remote endpoint:

text
https://mcp.caroush.com/mcp

Your operator must first enable and deploy the MCP server. The endpoint above is the intended production address; for a local installation, use the address shown in Settings → AI connections.

  1. Add Caroush to your client. For Codex, add the configuration below to ~/.codex/config.toml. See Connect an agent for Claude Code, Cursor, and other clients.
  2. Authorize your workspace. Sign in through the browser, choose a workspace, and approve the permissions your agent needs. The connection uses OAuth authorization code flow with PKCE.
  3. Make your first request. Ask your agent to call get_workspace and get_credit_balance to check its context and available credits.
toml
[mcp_servers.caroush]
url = "https://mcp.caroush.com/mcp"

Then complete authorization from your terminal:

sh
codex mcp login caroush
codex mcp list

Follow the complete quick start for discovery, your first tool call, and reading the result.

What you can build

Use the same services that power Caroush, with a documented input and output schema for every tool.

Work withStart here
Content & carousels — create drafts, generate slides, and use your product’s editorial context.Generate a carousel
Publishing & automations — schedule content and run generation workflows, with approval when required.Example workflows
Accounts & analytics — read workspace context, saved performance, and credit balances.Account analytics

Browse the full tool reference to find schemas, required permissions, and execution details. Tools are invoked through MCP’s tools/call method over Streamable HTTP; see Protocol requests for the request format.

Permissions and approvals

You choose what each agent can access. Tool discovery only returns tools allowed by the connection’s scopes, and existing plan limits and credits still apply. Read Permissions & scopes before enabling a new workflow.

Mutations require a UUID idempotency_key. If a tool returns an approval_url, the user reviews the exact action in Caroush before it runs. Follow Retries & approvals for this flow, and Results & background jobs to track queued work through its final outcome.

Continue building

The MCP server runs in the Caroush application. Availability depends on its deployment, your permissions, and your plan. See Capability boundaries for the current supported surface, or visit caroush.com to explore Caroush.