Skip to main content
List all indexed chunks for a file.

Tool details

FieldValue
Namelist_file_chunks
GroupSearch

Playground

Input schema

Input schema
{
  "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": "number",
      "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": "Provide the include embeddings."
    }
  },
  "required": [
    "project_reference",
    "file_path"
  ],
  "additionalProperties": false,
  "description": "Input schema for the list_file_chunks tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "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": "object",
          "description": "The first associated with this tool result."
        },
        "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#"
}