veryfront__list_file_chunksAccess
No external-service connection is required. Use a Veryfront credential with access to the requested resources. Call type: Read-only.Arguments
| Field | Type | Required | Description and constraints |
|---|---|---|---|
project_reference | string | No | Project identifier or slug that scopes the tool call. |
file_path | string | Yes | Provide the file path. |
branch_id | string or null | No | Branch ID (null for main) |
release_id | string | No | Release identifier used to scope the request. Format: uuid. |
release_version | string | No | Release version string used to scope the request. |
limit | integer | No | Results per page (default: 100, max: 100) Minimum: 1. Maximum: 100. |
cursor | string | No | Opaque pagination cursor returned by a previous response. |
include_embeddings | boolean | No | Include embedding metadata; defaults to false. Requires embedding_dimension when true. |
embedding_dimension | string | No | Embedding 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.request.json
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "veryfront__list_file_chunks",
"arguments": {
"file_path": "example"
}
}
}
Result
The published output shape is summarized below. Inspect both the MCP response content andisError when handling a call.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data | object[] | Yes | Primary result records returned by the tool. |
page_info | object | Yes | Pagination cursor values for traversing the result set. |
Full schemas
{
"type": "object",
"properties": {
"project_reference": {
"type": "string",
"description": "Project identifier or slug that scopes the tool call."
},
"file_path": {
"type": "string",
"description": "Provide the file path."
},
"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": "Branch ID (null for main)"
},
"release_id": {
"type": "string",
"format": "uuid",
"description": "Release identifier used to scope the request."
},
"release_version": {
"type": "string",
"description": "Release version string used to scope the request."
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Results per page (default: 100, max: 100)"
},
"cursor": {
"type": "string",
"description": "Opaque pagination cursor returned by a previous response."
},
"include_embeddings": {
"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": [
"file_path"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#",
"description": "Arguments for the list_file_chunks tool."
}
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"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."
},
"description": "Primary result records returned by the tool."
},
"page_info": {
"type": "object",
"properties": {
"self": {
"type": [
"string",
"null"
],
"description": "Cursor that refers to the current page."
},
"first": {
"type": "null"
},
"next": {
"type": [
"string",
"null"
],
"description": "Cursor for the next page when pagination is available."
},
"prev": {
"type": [
"string",
"null"
],
"description": "Cursor for the previous page when pagination is available."
}
},
"required": [
"self",
"first",
"next",
"prev"
],
"additionalProperties": false,
"description": "Pagination cursor values for traversing the result set."
}
},
"required": [
"data",
"page_info"
],
"additionalProperties": false,
"description": "Structured result returned by the list_file_chunks tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}