@sylphlab/mcp-filesystem
v0.4.6
Published
MCP Filesystem Server
Readme
MCP Filesystem Server (@sylphlab/mcp-filesystem)
Empower your AI agents (like Cline) with secure, efficient, and token-saving access to your project files. This Node.js server implements the Model Context Protocol (MCP) using the tools from @sylphlab/mcp-filesystem-core to provide a robust set of filesystem operations, operating safely within a defined project root directory via stdio.
Installation & Usage
There are several ways to use the Filesystem MCP Server:
1. Recommended: npx (or bunx) via MCP Host Configuration
The simplest way is via npx or bunx, configured directly in your MCP host environment (e.g., Cline's mcp_settings.json). This ensures you always use the latest version from npm without needing local installation.
Example (npx):
{
"mcpServers": {
"filesystem": {
"command": "npx",
"args": ["@sylphlab/mcp-filesystem"],
"name": "Filesystem (npx)"
}
}
}Example (bunx):
{
"mcpServers": {
"filesystem": {
"command": "bunx",
"args": ["@sylphlab/mcp-filesystem"],
"name": "Filesystem (bunx)"
}
}
}Important: The server uses its own Current Working Directory (cwd) as the project root for all filesystem operations. Ensure your MCP Host (e.g., Cline/VSCode) is configured to launch the command with the cwd set to your active project's root directory.
2. Docker (TODO)
(Placeholder: Add Dockerfile, publish image, and provide instructions)
3. Local Build (For Development)
- Clone the monorepo:
git clone https://github.com/sylphlab/mcp.git - Install dependencies:
cd mcp && pnpm install - Build all packages:
pnpm run build(orpnpm --filter @sylphlab/mcp-filesystem build) - Configure MCP Host:
Note: Launch the{ "mcpServers": { "filesystem-local": { "command": "node", "args": ["/path/to/mcp/repo/packages/filesystem/dist/index.js"], "name": "Filesystem (Local Build)" } } }nodecommand from the directory you intend as the project root. Alternatively, runpnpm --filter @sylphlab/mcp-filesystem startfrom the project root.
Features
This server exposes the filesystem tools provided by @sylphlab/mcp-filesystem-core, including:
copyItemsToolcreateFolderTooldeleteItemsTooleditFileToollistFilesToolmoveRenameItemsToolreadFilesToolreplaceContentToolsearchContentToolstatItemsToolwriteFilesTool
Refer to the @sylphlab/mcp-filesystem-core package README for details on each tool's arguments and behavior.
Development
This package is part of the sylphlab/mcp monorepo.
- Clone the monorepo:
git clone https://github.com/sylphlab/mcp.git - Install dependencies:
cd mcp && pnpm install - Build:
pnpm --filter @sylphlab/mcp-filesystem build - Run Locally:
pnpm --filter @sylphlab/mcp-filesystem start(runsnode dist/index.js)
Contributing
Contributions are welcome! Please open an issue or submit a pull request on the GitHub repository.
License
This project is released under the MIT License.
