Get task

veryfront__get_task

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
task_idstringYesTask ID from list_tasks, for example sync-data
source_target_kindstringNoSource to read: project, main_branch, environment or preview_branch. Overrides runtime_target_kind. Values: "project", "main_branch", "environment", "preview_branch".
runtime_target_kindstring or nullNoRuntime target to read from: main_branch, environment or preview_branch.
target_environment_idstring or nullNoEnvironment to read from when the target kind is environment.
target_branch_idstring or nullNoPreview branch to use when the target kind is 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__get_task",
    "arguments": {
      "task_id": "example"
    }
  }
}

Result

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

FieldTypeRequiredDescription and constraints
idstringYesTask identifier.
namestringYesHuman-readable task name.
descriptionstring or nullYesShort description of what the task does.
targetstringYesExecution target that implements the task.
source_pathstringYesSource file path where the task definition lives.
edit_modestringYesEditing mode supported for the task definition; source_only definitions reject update_task with source_only_conflict. Values: "structured", "source_only".
input_schemaobject or nullYesStructured input schema for task execution, when defined.
output_schemaobject or nullYesStructured output schema for task execution, when defined.
schedulablebooleanYesWhether the task can be used from cron schedules or workflow schedulers.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "task_id": {
      "type": "string",
      "description": "Task ID from list_tasks, for example sync-data"
    },
    "source_target_kind": {
      "type": "string",
      "enum": [
        "project",
        "main_branch",
        "environment",
        "preview_branch"
      ],
      "description": "Source to read: project, main_branch, environment or preview_branch. Overrides runtime_target_kind."
    },
    "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": "Runtime target to read from: main_branch, environment or preview_branch."
    },
    "target_environment_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target environment id."
        },
        {
          "type": "null",
          "description": "Provide the target environment id."
        }
      ],
      "description": "Environment to read from when the target kind is environment."
    },
    "target_branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target branch id."
        },
        {
          "type": "null",
          "description": "Provide the target branch id."
        }
      ],
      "description": "Preview branch to use when the target kind is preview_branch."
    }
  },
  "required": [
    "task_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the get_task tool."
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Task identifier."
    },
    "name": {
      "type": "string",
      "description": "Human-readable task name."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Short description of what the task does."
    },
    "target": {
      "type": "string",
      "description": "Execution target that implements the task."
    },
    "source_path": {
      "type": "string",
      "description": "Source file path where the task definition lives."
    },
    "edit_mode": {
      "type": "string",
      "enum": [
        "structured",
        "source_only"
      ],
      "description": "Editing mode supported for the task definition; source_only definitions reject update_task with source_only_conflict."
    },
    "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 task 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 task execution, when defined."
    },
    "schedulable": {
      "type": "boolean",
      "description": "Whether the task can be used from cron schedules or workflow schedulers."
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "target",
    "source_path",
    "edit_mode",
    "input_schema",
    "output_schema",
    "schedulable"
  ],
  "additionalProperties": false,
  "description": "Task definition.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}