Filesystem

Provides an MCP endpoint to enforce directory-level access controls via interactive parameters.

typescript

276

GitHub Stars

typescript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "nanbingxyz-mcpsvr": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-filesystem",
        "{{dirs@list::directories you about to access. Include trailing slash}}"
      ]
    }
  }
}

You can deploy and run MCP servers that clients connect to directly. This guide explains how to use a filesystem-focused MCP server, how to install and start it locally, and how to configure it for interactive parameter input so you can tailor its behavior at runtime.

How to use

To use this MCP server with an MCP client, you run the provided stdio command via your environment. The server is designed to be invoked by a client that understands MCP server configurations, and it accepts interactive parameters to control which directories you plan to access.

How to install

Prerequisites: ensure you have Node.js and npm installed on your system. You can verify by running node -v and npm -v.

Install and run the MCP server using the runtime command shown in the configuration example. You do not need to install a global package if you use the MCP command directly.

npx -y @modelcontextprotocol/server-filesystem --api-key YOUR_API_KEY

Additional configuration and examples

Below is a concrete MCP server configuration example. It uses a stdio method with the npx runtime and passes the required interactive parameter for directories.

{
  "mcpServers": {
    "filesystem": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@modelcontextprotocol/server-filesystem", "{{dirs@list::directories you about to access. Include trailing slash}}"]
    }
  }
}

If you want to document the interactive parameter in a structured way, you can extract it like this:

{
  "name": "dirs",
  "type": "list",
  "description": "Directories you about to access. Include trailing slash"
}

Available tools

parameter_extraction

Extracts interactive parameters from server configurations using the {{paramName@paramType::paramDescription}} syntax and converts them into a structured list.

validation_rules

Ensures configuration keys are alphabetically ordered and identifiers start with a letter and are unique.