server.go•6.14 kB
package filesystemserver
import (
"github.com/mark3labs/mcp-filesystem-server/filesystemserver/handler"
"github.com/mark3labs/mcp-go/mcp"
"github.com/mark3labs/mcp-go/server"
)
var Version = "dev"
func NewFilesystemServer(allowedDirs []string) (*server.MCPServer, error) {
h, err := handler.NewFilesystemHandler(allowedDirs)
if err != nil {
return nil, err
}
s := server.NewMCPServer(
"secure-filesystem-server",
Version,
server.WithResourceCapabilities(true, true),
)
// Register resource handlers
s.AddResource(mcp.NewResource(
"file://",
"File System",
mcp.WithResourceDescription("Access to files and directories on the local file system"),
), h.HandleReadResource)
// Register tool handlers
s.AddTool(mcp.NewTool(
"read_file",
mcp.WithDescription("Read the complete contents of a file from the file system."),
mcp.WithString("path",
mcp.Description("Path to the file to read"),
mcp.Required(),
),
), h.HandleReadFile)
s.AddTool(mcp.NewTool(
"write_file",
mcp.WithDescription("Create a new file or overwrite an existing file with new content."),
mcp.WithString("path",
mcp.Description("Path where to write the file"),
mcp.Required(),
),
mcp.WithString("content",
mcp.Description("Content to write to the file"),
mcp.Required(),
),
), h.HandleWriteFile)
s.AddTool(mcp.NewTool(
"list_directory",
mcp.WithDescription("Get a detailed listing of all files and directories in a specified path."),
mcp.WithString("path",
mcp.Description("Path of the directory to list"),
mcp.Required(),
),
), h.HandleListDirectory)
s.AddTool(mcp.NewTool(
"create_directory",
mcp.WithDescription("Create a new directory or ensure a directory exists."),
mcp.WithString("path",
mcp.Description("Path of the directory to create"),
mcp.Required(),
),
), h.HandleCreateDirectory)
s.AddTool(mcp.NewTool(
"copy_file",
mcp.WithDescription("Copy files and directories."),
mcp.WithString("source",
mcp.Description("Source path of the file or directory"),
mcp.Required(),
),
mcp.WithString("destination",
mcp.Description("Destination path"),
mcp.Required(),
),
), h.HandleCopyFile)
s.AddTool(mcp.NewTool(
"move_file",
mcp.WithDescription("Move or rename files and directories."),
mcp.WithString("source",
mcp.Description("Source path of the file or directory"),
mcp.Required(),
),
mcp.WithString("destination",
mcp.Description("Destination path"),
mcp.Required(),
),
), h.HandleMoveFile)
s.AddTool(mcp.NewTool(
"search_files",
mcp.WithDescription("Recursively search for files and directories matching a pattern."),
mcp.WithString("path",
mcp.Description("Starting path for the search"),
mcp.Required(),
),
mcp.WithString("pattern",
mcp.Description("Search pattern to match against file names"),
mcp.Required(),
),
), h.HandleSearchFiles)
s.AddTool(mcp.NewTool(
"get_file_info",
mcp.WithDescription("Retrieve detailed metadata about a file or directory."),
mcp.WithString("path",
mcp.Description("Path to the file or directory"),
mcp.Required(),
),
), h.HandleGetFileInfo)
s.AddTool(mcp.NewTool(
"list_allowed_directories",
mcp.WithDescription("Returns the list of directories that this server is allowed to access."),
), h.HandleListAllowedDirectories)
s.AddTool(mcp.NewTool(
"read_multiple_files",
mcp.WithDescription("Read the contents of multiple files in a single operation."),
mcp.WithArray("paths",
mcp.Description("List of file paths to read"),
mcp.Required(),
mcp.Items(map[string]any{"type": "string"}),
),
), h.HandleReadMultipleFiles)
s.AddTool(mcp.NewTool(
"tree",
mcp.WithDescription("Returns a hierarchical JSON representation of a directory structure."),
mcp.WithString("path",
mcp.Description("Path of the directory to traverse"),
mcp.Required(),
),
mcp.WithNumber("depth",
mcp.Description("Maximum depth to traverse (default: 3)"),
),
mcp.WithBoolean("follow_symlinks",
mcp.Description("Whether to follow symbolic links (default: false)"),
),
), h.HandleTree)
s.AddTool(mcp.NewTool(
"delete_file",
mcp.WithDescription("Delete a file or directory from the file system."),
mcp.WithString("path",
mcp.Description("Path to the file or directory to delete"),
mcp.Required(),
),
mcp.WithBoolean("recursive",
mcp.Description("Whether to recursively delete directories (default: false)"),
),
), h.HandleDeleteFile)
s.AddTool(mcp.NewTool(
"modify_file",
mcp.WithDescription("Update file by finding and replacing text. Provides a simple pattern matching interface without needing exact character positions."),
mcp.WithString("path",
mcp.Description("Path to the file to modify"),
mcp.Required(),
),
mcp.WithString("find",
mcp.Description("Text to search for (exact match or regex pattern)"),
mcp.Required(),
),
mcp.WithString("replace",
mcp.Description("Text to replace with"),
mcp.Required(),
),
mcp.WithBoolean("all_occurrences",
mcp.Description("Replace all occurrences of the matching text (default: true)"),
),
mcp.WithBoolean("regex",
mcp.Description("Treat the find pattern as a regular expression (default: false)"),
),
), h.HandleModifyFile)
s.AddTool(mcp.NewTool(
"search_within_files",
mcp.WithDescription("Search for text within file contents. Unlike search_files which only searches file names, this tool scans the actual contents of text files for matching substrings. Binary files are automatically excluded from the search. Reports file paths and line numbers where matches are found."),
mcp.WithString("path",
mcp.Description("Starting path for the search (must be a directory)"),
mcp.Required(),
),
mcp.WithString("substring",
mcp.Description("Text to search for within file contents"),
mcp.Required(),
),
mcp.WithNumber("depth",
mcp.Description("Maximum directory depth to search (default: unlimited)"),
),
mcp.WithNumber("max_results",
mcp.Description("Maximum number of results to return (default: 1000)"),
),
), h.HandleSearchWithinFiles)
return s, nil
}