> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Set up Crave with an agent

> Give your coding agent the current Crave docs, connect your account, and prepare your app for Sandbox development.

Open your project in Claude Code, Cursor, Codex, or another coding agent. Paste
this prompt and let it work through the setup with you:

```text wrap theme={null}
Set up Crave using this guide:
https://developer.craveup.com/agents.md
Start in sandbox. Verify locally.
```

[Read the agent instructions](https://developer.craveup.com/agents.md)

You describe what you want to build. Your agent handles the repository,
configuration, and checks. You complete your own sign-in when it is needed.
You do not need an API key to give an agent access to the public documentation.

> [!NOTE]
>
> This flow prepares an existing app and Crave restaurant for development. New
> Cloud workspace provisioning is currently assisted. If you need a new
> workspace, [request setup help](mailto:hello@craveup.com) before expecting an
> agent to deploy a restaurant. See [Cloud
> availability](/docs/guides/crave-cloud-overview.md).

## What your agent does

**1. Understand your project**

Detect the framework and package manager, read your repository instructions,
and reuse any existing Crave integration.

**2. Connect to current guidance**

Read the agent guide and the docs for your framework. Check the target API
and package versions before choosing an integration.

**3. Connect your restaurant**

Help you sign in to Sandbox and confirm the intended restaurant. Configure
its public API origin, merchant slug, and location ID in your app.

**4. Verify the result**

Run the app's checks, start it locally, and verify a real published menu
when your restaurant and compatible integration are available. Report
unfinished steps explicitly; installed tools alone do not mean the app is
ready.

## Keep Crave docs available to your agent

The **documentation MCP** lets your agent search and read the current docs.
It connects over HTTP without a Crave account. It does not sign in to your
restaurant, create projects, edit menus, or deploy apps.

Your coding agent can run the matching command below. Preserve any existing
MCP servers when adding this connection.

> [tab] Claude Code
>
> ```bash theme={null}
> claude mcp add --transport http --scope user crave-docs https://developer.craveup.com/docs/mcp
> ```
>
> Run `/mcp` to check the connection. Reconnect or start a new session if the
> tools do not appear.

> [tab] Codex
>
> ```bash theme={null}
> codex mcp add crave-docs --url https://developer.craveup.com/docs/mcp
> ```
>
> Start a new Codex session if its tool list has not refreshed.

> [tab] Cursor
>
> Add this server to your MCP settings, keeping your other entries:
>
> ```json theme={null}
> {
>   "mcpServers": {
>     "crave-docs": {
>       "url": "https://developer.craveup.com/docs/mcp"
>     }
>   }
> }
> ```
>
> Reconnect the server in Cursor's MCP settings.

> [tab] Other agents
>
> Add an HTTP MCP server with this URL:
>
> ```text theme={null}
> https://developer.craveup.com/docs/mcp
> ```
>
> If your client cannot connect to MCP, give it the
> [docs index](https://developer.craveup.com/docs/llms.txt) and [agent instructions](https://developer.craveup.com/agents.md).
> Each documentation page is also available as Markdown by appending `.md`
> to its URL.

Ask your agent: **“Use the Crave docs to explain how this app should connect to
my restaurant.”** A working connection should return relevant documentation
and source links.

## Choose the next task

> [card] [Connect an existing app](/docs/guides/build-custom-storefront.md)
>
> Add published menus and ordering UI using the contract supported by your
> API.

> [card] [Build a storefront](/docs/guides/ai/build-storefront-prompt.md)
>
> Give your agent an implementation brief after setup and compatibility
> checks.

> [card] [Work with restaurant tools](/docs/guides/ai/craveup-mcp-server.md)
>
> Review the separate platform MCP, authentication, and released-tool limits.

> [card] [Understand Crave Cloud](/docs/guides/crave-cloud-overview.md)
>
> Check workspace availability, environments, hosting, and payment readiness.

## Know when setup is complete

Ask the agent to show the local app URL, selected Sandbox API and restaurant,
files changed, checks run, and any blockers. A working menu does not prove
checkout or production readiness. Keep checkout unavailable until the selected
runtime and SDK support it and the relevant checks pass.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.