Title87/100
Get status
The title clearly communicates the tool’s action and subject. Keep it concise.
Description93/100
Read-only. Use first when the agent needs Dreamlit product guidance, prompting guidance, approved workspace context, project setup, schema hints, workflow state, or relevant app URLs. Returns a compact context pack with concepts, recommended tool flow, actor/workspace/project data, optional authoring context, optional workflow context, and appUrls. Do not use this to create, update, publish, or unpublish workflows.
The description explains the capability, when to use it, and what to expect.
Inputs88/100
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
projectId
Optional project id. Include it to return project setup, schema hints, and authoring context.
Remove validation rules already expressed in this field’s schema; describe its meaning and usage instead.
workflowId
Optional workflow id. Include it to return concise workflow state and preview URL.
Clear enough to supply this argument.
Annotations100/100
All four behavior hints are declared.
{
"title": "Get status",
"readOnlyHint": true,
"openWorldHint": false,
"idempotentHint": true,
"destructiveHint": false
}Output schema82/100
The output schema explains the structured result.
View output schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"result"
],
"properties": {
"result": {
"oneOf": [
{
"type": "object",
"required": [
"status",
"data"
],
"properties": {
"data": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"status": {
"type": "string",
"const": "success"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"status",
"message"
],
"properties": {
"auth": {
"type": "object",
"required": [
"reason"
],
"properties": {
"reason": {
"type": "string"
}
},
"additionalProperties": false
},
"status": {
"type": "string",
"const": "auth_required"
},
"message": {
"type": "string"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"status",
"clarification"
],
"properties": {
"status": {
"type": "string",
"const": "clarification_required"
},
"clarification": {
"anyOf": [
{
"type": "object",
"required": [
"message",
"workflowId",
"projectId",
"orgId",
"chatSessionId",
"userMessageId",
"assistantMessageId",
"appUrls"
],
"properties": {
"orgId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"appUrls": {
"type": "object",
"required": [
"workflow",
"workflows"
],
"properties": {
"workflow": {
"type": "string",
"format": "uri"
},
"workflows": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"message": {
"type": "string"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workflowId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"chatSessionId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"userMessageId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"assistantMessageId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"message",
"workflowId",
"projectId",
"orgId",
"testableMessages",
"appUrls"
],
"properties": {
"kind": {
"type": "string",
"const": "test_message_selection"
},
"orgId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"appUrls": {
"type": "object",
"required": [
"workflow",
"preview"
],
"properties": {
"preview": {
"type": "string",
"format": "uri"
},
"workflow": {
"type": "string",
"format": "uri"
},
"workflows": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"message": {
"type": "string"
},
"projectId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"workflowId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"testableMessages": {
"type": "array",
"items": {
"type": "object",
"required": [
"testTargetId",
"messageType",
"label",
"requiresRecipient"
],
"properties": {
"label": {
"type": "string"
},
"description": {
"type": "string"
},
"destination": {
"type": "string"
},
"messageType": {
"enum": [
"email",
"slack"
],
"type": "string"
},
"testTargetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"requiresRecipient": {
"type": "boolean"
}
},
"additionalProperties": false
},
"minItems": 2
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"status",
"confirmation"
],
"properties": {
"status": {
"type": "string",
"const": "confirmation_required"
},
"confirmation": {
"anyOf": [
{
"type": "object",
"required": [
"kind",
"action",
"input",
"message",
"previewUrl",
"summary",
"warnings"
],
"properties": {
"kind": {
"type": "string",
"const": "publish"
},
"input": {
"type": "object",
"required": [
"workflowId"
],
"properties": {
"workflowId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Workflow id to publish."
},
"isSandboxed": {
"type": "boolean",
"description": "Whether to publish in sandbox mode so notifications are held for inspection."
},
"expectedUpdatedAtIso": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
],
"description": "Workflow updatedAt timestamp returned by prepare_publish, used as a safety check."
},
"expectedEditableVersionId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"description": "Editable version id returned by prepare_publish, used as a safety check."
},
"expectedPublishedVersionId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"description": "Published version id returned by prepare_publish, used as a safety check."
}
},
"additionalProperties": false
},
"action": {
"type": "string",
"const": "confirm_publish"
},
"appUrls": {
"type": "object",
"required": [
"workflow"
],
"properties": {
"workflow": {
"type": "string",
"format": "uri"
},
"workflows": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"message": {
"type": "string"
},
"summary": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"previewUrl": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"kind",
"action",
"input",
"message",
"previewUrl",
"appUrls",
"summary",
"warnings"
],
"properties": {
"kind": {
"type": "string",
"const": "send_workflow_test"
},
"input": {
"type": "object",
"required": [
"workflowId",
"confirmSend"
],
"properties": {
"rowData": {
"type": "object",
"description": "Optional sample data for rendering draft message variables during the test. If omitted, Dreamlit uses the same default preview data as the web builder when available.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"workflowId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Workflow id whose editable draft message should be tested."
},
"confirmSend": {
"type": "boolean",
"const": true
},
"messageType": {
"enum": [
"email",
"slack"
],
"type": "string",
"description": "Optional message type filter when selecting a draft message to test."
},
"testTargetId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Structured test target id from testableMessages. Do not show this id to users; ask them to choose by message label."
},
"testRecipientEmail": {
"type": "string",
"format": "email",
"pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$",
"description": "Optional recipient for email tests. If omitted, Dreamlit sends to the authenticated user's email address."
}
},
"additionalProperties": false
},
"action": {
"type": "string",
"const": "send_workflow_test"
},
"appUrls": {
"type": "object",
"required": [
"workflow",
"preview"
],
"properties": {
"preview": {
"type": "string",
"format": "uri"
},
"workflow": {
"type": "string",
"format": "uri"
},
"workflows": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
},
"message": {
"type": "string"
},
"summary": {
"type": "array",
"items": {
"type": "string"
}
},
"warnings": {
"type": "array",
"items": {
"type": "string"
}
},
"previewUrl": {
"type": "string",
"format": "uri"
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"status",
"handoff"
],
"properties": {
"status": {
"type": "string",
"const": "handoff_required"
},
"handoff": {
"type": "object",
"required": [
"kind",
"reason",
"message",
"url",
"instructions"
],
"properties": {
"url": {
"type": "string",
"format": "uri"
},
"kind": {
"type": "string",
"const": "browser"
},
"reason": {
"type": "string"
},
"blocker": {
"type": "object",
"required": [
"code",
"detail",
"appliedActionCount"
],
"properties": {
"code": {
"enum": [
"step_needs_detail",
"step_not_editable",
"step_not_built",
"request_unclear"
],
"type": "string",
"description": "step_needs_detail: answer `detail` in a follow-up create_or_update_workflow call with the same workflowId. step_not_editable: change a different step instead. step_not_built: retry once, then finish in the browser. request_unclear: describe the change in more detail and retry."
},
"detail": {
"type": "string",
"description": "The specific missing detail or blocking rule, in plain language."
},
"stepType": {
"enum": [
"database_trigger",
"broadcast_trigger",
"repeating_trigger",
"query",
"wait",
"email",
"slack"
],
"type": "string"
},
"stepTitle": {
"type": "string"
},
"appliedActionCount": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 0
}
},
"description": "Why Dreamlit stopped before finishing the draft. Changes counted in appliedActionCount are already saved.",
"additionalProperties": false
},
"message": {
"type": "string"
},
"instructions": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"status",
"message"
],
"properties": {
"code": {
"type": "string"
},
"status": {
"type": "string",
"const": "error"
},
"message": {
"type": "string"
},
"resetAt": {
"type": "string",
"description": "quota_exceeded: when this month's AI usage resets (ISO 8601)."
},
"billingUrl": {
"type": "string",
"format": "uri",
"description": "quota_exceeded: page where a workspace admin can buy more AI credits."
},
"retryAfterSeconds": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
}
},
"additionalProperties": false
}
],
"description": "Dreamlit MCP result. success responses contain data and appUrls when relevant; auth_required, clarification_required, confirmation_required, handoff_required, and error responses explain the next action."
}
},
"additionalProperties": false
}