Read task source

veryfront__read_task_source

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
source_target_kindstringNoSource to read: project or preview_branch. Defaults to runtime_target_kind, then project. Values: "project", "main_branch", "environment", "preview_branch".
target_branch_idstring or nullNoPreview branch to use when the target kind is preview_branch.
runtime_target_kindstring or nullNoUsed as the source target kind when source_target_kind is omitted.
target_environment_idstring or nullNoNot supported for source reads; a non-null value is rejected.

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__read_task_source",
    "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.
sourcestringYesTask source code or structured document content.
schedulablebooleanYesWhether the task can be used from schedulers.
edit_modestringYesEditing mode supported for the task definition. Values: "structured", "source_only".
source_only_reasonsstring[]YesReasons why the task can only be edited as raw source, when applicable.

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"
    },
    "source_target_kind": {
      "type": "string",
      "enum": [
        "project",
        "main_branch",
        "environment",
        "preview_branch"
      ],
      "description": "Source to read: project or preview_branch. Defaults to runtime_target_kind, then project."
    },
    "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."
    },
    "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": "Used as the source target kind when source_target_kind is omitted."
    },
    "target_environment_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Provide the target environment id."
        },
        {
          "type": "null",
          "description": "Provide the target environment id."
        }
      ],
      "description": "Not supported for source reads; a non-null value is rejected."
    }
  },
  "required": [
    "task_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the read_task_source 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."
    },
    "source": {
      "type": "string",
      "description": "Task source code or structured document content."
    },
    "schedulable": {
      "type": "boolean",
      "description": "Whether the task can be used from schedulers."
    },
    "edit_mode": {
      "type": "string",
      "enum": [
        "structured",
        "source_only"
      ],
      "description": "Editing mode supported for the task definition."
    },
    "source_only_reasons": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Reasons why the task can only be edited as raw source, when applicable."
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "target",
    "source_path",
    "source",
    "schedulable",
    "edit_mode",
    "source_only_reasons"
  ],
  "additionalProperties": false,
  "description": "Task definition including editable source content.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}