From da695fe05a70628dfec0de012f905120f4ae89e2 Mon Sep 17 00:00:00 2001 From: Jeffrey Ling Date: Fri, 6 Dec 2024 17:37:39 -0700 Subject: [PATCH] cleanup diffs and improve glob matching --- src/filesystem/README.md | 113 +++++++++++++++++++++++++++++++++++++++ src/filesystem/index.ts | 36 ++++++------- 2 files changed, 128 insertions(+), 21 deletions(-) diff --git a/src/filesystem/README.md b/src/filesystem/README.md index 1e066a87..79c2b0f3 100644 --- a/src/filesystem/README.md +++ b/src/filesystem/README.md @@ -1,3 +1,111 @@ +# Filesystem MCP Server + +Node.js server implementing Model Context Protocol (MCP) for filesystem operations. + +## Features + +- Read/write files +- Create/list/delete directories +- Move files/directories +- Search files +- Get file metadata + +**Note**: The server will only allow operations within directories specified via `args`. + +## API + +### Resources + +- `file://system`: File system operations interface + +### Tools + +- **read_file** + - Read complete contents of a file + - Input: `path` (string) + - Reads complete file contents with UTF-8 encoding + +- **read_multiple_files** + - Read multiple files simultaneously + - Input: `paths` (string[]) + - Failed reads won't stop the entire operation + +- **write_file** + - Create new file or overwrite existing (exercise caution with this) + - Inputs: + - `path` (string): File location + - `content` (string): File content + +- **edit_file** + - Make selective edits using advanced pattern matching and formatting + - Features: + - Line-based and multi-line content matching + - Whitespace normalization with indentation preservation + - Fuzzy matching with confidence scoring + - Multiple simultaneous edits with correct positioning + - Indentation style detection and preservation + - Git-style diff output with context + - Preview changes with dry run mode + - Failed match debugging with confidence scores + - Inputs: + - `path` (string): File to edit + - `edits` (array): List of edit operations + - `oldText` (string): Text to search for (can be substring) + - `newText` (string): Text to replace with + - `dryRun` (boolean): Preview changes without applying (default: false) + - `options` (object): Optional formatting settings + - `preserveIndentation` (boolean): Keep existing indentation (default: true) + - `normalizeWhitespace` (boolean): Normalize spaces while preserving structure (default: true) + - `partialMatch` (boolean): Enable fuzzy matching (default: true) + - Returns detailed diff and match information for dry runs, otherwise applies changes + - Best Practice: Always use dryRun first to preview changes before applying them + +- **create_directory** + - Create new directory or ensure it exists + - Input: `path` (string) + - Creates parent directories if needed + - Succeeds silently if directory exists + +- **list_directory** + - List directory contents with [FILE] or [DIR] prefixes + - Input: `path` (string) + +- **move_file** + - Move or rename files and directories + - Inputs: + - `source` (string) + - `destination` (string) + - Fails if destination exists + +- **search_files** + - Recursively search for files/directories + - Inputs: + - `path` (string): Starting directory + - `pattern` (string): Search pattern + - `excludePatterns` (string[]): Exclude any patterns. Glob formats are supported. + - Case-insensitive matching + - Returns full paths to matches + +- **get_file_info** + - Get detailed file/directory metadata + - Input: `path` (string) + - Returns: + - Size + - Creation time + - Modified time + - Access time + - Type (file/directory) + - Permissions + +- **list_allowed_directories** + - List all directories the server is allowed to access + - No input required + - Returns: + - Directories that this server can read/write from + +## Usage with Claude Desktop +Add this to your `claude_desktop_config.json`: +```json { "mcpServers": { "filesystem": { @@ -11,3 +119,8 @@ } } } +``` + +## License + +This MCP server is licensed under the MIT License. This means you are free to use, modify, and distribute the software, subject to the terms and conditions of the MIT License. For more details, please see the LICENSE file in the project repository. \ No newline at end of file diff --git a/src/filesystem/index.ts b/src/filesystem/index.ts index 782e34a5..730721de 100644 --- a/src/filesystem/index.ts +++ b/src/filesystem/index.ts @@ -163,13 +163,7 @@ const server = new Server( }, { capabilities: { - listChanged: false, - tools: { - search_files: { - description: "Recursively search for files/directories with optional exclude patterns", - inputSchema: zodToJsonSchema(SearchFilesArgsSchema), - }, - }, + tools: {}, }, }, ); @@ -208,7 +202,7 @@ async function searchFiles( // Check if path matches any exclude pattern const relativePath = path.relative(rootPath, fullPath); const shouldExclude = excludePatterns.some(pattern => { - const globPattern = pattern.startsWith('*') ? pattern : `*/${pattern}/*`; + const globPattern = pattern.includes('*') ? pattern : `**/${pattern}/**`; return minimatch(relativePath, globPattern, { dot: true }); }); @@ -438,18 +432,6 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => { const { name, arguments: args } = request.params; switch (name) { - case "search_files": { - const parsed = SearchFilesArgsSchema.safeParse(args); - if (!parsed.success) { - throw new Error(`Invalid arguments for search_files: ${parsed.error}`); - } - const validPath = await validatePath(parsed.data.path); - const results = await searchFiles(validPath, parsed.data.pattern, parsed.data.excludePatterns); - return { - content: [{ type: "text", text: results.length > 0 ? results.join("\n") : "No matches found" }], - }; - } - case "read_file": { const parsed = ReadFileArgsSchema.safeParse(args); if (!parsed.success) { @@ -548,6 +530,18 @@ server.setRequestHandler(CallToolRequestSchema, async (request) => { }; } + case "search_files": { + const parsed = SearchFilesArgsSchema.safeParse(args); + if (!parsed.success) { + throw new Error(`Invalid arguments for search_files: ${parsed.error}`); + } + const validPath = await validatePath(parsed.data.path); + const results = await searchFiles(validPath, parsed.data.pattern, parsed.data.excludePatterns); + return { + content: [{ type: "text", text: results.length > 0 ? results.join("\n") : "No matches found" }], + }; + } + case "get_file_info": { const parsed = GetFileInfoArgsSchema.safeParse(args); if (!parsed.success) { @@ -592,6 +586,6 @@ async function runServer() { } runServer().catch((error) => { - console.error("Server error:", error); + console.error("Fatal error running server:", error); process.exit(1); });