List workflows

veryfront__list_workflows

Requires project.runs.read.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Read-only.

Arguments

FieldTypeRequiredDescription and constraints
project_referencestringNoProject ID or slug
runtime_target_kindstring or nullNoProvide the runtime target kind.
target_environment_idstring or nullNoProvide the target environment id.
target_branch_idstring or nullNoProvide the target branch id.
source_target_kindstringNoProvide the source target kind. Values: "project", "main_branch", "environment", "preview_branch".

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__list_workflows",
    "arguments": {}
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
dataobject[]YesWorkflow definitions returned for the project.
page_infoobjectYesPagination cursor values for traversing the result set.
diagnosticsobject[]No

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "runtime_target_kind": {
      "anyOf": [
        {
          "type": "string",
          "enum": [
            "main_branch",
            "environment",
            "preview_branch"
          ],
          "description": "Provide the runtime target kind."
        },
        {
          "type": "null",
          "description": "Provide the runtime target kind."
        }
      ],
      "description": "Provide the runtime target kind."
    },
    "target_environment_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target environment id."
        },
        {
          "type": "null",
          "description": "Provide the target environment id."
        }
      ],
      "description": "Provide the target environment id."
    },
    "target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target branch id."
        },
        {
          "type": "null",
          "description": "Provide the target branch id."
        }
      ],
      "description": "Provide the target branch id."
    },
    "source_target_kind": {
      "type": "string",
      "enum": [
        "project",
        "main_branch",
        "environment",
        "preview_branch"
      ],
      "description": "Provide the source target kind."
    }
  },
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the list_workflows tool."
}
json
{
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "Workflow identifier."
          },
          "name": {
            "type": "string",
            "description": "Human-readable workflow name."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "Short description of the workflow purpose."
          },
          "target": {
            "type": "string",
            "description": "Execution target that implements the workflow."
          },
          "source_path": {
            "type": "string",
            "description": "Source file path where the workflow definition lives."
          },
          "edit_mode": {
            "type": "string",
            "enum": [
              "structured",
              "source_only"
            ],
            "description": "Editing mode supported for the workflow definition; source_only definitions reject update_workflow with source_only_conflict."
          },
          "version": {
            "type": [
              "string",
              "null"
            ],
            "description": "Version string for the workflow definition, when tracked."
          },
          "input_schema": {
            "anyOf": [
              {
                "type": "object",
                "additionalProperties": {
                  "description": "Additional structured values associated with this result."
                },
                "description": "Structured input schema details associated with this tool result."
              },
              {
                "type": "null",
                "description": "The input schema returned by the tool."
              }
            ],
            "description": "Structured input schema for workflow execution, when defined."
          },
          "output_schema": {
            "anyOf": [
              {
                "type": "object",
                "additionalProperties": {
                  "description": "Additional structured values associated with this result."
                },
                "description": "Structured output schema details associated with this tool result."
              },
              {
                "type": "null",
                "description": "The output schema returned by the tool."
              }
            ],
            "description": "Structured output schema for workflow execution, when defined."
          },
          "schedulable": {
            "type": "boolean",
            "description": "Whether the workflow can be triggered by schedulers or automations."
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "target",
          "source_path",
          "edit_mode",
          "version",
          "input_schema",
          "output_schema",
          "schedulable"
        ],
        "additionalProperties": false,
        "description": "Workflow definition returned by MCP workflow tools."
      },
      "description": "Workflow definitions returned for the project."
    },
    "page_info": {
      "type": "object",
      "properties": {
        "self": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor that refers to the current page."
        },
        "first": {
          "type": "null"
        },
        "next": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the next page when pagination is available."
        },
        "prev": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cursor for the previous page when pagination is available."
        }
      },
      "required": [
        "self",
        "first",
        "next",
        "prev"
      ],
      "additionalProperties": false,
      "description": "Pagination cursor values for traversing the result set."
    },
    "diagnostics": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "kind": {
            "type": "string",
            "enum": [
              "source_file_diagnostic",
              "source_agent_discovery_error",
              "source_trigger_discovery_error"
            ]
          },
          "source_kind": {
            "type": "string",
            "enum": [
              "agent",
              "prompt",
              "tool",
              "task",
              "workflow",
              "resource",
              "skill",
              "eval",
              "schedule",
              "webhook"
            ]
          },
          "source_path": {
            "type": "string",
            "minLength": 1
          },
          "source_id": {
            "type": "string",
            "minLength": 1
          },
          "code": {
            "type": "string",
            "enum": [
              "parse_error",
              "invalid_definition",
              "dynamic_definition",
              "duplicate_source_id",
              "unsupported_target",
              "manual_conflict"
            ]
          },
          "message": {
            "type": "string",
            "minLength": 1
          },
          "details": {
            "type": "object",
            "additionalProperties": {
              "description": "Additional structured values associated with this result."
            }
          }
        },
        "required": [
          "kind",
          "source_kind",
          "source_path",
          "code",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "data",
    "page_info"
  ],
  "additionalProperties": false,
  "description": "List of workflow definitions for a project.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}