@mcp-monorepo/file-browser 1.0.0

package/dist/tools/remove-file.js

@@ -0,0 +1,52 @@
+import { rm, stat } from 'node:fs/promises';
+import { normalize, resolve } from 'node:path';
+import { registerTool } from '@mcp-monorepo/shared';
+import { z } from 'zod';
+import { getWorkingDir } from '../lib/env.js';
+import { validateExists, validateWithinBasePath } from '../lib/validators.js';
+import { getTypeFromStats } from '../lib/walker/better-walker.js';
+export const registerRemoveFileTool = (server) => registerTool(server, {
+    name: 'remove-file',
+    title: 'Remove File',
+    description: 'Removes a file or directory. For directories, removes recursively including all contents.',
+    inputSchema: {
+        filepath: z.string().nonempty('Filepath must be provided'),
+    },
+    outputSchema: {
+        removed: z.string(),
+        type: z.enum([
+            'file',
+            'folder',
+            'block device',
+            'character device',
+            'FIFO',
+            'socket',
+            'symbolic link',
+            'unknown',
+        ]),
+    },
+    isReadOnly: false,
+    isDestructive: true,
+    async fetcher({ filepath }) {
+        const workingDir = getWorkingDir();
+        const path = resolve(workingDir, normalize(filepath));
+        validateWithinBasePath(workingDir, path);
+        await validateExists(path);
+        // Check if it's a file or directory before removal
+        const stats = await stat(path);
+        const type = getTypeFromStats(stats);
+        // Remove file or directory recursively
+        await rm(path, { recursive: true, force: true });
+        return {
+            removed: filepath,
+            type: type,
+        };
+    },
+    formatter({ removed, type }) {
+        return {
+            removed,
+            type: type,
+        };
+    },
+});
+//# sourceMappingURL=remove-file.js.map

package/dist/tools/remove-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"remove-file.js","sourceRoot":"","sources":["../../src/tools/remove-file.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAA;AAC3C,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAE9C,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAC7E,OAAO,EAAE,gBAAgB,EAAiB,MAAM,gCAAgC,CAAA;AAIhF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,MAAiB,EAAE,EAAE,CAC1D,YAAY,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,aAAa;IACnB,KAAK,EAAE,aAAa;IACpB,WAAW,EAAE,2FAA2F;IACxG,WAAW,EAAE;QACX,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;KAC3D;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;QACnB,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC;YACX,MAAM;YACN,QAAQ;YACR,cAAc;YACd,kBAAkB;YAClB,MAAM;YACN,QAAQ;YACR,eAAe;YACf,SAAS;SACV,CAAC;KACH;IACD,UAAU,EAAE,KAAK;IACjB,aAAa,EAAE,IAAI;IACnB,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE;QACxB,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;QAClC,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;QACrD,sBAAsB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QACxC,MAAM,cAAc,CAAC,IAAI,CAAC,CAAA;QAE1B,mDAAmD;QACnD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,CAAA;QAC9B,MAAM,IAAI,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAA;QAEpC,uCAAuC;QACvC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAA;QAEhD,OAAO;YACL,OAAO,EAAE,QAAQ;YACjB,IAAI,EAAE,IAAgB;SACvB,CAAA;IACH,CAAC;IACD,SAAS,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE;QACzB,OAAO;YACL,OAAO;YACP,IAAI,EAAE,IAAgB;SACvB,CAAA;IACH,CAAC;CACF,CAAC,CAAA"}

package/dist/tools/tree-directory.d.ts

@@ -0,0 +1,3 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+export declare const registerTreeDirectoryTool: (server: McpServer) => void;
+//# sourceMappingURL=tree-directory.d.ts.map

package/dist/tools/tree-directory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-directory.d.ts","sourceRoot":"","sources":["../../src/tools/tree-directory.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAA;AAIxE,eAAO,MAAM,yBAAyB,GAAI,QAAQ,SAAS,SAoEvD,CAAA"}

package/dist/tools/tree-directory.js

@@ -0,0 +1,71 @@
+import { posix, resolve } from 'node:path';
+import { registerTool } from '@mcp-monorepo/shared';
+import { z } from 'zod';
+import { getWorkingDir } from '../lib/env.js';
+import { validateIsDir, validateWithinBasePath } from '../lib/validators.js';
+import { traverseDirectoryBFS } from '../lib/walker/better-walker.js';
+export const registerTreeDirectoryTool = (server) => registerTool(server, {
+    name: 'tree-directory',
+    title: 'Tree Directory Contents',
+    description: 'Generates a nested JSON representation with optional filtering of the directory contents.',
+    inputSchema: {
+        dirpath: z
+            .string()
+            .optional()
+            .describe('Relative path to the tree root directory. Defaults to current working directory.'),
+        depth: z.number().min(1).optional().describe('Maximum depth to traverse'),
+        regexp: z
+            .string()
+            .optional()
+            .describe('Only relative paths in unix style (e.g. "dir/to/file.txt") matching this regexp (e.g. "to/.*\\.txt") will be returned.'),
+    },
+    outputSchema: {
+        content: z.unknown(),
+        total: z.number(),
+        message: z.string().optional(),
+    },
+    isReadOnly: true,
+    async fetcher({ dirpath, depth, regexp }) {
+        const workingDir = getWorkingDir();
+        const basePath = resolve(workingDir, dirpath ? posix.normalize(dirpath) : './');
+        validateWithinBasePath(workingDir, basePath);
+        await validateIsDir(basePath);
+        const regex = regexp ? new RegExp(regexp, 'i') : undefined;
+        const files = [];
+        let isLimited = false;
+        for await (const filePath of traverseDirectoryBFS({
+            absoluteFolderPath: basePath,
+            maxDepth: depth,
+        })) {
+            if (!regex || regex.test(filePath.relPath))
+                files.push(filePath);
+            if (files.length > 200) {
+                isLimited = true;
+                break;
+            }
+        }
+        return { files, isLimited };
+    },
+    async formatter({ files, isLimited }) {
+        const content = {};
+        for (const { relPath } of files) {
+            const parts = relPath.split(posix.sep);
+            let current = content;
+            for (let i = 0; i < parts.length; i++) {
+                const part = parts[i];
+                if (!current[part]) {
+                    current[part] = {};
+                }
+                current = current[part];
+            }
+        }
+        return {
+            content,
+            total: files.length,
+            message: isLimited
+                ? 'Number of items exceedeed 200. Results limited in depth. Try a more narrow scope with another dirpath or regex filter.'
+                : undefined,
+        };
+    },
+});
+//# sourceMappingURL=tree-directory.js.map

package/dist/tools/tree-directory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-directory.js","sourceRoot":"","sources":["../../src/tools/tree-directory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAE1C,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,EAAE,aAAa,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAC5E,OAAO,EAAiB,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AAMpF,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,MAAiB,EAAE,EAAE,CAC7D,YAAY,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,gBAAgB;IACtB,KAAK,EAAE,yBAAyB;IAChC,WAAW,EAAE,2FAA2F;IACxG,WAAW,EAAE;QACX,OAAO,EAAE,CAAC;aACP,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CAAC,kFAAkF,CAAC;QAC/F,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;QACzE,MAAM,EAAE,CAAC;aACN,MAAM,EAAE;aACR,QAAQ,EAAE;aACV,QAAQ,CACP,wHAAwH,CACzH;KACJ;IACD,YAAY,EAAE;QACZ,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;QACpB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;QACjB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC/B;IACD,UAAU,EAAE,IAAI;IAChB,KAAK,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE;QACtC,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;QAClC,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAA;QAC/E,sBAAsB,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;QAC5C,MAAM,aAAa,CAAC,QAAQ,CAAC,CAAA;QAE7B,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAE1D,MAAM,KAAK,GAA0C,EAAE,CAAA;QACvD,IAAI,SAAS,GAAG,KAAK,CAAA;QACrB,IAAI,KAAK,EAAE,MAAM,QAAQ,IAAI,oBAAoB,CAAC;YAChD,kBAAkB,EAAE,QAAQ;YAC5B,QAAQ,EAAE,KAAK;SAChB,CAAC,EAAE,CAAC;YACH,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;gBAAE,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YAChE,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;gBACvB,SAAS,GAAG,IAAI,CAAA;gBAChB,MAAK;YACP,CAAC;QACH,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAA;IAC7B,CAAC;IACD,KAAK,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE;QAClC,MAAM,OAAO,GAAe,EAAE,CAAA;QAC9B,KAAK,MAAM,EAAE,OAAO,EAAE,IAAI,KAAK,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YACtC,IAAI,OAAO,GAAG,OAAO,CAAA;YACrB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;gBACtC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAA;gBACrB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACnB,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;gBACpB,CAAC;gBACD,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;YACzB,CAAC;QACH,CAAC;QACD,OAAO;YACL,OAAO;YACP,KAAK,EAAE,KAAK,CAAC,MAAM;YACnB,OAAO,EAAE,SAAS;gBAChB,CAAC,CAAC,wHAAwH;gBAC1H,CAAC,CAAC,SAAS;SACd,CAAA;IACH,CAAC;CACF,CAAC,CAAA"}

package/dist/tools/write-tool.d.ts

@@ -0,0 +1,3 @@
+import type { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+export declare const registerWriteFileTool: (server: McpServer) => void;
+//# sourceMappingURL=write-tool.d.ts.map

package/dist/tools/write-tool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"write-tool.d.ts","sourceRoot":"","sources":["../../src/tools/write-tool.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yCAAyC,CAAA;AAExE,eAAO,MAAM,qBAAqB,GAAI,QAAQ,SAAS,SA0CnD,CAAA"}

package/dist/tools/write-tool.js

@@ -0,0 +1,45 @@
+import { stat, writeFile } from 'node:fs/promises';
+import { mkdir } from 'node:fs/promises';
+import { dirname, normalize, resolve } from 'node:path';
+import { registerTool } from '@mcp-monorepo/shared';
+import { z } from 'zod';
+import { getWorkingDir } from '../lib/env.js';
+import { validateWithinBasePath } from '../lib/validators.js';
+export const registerWriteFileTool = (server) => registerTool(server, {
+    name: 'write-file',
+    title: 'Write File',
+    description: "Create or completely overwrite a file with new content. Creates parent directories if they don't exist.",
+    inputSchema: {
+        filepath: z.string().nonempty('Filepath must be provided'),
+        content: z.string().describe('Content to write to the file'),
+    },
+    outputSchema: {
+        bytesWritten: z.number(),
+        existed: z.boolean(),
+    },
+    isReadOnly: false,
+    async fetcher({ filepath, content }) {
+        const workingDir = getWorkingDir();
+        const path = resolve(workingDir, normalize(filepath));
+        validateWithinBasePath(workingDir, path);
+        const parentDir = dirname(path);
+        await mkdir(parentDir, { recursive: true });
+        const existed = await stat(path)
+            .then((stat) => (stat.isFile() ? true : 'existed, but not a file'))
+            .catch(() => false);
+        if (typeof existed === 'string')
+            throw new Error(`Cannot write to file ${filepath} because it already exists and is not a file.`);
+        await writeFile(path, content, 'utf-8');
+        return {
+            existed,
+            bytesWritten: Buffer.byteLength(content, 'utf-8'),
+        };
+    },
+    formatter({ existed, bytesWritten }) {
+        return {
+            existed,
+            bytesWritten,
+        };
+    },
+});
+//# sourceMappingURL=write-tool.js.map

package/dist/tools/write-tool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"write-tool.js","sourceRoot":"","sources":["../../src/tools/write-tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAA;AACxC,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAEvD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AACnD,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,aAAa,EAAE,MAAM,eAAe,CAAA;AAC7C,OAAO,EAAE,sBAAsB,EAAE,MAAM,sBAAsB,CAAA;AAI7D,MAAM,CAAC,MAAM,qBAAqB,GAAG,CAAC,MAAiB,EAAE,EAAE,CACzD,YAAY,CAAC,MAAM,EAAE;IACnB,IAAI,EAAE,YAAY;IAClB,KAAK,EAAE,YAAY;IACnB,WAAW,EACT,yGAAyG;IAC3G,WAAW,EAAE;QACX,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;QAC1D,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;KAC7D;IACD,YAAY,EAAE;QACZ,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;QACxB,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;KACrB;IACD,UAAU,EAAE,KAAK;IACjB,KAAK,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,OAAO,EAAE;QACjC,MAAM,UAAU,GAAG,aAAa,EAAE,CAAA;QAClC,MAAM,IAAI,GAAG,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAA;QACrD,sBAAsB,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QAExC,MAAM,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;QAC/B,MAAM,KAAK,CAAC,SAAS,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QAE3C,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC;aAC7B,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAE,yBAAmC,CAAC,CAAC;aAC7E,KAAK,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,CAAA;QAErB,IAAI,OAAO,OAAO,KAAK,QAAQ;YAC7B,MAAM,IAAI,KAAK,CAAC,wBAAwB,QAAQ,+CAA+C,CAAC,CAAA;QAClG,MAAM,SAAS,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;QAEvC,OAAO;YACL,OAAO;YACP,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,OAAO,EAAE,OAAO,CAAC;SAClD,CAAA;IACH,CAAC;IACD,SAAS,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE;QACjC,OAAO;YACL,OAAO;YACP,YAAY;SACb,CAAA;IACH,CAAC;CACF,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@mcp-monorepo/file-browser",
+  "version": "1.0.0",
+  "type": "module",
+  "description": "MCP server for file system browsing and manipulation (search, ls, tree, grep, open, write, move, mkdir)",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "mcp-npm-server": "./dist/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "tsc --watch",
+    "start": "node dist/index.js",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit",
+    "clean": "rimraf dist tsconfig.tsbuildinfo"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.0.0",
+    "zod": "^3.25.76",
+    "@mcp-monorepo/shared": "*",
+    "minimatch": "^10.0.3"
+  },
+  "devDependencies": {
+    "@types/node": "^22.14.1",
+    "typescript": "^5.8.3",
+    "vitest": "^3.2.4",
+    "rimraf": "^6.0.1"
+  }
+}