Plandex · Schema

ContextItem

A single item loaded into a Plandex plan's context: a file, directory tree, directory map, URL, note, image, or piped data.

AIAI Coding AgentDeveloper ToolsOpen SourceCLITerminalLLMCoding AssistantAgentsGoContext ManagementPlansSelf-HostedREST

Properties

Name	Type	Description
id	string
planId	string
branch	string
name	string
type	string	Source type of the loaded context.
path	string	Path or URL of the source.
body	string	Loaded body (may be omitted in list views to save tokens).
tokens	integer
tokensCached	boolean	Whether the body is cached against the model provider's prompt cache.
imageDetail	string
addedAt	string
updatedAt	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/plandex/main/json-schema/plandex-server-context-item-schema.json",
  "title": "ContextItem",
  "description": "A single item loaded into a Plandex plan's context: a file, directory tree, directory map, URL, note, image, or piped data.",
  "type": "object",
  "required": ["id", "type"],
  "properties": {
    "id": {"type": "string"},
    "planId": {"type": "string"},
    "branch": {"type": "string"},
    "name": {"type": "string"},
    "type": {
      "type": "string",
      "enum": ["file", "directoryTree", "directoryMap", "url", "note", "image", "pipedData"],
      "description": "Source type of the loaded context."
    },
    "path": {"type": "string", "description": "Path or URL of the source."},
    "body": {"type": "string", "description": "Loaded body (may be omitted in list views to save tokens)."},
    "tokens": {"type": "integer", "minimum": 0},
    "tokensCached": {"type": "boolean", "description": "Whether the body is cached against the model provider's prompt cache."},
    "imageDetail": {"type": "string", "enum": ["high", "low"]},
    "addedAt": {"type": "string", "format": "date-time"},
    "updatedAt": {"type": "string", "format": "date-time"}
  },
  "additionalProperties": false
}