Tool details
| Field | Value |
|---|---|
| Name | get_file_chunk |
| Group | Search |
Playground
Input schema
Input schema
{
"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."
},
"include_embedding": {
"type": "boolean",
"description": "Provide the include embedding."
}
},
"required": [
"project_reference",
"chunk_id"
],
"additionalProperties": false,
"description": "Input schema for the get_file_chunk tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}
Output schema
Output schema
{
"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#"
}