Ask My Folder Tool

Mastra tool that reads a local folder and returns context for answering questions.

Install

npm i @vaibhav-iyer/ask-my-folder-tool

Usage (attach to an agent)

import { Agent } from "@mastra/core/agent";
import { createAskMyFolderTool } from "@vaibhav-iyer/ask-my-folder-tool";

const readFolder = createAskMyFolderTool({
  root: process.cwd(),
  readOptions: {
    excludeDirs: ["node_modules", ".git", "dist"],
    maxFiles: 200
  }
});

const agent = new Agent({
  id: "repo-agent",
  name: "Repo Agent",
  model: "openai/gpt-4.1",
  tools: { readFolder }
});

Tool API

createAskMyFolderTool({
  root: string,
  id?: string,
  description?: string,
  readOptions?: {
    maxFiles?: number,
    maxFileBytes?: number,
    includeExtensions?: string[],
    excludeDirs?: string[],
    excludeFiles?: string[]
  },
  maxContextChars?: number
})

Exports

• createAskMyFolderTool
• readFolder
• buildContext
• simpleSearchAnswer
• Types: FileDoc, ReadFolderOptions, CreateAskMyFolderToolOptions