search_metadata returns only the matching properties, filtered by category, nameContains, or valueContains. Use it when the question is about a specific property rather than the whole set. Example prompt: “Does this file mention the old company name anywhere in its properties?”
Tool description (as the AI agent sees it):
Searches the metadata inside a single document and returns only the matching properties as JSON — use this instead of ReadMetadata when the user asks about a SPECIFIC property rather than the whole set. Call it for ‘show me the author of report.pdf’, ‘what is the creation date?’, ‘does photo.jpg have GPS?’, or to check a value like ‘does contract.docx have Author = ABC?’. Filters (combine any): category (person, content, time, tool, legal, corporate, document, gps, comments, keywords), nameContains, valueContains — all case-insensitive. Supports PDF, DOCX, XLSX, PPTX, JPEG, PNG, TIFF, MP3, MP4 and 100+ more formats. Returns a JSON object with fields count and properties (array of { name, value, category }); count 0 means no match. On failure the response text starts with ‘Metadata search failed for’.
A JSON array of the properties that matched, with their package, name, and value.
The valueContains filter is the interesting one for privacy work: it answers “does any property still contain this name / this path / this address?” across every metadata package in the file, in one call.
On failure the text starts with Metadata search failed for, followed by the exception type and message.
Example prompts
“Does this document still mention the old company name in its properties?”
“Show me just the author and last-modified-by fields.”
“Find any property whose value contains an @ sign.”
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.