How do I get started with Dreamlit?
Start with the AI agent you already use. Dreamlit builds the workflow while you review the preview and decide when it goes live. Workspace, project, database, and sender setup currently happen in the Dreamlit web app.1
Start your free trial
Start a 7-day free trial of Pro. A card is required to start. You aren’t charged until the trial ends. Cancel anytime. After the trial, Pro is $20 a month for 30,000 emails and up to 10 projects.Complete the workspace and project setup in Dreamlit before authoring through MCP. If you’re using only the dashboard, continue in the same app.
2
Connect your agent
Follow the MCP setup guide for Claude Code, Codex, Cursor, Claude, or another supported client. Authorize access to your Dreamlit workspace, then ask:
Check Dreamlit MCP status and list my projects.Your agent uses
get_status and list_projects. If setup is incomplete, open the Dreamlit link it returns and finish the required browser steps. If setup already asked you to connect a database, use that connection in the next step.Dashboard alternative: Use Dreamlit’s own chat and visual editor. You don’t need to connect an external agent.3
Connect your database
Ask your agent to check setup and show your database-connection link. Open it in Dreamlit and connect Supabase or Postgres. Database setup is a browser step, not an MCP tool.Dreamlit uses
dreamlit_app, installs triggers for database-triggered workflows, and manages its own dreamlit schema. It never changes your app’s rows.Before sending from your brand, configure your email domain. For auth emails, explicitly enable Supabase Auth. For Slack, connect a channel.Dashboard alternative: Complete these same connection and sender steps in guided setup or your project’s settings.4
Ask for your first email
Ask your agent:
Use Dreamlit to draft a welcome email when a new user signs up. Use my database’s user table, address the user by name, and keep it as a draft.Your agent uses
create_or_update_workflow. Describe the audience, timing, and message goal. Dreamlit asks for clarification when needed.Dashboard alternative: Click Create Workflow and describe the same outcome in Dreamlit’s chat.5
Preview it with real data
Open the workflow preview URL your agent returns. Inspect each step and try different database rows. Ask for edits and review the updated draft.Ask your agent to send a test through
send_workflow_test. Review the recipient and confirm the test before it sends. Test sends don’t publish the workflow.Dashboard alternative: Use the preview and test panel, chat, or visual editor to review and refine the draft.6
Publish
Ask your agent to prepare publishing. It calls
prepare_publish and shows you the preview and any warnings. Only after you explicitly approve does it call confirm_publish.Dashboard alternative: Click Publish, review the confirmation dialog, then confirm. You can also publish in sandbox mode to hold messages for manual review.Publishing activates the workflow. Future edits stay in a draft until you publish them.