Skip to content

Function: addDocumentsTool()

addDocumentsTool(options?): Tool<{ documents: Record<string, unknown>[]; index?: string; }, { count: number; index: string; }, unknown, unknown, ToolExecutionContext<unknown, unknown, unknown>, string, unknown>

Build the opt-in add_documents tool (write into a direct-access index). Only install it when the plugin’s write surface is enabled.

SearchToolOptions = {}

Tool<{ documents: Record<string, unknown>[]; index?: string; }, { count: number; index: string; }, unknown, unknown, ToolExecutionContext<unknown, unknown, unknown>, string, unknown>