Read prompt source

veryfront__read_prompt_source

Requires project.agents.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
prompt_idstringYesPrompt ID from list_prompts
source_target_kindstringNoSource to read the prompt file from: project or preview_branch. Falls back to runtime_target_kind when omitted. Values: "project", "main_branch", "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.
target_branch_idstring or nullNoPreview branch to use. Required for the preview_branch target; rejected for any other target.

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_prompt_source",
    "arguments": {
      "prompt_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
idstringYesUnique identifier for the returned record.
namestringYesHuman-readable name for the returned record.
descriptionstring or nullYesHuman-readable description returned by the tool.
contentstring or nullYesSource content or body returned by the tool.
source_pathstringYes
sourcestringYes
edit_modestringYesValues: "structured", "source_only".
source_only_reasonsstring[]YesList of source only reasons associated with this tool result.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "prompt_id": {
      "type": "string",
      "description": "Prompt ID from list_prompts"
    },
    "source_target_kind": {
      "type": "string",
      "enum": [
        "project",
        "main_branch",
        "preview_branch"
      ],
      "description": "Source to read the prompt file from: project or preview_branch. Falls back to runtime_target_kind when omitted."
    },
    "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."
    },
    "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. Required for the preview_branch target; rejected for any other target."
    }
  },
  "required": [
    "prompt_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the read_prompt_source tool."
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the returned record."
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the returned record."
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Human-readable description returned by the tool."
    },
    "content": {
      "type": [
        "string",
        "null"
      ],
      "description": "Source content or body returned by the tool."
    },
    "source_path": {
      "type": "string"
    },
    "source": {
      "type": "string"
    },
    "edit_mode": {
      "type": "string",
      "enum": [
        "structured",
        "source_only"
      ]
    },
    "source_only_reasons": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of source only reasons associated with this tool result."
    }
  },
  "required": [
    "id",
    "name",
    "description",
    "content",
    "source_path",
    "source",
    "edit_mode",
    "source_only_reasons"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the read_prompt_source tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}