Command Palette

Search for a command to run...

UnylyUnyly
Browse all

Dreamlit

FreeNot checked

Create, test, publish, and manage Dreamlit notification workflows from AI clients.

GitHubEmbed

About

Create, test, publish, and manage Dreamlit notification workflows from AI clients.

README

Dreamlit MCP lets AI clients create, inspect, test, publish, unpublish, analyze, and style Dreamlit notification workflows.

Dreamlit is a database-driven notification workflow platform for Supabase and Postgres apps. Use this MCP server when you want an AI client to help build notification workflows from outcome-oriented prompts, review and publish them through Dreamlit, or answer bounded analytics questions about notification performance.

Server

  • Production MCP URL: https://mcp.dreamlit.ai/mcp
  • Transport: Streamable HTTP
  • Authentication: OAuth, with personal access token fallback for clients that do not support OAuth

This repository contains public setup docs and MCP registry metadata for Dreamlit's hosted remote MCP server. The production backend implementation is not open source.

Quick Start

Use your MCP client's remote server flow and enter:

https://mcp.dreamlit.ai/mcp

The client should open a Dreamlit authorization page. Choose the workspace you want the AI client to access and approve the requested scopes.

Codex CLI

codex mcp add dreamlit --url https://mcp.dreamlit.ai/mcp
codex mcp login dreamlit

To request every supported v1 scope explicitly:

codex mcp login dreamlit --scopes workflows:read,workflows:write,workflows:publish,analytics:read

MCP Inspector

npx @modelcontextprotocol/inspector

Then choose Streamable HTTP and use:

https://mcp.dreamlit.ai/mcp

Tools

Dreamlit exposes product-level workflow and analytics tools, not low-level graph editing or database APIs.

Tool Scope Purpose
get_status workflows:read Get Dreamlit guidance, workspace context, project setup, schema hints, workflow state, and app URLs.
list_projects workflows:read Find accessible Dreamlit projects in the approved workspace.
list_workflows workflows:read Find workflows in a project by name, description, trigger type, and pagination.
list_brand_kits workflows:read Find saved brand kit ids and style summaries with pagination before applying one to generated email drafts.
get_workflow_and_preview_url workflows:read Inspect a workflow draft and get the Dreamlit preview or builder URL before editing or publishing.
get_analytics analytics:read Query bounded notification analytics, recipient engagement, and workflow run data with filters and cursor pagination.
create_or_update_workflow workflows:write Create a new workflow draft or update an existing draft from a natural-language prompt.
send_workflow_test workflows:write Confirm and send a draft email or Slack test without publishing the workflow.
prepare_publish workflows:publish Validate a workflow before publishing and return confirmation fields.
confirm_publish workflows:publish Publish or schedule a workflow after explicit user confirmation.
unpublish_workflow workflows:publish Disable live triggers or schedules for a workflow.

Recommended Flow

  1. Call get_status first to understand the workspace, project setup, and prompting guidance.
  2. Use list_projects and list_workflows if the user names a project or workflow without IDs.
  3. Use list_brand_kits when the user wants a specific saved brand kit applied to generated email drafts.
  4. Use get_workflow_and_preview_url before editing an existing workflow.
  5. Use get_analytics for bounded analytics questions, filtering first and paginating with returned cursors for larger result sets.
  6. Use create_or_update_workflow to create or update a draft.
  7. Open the returned preview or builder URL and send workflow tests for important email or Slack messages.
  8. Publish only after explicit user confirmation, using prepare_publish followed by confirm_publish.

Drafts are not live after authoring. Publishing is always a separate explicit step.

Prompting Tips

Ask for the outcome, not a workflow graph. Good prompts include:

  • The event or schedule that should start the workflow.
  • The audience or recipient.
  • The message goal and tone.
  • The data needed for personalization.
  • Timing, timezone, and business rules.
  • Whether recipients should be able to unsubscribe.

Examples:

When a new organization row is inserted, send an internal Slack alert with the organization name, owner email, and plan.
Every Monday at 9 AM America/New_York, send admins a weekly usage digest summarizing active users, failed payments, and new signups.
Tomorrow at 10 AM, announce the launch to active users who opted into product updates. Include unsubscribe.

Access Model

OAuth access is scoped to the workspace selected during authorization. Personal access tokens are project scoped and can be created from Dreamlit project settings.

Available scopes:

  • workflows:read
  • workflows:write
  • workflows:publish
  • analytics:read

Use the least privilege that fits the client. Read-only workflow and brand-kit clients should request only workflows:read; analytics clients should request analytics:read.

Data Handling

Dreamlit MCP can access workflow metadata, saved brand kit summaries, connected project context, and bounded analytics results needed to perform the requested actions. It does not require clients to send database credentials through MCP.

Analytics access is structured and paginated. Use filters and cursors for larger result sets; CSV exports and bulk dumps are not exposed through MCP.

Do not paste secrets, raw credentials, or private tokens into prompts. Use Dreamlit's app settings for integrations and credentials.

Support

For support, contact [email protected].

from github.com/dreamlit-ai/dreamlit-mcp

Installing Dreamlit

This server has no published package — it is built from source. Open the repository and follow its README.

▸ github.com/dreamlit-ai/dreamlit-mcp

FAQ

Is Dreamlit MCP free?

Yes, Dreamlit MCP is free — one-click install via Unyly at no cost.

Does Dreamlit need an API key?

No, Dreamlit runs without API keys or environment variables.

Is Dreamlit hosted or self-hosted?

A hosted option is available: Unyly runs the server in the cloud, no local setup required.

How do I install Dreamlit in Claude Desktop, Claude Code or Cursor?

Open Dreamlit on unyly.org, pick your client tab (Claude Desktop, Claude Code, Cursor) and press Install — the config is generated automatically, no JSON editing.

Related MCPs

Compare Dreamlit with

Not sure what to pick?

Find your stack in 60 seconds

Author?

Embed badge for your README

Browse similar

All ai MCPs