Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.shingleai.com/llms.txt

Use this file to discover all available pages before exploring further.

The ShingleAI MCP server provides 7 tools for managing automations and inspecting their execution history. These tools are organized into two categories: automations and executions.

​
Automations

Core tools for creating, reading, updating, and deleting automations.

​
createAutomation

Create a new automation with trigger event, conditions, and instructions. Permission: automations:write Parameters:
NameTypeRequiredDescription
namestringYesThe name of the automation
descriptionstringNoA description of what the automation does
triggerEventstring | nullNoThe event type that triggers this automation (e.g., “message”, “contact”, “customer”)
conditionRecord<string, string | boolean>NoA key-value map of conditions that must be met for the automation to execute. Values must be strings or booleans (no nesting)
instructionsstringYesNatural language instructions describing what the automation should do
createdBystring (UUID)NoThe user ID who created the automation
enabledbooleanNoWhether the automation is enabled (defaults to true)
After creation, the automation is generated and evaluated asynchronously. System-managed fields like generated code, evaluation results, group metadata, and execution counters are populated by the platform — do not pass them in here, as they are overwritten or ignored.
Returns: The created automation object.

​
getAutomation

Get details of a specific automation by ID. Permission: automations:read Parameters:
NameTypeRequiredDescription
automationIdstring (UUID)YesThe ID of the automation to retrieve
Returns: The automation object, or null if not found.

​
listAutomations

List automations with pagination. Permission: automations:read Parameters:
NameTypeRequiredDefaultDescription
limitnumberNo20Number of automations to return (1-100)
offsetnumberNo0Number of automations to skip for pagination
Returns: 
{
  "automations": [...],
  "count": 42,
  "limit": 20,
  "offset": 0
}

​
updateAutomation

Update an existing automation - all fields are optional except automationId. Permission: automations:write Parameters:
NameTypeRequiredDescription
automationIdstring (UUID)YesThe ID of the automation to update
namestringNoUpdate the automation name
descriptionstringNoUpdate the description
triggerEventstringNoUpdate the trigger event
conditionRecord<string, string | boolean>NoUpdate the conditions. Values must be strings or booleans (no nesting)
instructionsstringNoUpdate the instructions
createdBystring (UUID)NoUpdate the creator
enabledbooleanNoEnable or disable the automation
Returns: The updated automation object.

​
deleteAutomation

Delete an automation (soft delete). Permission: automations:delete Parameters:
NameTypeRequiredDescription
automationIdstring (UUID)YesThe ID of the automation to delete
Returns: The deleted automation object.

​
Executions

Tools for inspecting individual automation executions and their history.

​
getAutomationExecution

Get details of a specific automation execution by ID. Permission: automations.executions:read Parameters:
NameTypeRequiredDescription
executionIdstring (UUID)YesThe ID of the automation execution to retrieve
Returns: The automation execution object, or null if not found.

​
listAutomationExecutions

List automation executions with pagination, optionally filtered by automation ID. Permission: automations.executions:read Parameters:
NameTypeRequiredDefaultDescription
automationIdstring (UUID)No-Filter executions by automation ID
limitnumberNo20Number of executions to return (1-100)
offsetnumberNo0Number of executions to skip for pagination
Returns: 
{
  "executions": [...],
  "count": 17,
  "limit": 20,
  "offset": 0
}

​
Next Steps

Contact Tools

Manage contacts and their associated data

Authentication

Learn how MCP clients authenticate to the server