Add and improve JSDoc comments for core tool methods (#3128)

This commit is contained in:
moon jooho
2025-07-04 09:13:02 +09:00
committed by GitHub
parent 654f8aeb61
commit 8d3fec08e5
7 changed files with 55 additions and 6 deletions

View File

@@ -122,7 +122,11 @@ export class GlobTool extends BaseTool<GlobToolParams, ToolResult> {
}
/**
* Checks if a path is within the root directory.
* Checks if a given path is within the root directory bounds.
* This security check prevents accessing files outside the designated root directory.
*
* @param pathToCheck The absolute path to validate
* @returns True if the path is within the root directory, false otherwise
*/
private isWithinRoot(pathToCheck: string): boolean {
const absolutePathToCheck = path.resolve(pathToCheck);