Skip to main content

Local File Search

Search for files on the local filesystem by fuzzy name matching.

Installation

npm install @framers/agentos-ext-local-file-search

Usage

import { createExtensionPack } from '@framers/agentos-ext-local-file-search';

const pack = createExtensionPack({
config: {
denylist: ['/proc', '/sys', 'node_modules', '.git', '.ssh', '*.key'],
maxResults: 10,
maxDepth: 10,
timeoutMs: 10000,
},
});
ParameterTypeRequiredDescription
querystringYesFilename or partial filename to search for
directorystringNoSpecific directory to search (defaults to full filesystem)

Example

User: "Find pic.png in my Downloads folder"
Tool call: local_file_search({ query: "pic.png", directory: "/Users/me/Downloads" })
Result: [{ path: "/Users/me/Downloads/pic.png", size: 2100000, mimeType: "image/png" }]

Relevance Ranking

Results are ranked by match quality:

Match TypeScoreExample
Exact match1.0pic.png matches pic.png
Without extension0.95pic matches pic.png
Starts with0.8pic matches picture.jpg
Contains0.6report matches quarterly-report.pdf
Fuzzy (Levenshtein ≤ 3)0.06-0.30rprt matches report

Denylist

The denylist filters both directories and files:

  • Directory patterns: /proc, /sys, node_modules, .git, .ssh
  • Glob patterns: *.key, *.pem, *.secret

Configurable via agent.config.json:

{
"fileSearch": {
"denylist": ["/proc", "/sys", "node_modules", ".git", ".ssh", "*.key"],
"maxResults": 10
}
}

License

MIT