Tools Reference
The VelaFlows MCP server provides 22 tools across three categories.
Reference Tools (8) — No token required
These tools query bundled documentation data. They work offline and without authentication.
list-services
List all 34 VelaFlows API services with their endpoint counts.
| Parameter | Type | Required | Description |
|---|---|---|---|
| (none) |
Returns: List of services with name, title, description, endpoint count, and base URL.
Example prompt: “List all VelaFlows services”
get-service-endpoints
Get all endpoints for a specific service.
| Parameter | Type | Required | Description |
|---|---|---|---|
service | string | Yes | Service name (e.g., inbox, crm, channels) |
Returns: List of endpoints with HTTP method, path, summary, and tags.
Example prompt: “Show me all inbox service endpoints”
get-endpoint-details
Get the full schema for a specific endpoint — parameters, request body, responses, and error codes.
| Parameter | Type | Required | Description |
|---|---|---|---|
service | string | Yes | Service name |
method | string | Yes | HTTP method (get, post, patch, delete) |
path | string | Yes | Endpoint path (e.g., /conversations) |
Returns: Full endpoint schema including query parameters, path parameters, request body fields with types/validation, response schema, and authentication requirements.
Example prompt: “What are the parameters for the GET /conversations endpoint on the inbox service?“
search-api
Search across all 1,093 endpoints by keyword.
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Search keyword |
service | string | No | Limit search to a specific service |
Returns: Matching endpoints with service name, method, path, and summary.
Example prompt: “Search for endpoints related to sending messages”
list-nodes
List workflow nodes, optionally filtered by category.
| Parameter | Type | Required | Description |
|---|---|---|---|
category | string | No | Filter by category: triggers, actions, conditions, integrations, data, utilities, notifications, control-flow, automation |
Returns: List of nodes with type, name, description, inputs, outputs, and executor type.
Example prompt: “List all condition nodes” or “What workflow nodes are available?“
get-node-details
Get the full configuration schema for a specific workflow node.
| Parameter | Type | Required | Description |
|---|---|---|---|
nodeType | string | Yes | Node type identifier (e.g., send-message, condition, ai-suggest-reply) |
Returns: Full node details: all config fields with type, label, required/optional, default values, validation rules, output labels, help text, and usage examples.
Example prompt: “What config does the send-message node need?“
list-events
List platform events, optionally filtered by category.
| Parameter | Type | Required | Description |
|---|---|---|---|
category | string | No | Filter by category (e.g., inbox, crm, customer, channels) |
Returns: List of events with type, label, category, description, and RabbitMQ exchange.
Example prompt: “List all CRM events”
search-events
Search events by keyword.
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | Yes | Search keyword |
Returns: Matching events with type, label, category, and description.
Example prompt: “Search for events related to conversations”
Live API Tools (8) — Token required
These tools make real HTTP requests to the VelaFlows API. They require a valid VELAFLOWS_API_TOKEN.
api-get
Execute a GET request to any VelaFlows endpoint.
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | Yes | API path (e.g., inbox/conversations, crm/leads) |
params | object | No | Query parameters as key-value pairs |
Example prompt: “GET the list of tags with search=urgent”
api-post
Execute a POST request with a JSON body.
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | Yes | API path |
body | object | Yes | JSON request body |
Example prompt: “Create a new tag named ‘VIP’ with color ‘#ff0000‘“
api-patch
Execute a PATCH request to update a resource.
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | Yes | API path |
body | object | Yes | JSON request body with fields to update |
api-delete
Execute a DELETE request.
| Parameter | Type | Required | Description |
|---|---|---|---|
path | string | Yes | API path |
list-workspaces
List your VelaFlows workspaces.
| Parameter | Type | Required | Description |
|---|---|---|---|
| (none) | Shortcut for GET /auth/workspaces |
get-current-user
Get the authenticated user’s profile.
| Parameter | Type | Required | Description |
|---|---|---|---|
| (none) | Shortcut for GET /auth/me |
list-conversations
List inbox conversations with optional filters.
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Filter by status: open, pending, closed, snoozed |
limit | number | No | Max results (default: 20) |
list-leads
List CRM leads with optional filters.
| Parameter | Type | Required | Description |
|---|---|---|---|
pipelineId | string | No | Filter by pipeline ID |
status | string | No | Filter by status: hot, cold, won, lost |
limit | number | No | Max results (default: 20) |
Workflow Builder Tools (6) — Token required (except validate)
create-workflow
Create a new workflow with trigger and nodes.
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Workflow name |
trigger | object | Yes | Trigger config: { type, config } |
nodes | array | Yes | Array of nodes: [{ id, type, config, next }] |
Example prompt: “Create a workflow named ‘Welcome Flow’ that sends a message when a new conversation starts”
trigger-workflow
Manually trigger a workflow execution.
| Parameter | Type | Required | Description |
|---|---|---|---|
workflowId | string | Yes | Workflow ID |
variables | object | No | Input variables for the execution |
list-workflows
List existing workflows.
| Parameter | Type | Required | Description |
|---|---|---|---|
status | string | No | Filter: draft, active, paused, archived |
limit | number | No | Max results |
get-workflow-executions
Get execution history for a workflow.
| Parameter | Type | Required | Description |
|---|---|---|---|
workflowId | string | Yes | Workflow ID |
limit | number | No | Max results |
suggest-workflow
Describe what you want in plain English and get a suggested workflow configuration.
| Parameter | Type | Required | Description |
|---|---|---|---|
description | string | Yes | Plain English description of the desired automation |
Returns: A structured workflow DAG with trigger, nodes, and connections — ready to pass to create-workflow.
Example prompt: “Suggest a workflow that enriches new leads with Apollo data and sends a Slack notification”
validate-workflow
Validate a workflow configuration before saving. No token required — runs locally against bundled data.
| Parameter | Type | Required | Description |
|---|---|---|---|
trigger | object | Yes | Trigger config to validate |
nodes | array | Yes | Node array to validate |
Returns: { valid: boolean, errors: string[] } — checks that node types exist, required config fields are present, and node connections are valid.
Example prompt: “Validate this workflow config before I create it”