Get project resource

veryfront__get_project_resource

Requires project.resources.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
resource_idstringYesResource ID from list_project_resources
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__get_project_resource",
    "arguments": {
      "resource_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.
patternstringYes
descriptionstringYesHuman-readable description returned by the tool.
titlestring or nullNoShort human-readable title returned by the tool.
source_pathstringYes
edit_modestringYesValues: "structured", "source_only".

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug"
    },
    "resource_id": {
      "type": "string",
      "description": "Resource ID from list_project_resources"
    },
    "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."
    }
  },
  "required": [
    "resource_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the get_project_resource tool."
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the returned record."
    },
    "pattern": {
      "type": "string"
    },
    "description": {
      "type": "string",
      "description": "Human-readable description returned by the tool."
    },
    "title": {
      "type": [
        "string",
        "null"
      ],
      "description": "Short human-readable title returned by the tool."
    },
    "source_path": {
      "type": "string"
    },
    "edit_mode": {
      "type": "string",
      "enum": [
        "structured",
        "source_only"
      ]
    }
  },
  "required": [
    "id",
    "pattern",
    "description",
    "source_path",
    "edit_mode"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_project_resource tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}