Get cache entry

veryfront__get_cache_entry

A missing or expired key returns found=false, not an error.

Requires project.cache.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; optional on a project-scoped connection
keystringYesCache key, 1 to 512 characters: letters, digits, underscore, colon, dot, hyphen and slash. No "." or ".." segments between slashes. Minimum length: 1. Maximum length: 512.

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_cache_entry",
    "arguments": {
      "key": "example"
    }
  }
}

Result

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

FieldTypeRequiredDescription and constraints
project_idstringYesProject that owns the cache.
keystringYesCache key.
foundbooleanYesWhether a live entry exists for the key. A miss is a result, not an error.
valuestring or nullYesStored value, always decompressed; null when found is false.
expires_atstring or nullYesRFC 3339 UTC time the entry expires, or null for a miss or for an entry written through the legacy no-expiry path (ttl=0).

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project ID or slug; optional on a project-scoped connection"
    },
    "key": {
      "type": "string",
      "minLength": 1,
      "maxLength": 512,
      "pattern": "^[a-zA-Z0-9_:.\\-/]+$",
      "description": "Cache key, 1 to 512 characters: letters, digits, underscore, colon, dot, hyphen and slash. No \".\" or \"..\" segments between slashes."
    }
  },
  "required": [
    "key"
  ],
  "additionalProperties": false,
  "description": "Arguments for the get_cache_entry tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "project_id": {
      "type": "string",
      "description": "Project that owns the cache."
    },
    "key": {
      "type": "string",
      "description": "Cache key."
    },
    "found": {
      "type": "boolean",
      "description": "Whether a live entry exists for the key. A miss is a result, not an error."
    },
    "value": {
      "type": [
        "string",
        "null"
      ],
      "description": "Stored value, always decompressed; null when found is false."
    },
    "expires_at": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null",
          "description": "The expires at returned by the tool."
        }
      ],
      "description": "RFC 3339 UTC time the entry expires, or null for a miss or for an entry written through the legacy no-expiry path (ttl=0)."
    }
  },
  "required": [
    "project_id",
    "key",
    "found",
    "value",
    "expires_at"
  ],
  "additionalProperties": false,
  "description": "One cache entry, or a miss for its key.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}