Get file chunk

veryfront__get_file_chunk

Requires project.knowledge.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 identifier or slug that scopes the tool call.
chunk_idstringYesProvide the chunk id. Format: uuid.
branch_idstring or nullNoPreview branch ID. Use null for main. Provide exactly one of branch_id, release_id, or release_version.
release_idstringNoRelease ID containing the chunk. Format: uuid.
release_versionstringNoRelease version containing the chunk. Minimum length: 1.
include_embeddingbooleanNoInclude embedding metadata; defaults to false. Requires embedding_dimension when true.
embedding_dimensionstringNoEmbedding dimension: 768, 1024, 1536, 3072, or 4096. Values: "768", "1024", "1536", "3072", "4096".

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_file_chunk",
    "arguments": {
      "chunk_id": "00000000-0000-4000-8000-000000000000"
    }
  }
}

Result

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

FieldTypeRequiredDescription and constraints
chunkobjectYesSearchable chunk extracted from a project file for semantic retrieval.

Full schemas

json
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project identifier or slug that scopes the tool call."
    },
    "chunk_id": {
      "type": "string",
      "format": "uuid",
      "description": "Provide the chunk id."
    },
    "branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Branch identifier. Use null for the main branch when the tool supports it."
        },
        {
          "type": "null",
          "description": "Branch identifier. Use null for the main branch when the tool supports it."
        }
      ],
      "description": "Preview branch ID. Use null for main. Provide exactly one of branch_id, release_id, or release_version."
    },
    "release_id": {
      "type": "string",
      "format": "uuid",
      "description": "Release ID containing the chunk."
    },
    "release_version": {
      "type": "string",
      "minLength": 1,
      "description": "Release version containing the chunk."
    },
    "include_embedding": {
      "type": "boolean",
      "description": "Include embedding metadata; defaults to false. Requires embedding_dimension when true."
    },
    "embedding_dimension": {
      "type": "string",
      "enum": [
        "768",
        "1024",
        "1536",
        "3072",
        "4096"
      ],
      "description": "Embedding dimension: 768, 1024, 1536, 3072, or 4096."
    }
  },
  "required": [
    "chunk_id"
  ],
  "additionalProperties": false,
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "Arguments for the get_file_chunk tool."
}
json
{
  "type": "object",
  "properties": {
    "chunk": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Indexed chunk identifier."
        },
        "file_path": {
          "type": "string",
          "description": "Project-relative file path that produced this chunk."
        },
        "file_id": {
          "type": "string",
          "description": "File identifier when the source file is tracked as a project file."
        },
        "file_version_id": {
          "type": "string",
          "description": "File version identifier used to generate this chunk."
        },
        "index": {
          "type": "number",
          "description": "Zero-based chunk position within the file version."
        },
        "content": {
          "type": "string",
          "description": "Chunk text content used for retrieval and inspection."
        },
        "start_offset": {
          "type": "number",
          "description": "Inclusive character offset where the chunk begins in the source file."
        },
        "end_offset": {
          "type": "number",
          "description": "Exclusive character offset where the chunk ends in the source file."
        },
        "token_count": {
          "type": "number",
          "description": "Approximate token count for the chunk content."
        },
        "source_checksum": {
          "type": "string",
          "description": "Checksum of the source content used to detect stale embeddings."
        },
        "created_at": {
          "type": "string",
          "description": "Timestamp when the chunk was indexed."
        },
        "embedding": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "description": "Embedding record identifier for this indexed chunk."
                },
                "model": {
                  "type": "string",
                  "description": "Embedding model name used to create the vector."
                },
                "status": {
                  "type": "string",
                  "enum": [
                    "ready",
                    "stale",
                    "missing"
                  ],
                  "description": "Embedding availability status for the chunk."
                }
              },
              "required": [
                "id",
                "model",
                "status"
              ],
              "additionalProperties": false,
              "description": "Embedding metadata attached to an indexed file chunk."
            },
            {
              "type": "null",
              "description": "The embedding returned by the tool."
            }
          ],
          "description": "Embedding metadata for the chunk, or null when no embedding is stored."
        }
      },
      "required": [
        "id",
        "file_path",
        "file_version_id",
        "index",
        "content",
        "start_offset",
        "end_offset",
        "token_count",
        "embedding"
      ],
      "additionalProperties": false,
      "description": "Searchable chunk extracted from a project file for semantic retrieval."
    }
  },
  "required": [
    "chunk"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_file_chunk tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}