modelcontextprotocol/servers
Watch
1
0
Fork
You've already forked servers
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added README

Browse source
This commit is contained in:
Mahesh Murag 2024-11-20 23:34:00 -05:00
commit 18edebe3c2
No known key found for this signature in database
1 changed files with 18 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

21
src/filesystem/README.md
View file

@ -10,6 +10,8 @@ Node.js server implementing Model Context Protocol (MCP) for filesystem operatio
- Search files - Search files
- Get file metadata - Get file metadata
**Note**: The server will only allow operations within directories specified via `args`.
## API ## API
### Resources ### Resources
@ -29,7 +31,7 @@ Node.js server implementing Model Context Protocol (MCP) for filesystem operatio
- Failed reads won't stop the entire operation - Failed reads won't stop the entire operation
- **write_file** - **write_file**
- Create new file or overwrite existing - Create new file or overwrite existing (exercise caution with this)
- Inputs: - Inputs:
- `path` (string): File location - `path` (string): File location
- `content` (string): File content - `content` (string): File content
@ -70,7 +72,18 @@ Node.js server implementing Model Context Protocol (MCP) for filesystem operatio
- Type (file/directory) - Type (file/directory)
- Permissions - Permissions
## Notes - **list_allowed_directories**
- List all directories the server is allowed to access
- No input required
- Returns:
- Directories that this server can read/write from
- Exercise caution with `write_file`, since it can overwrite an existing file ## Usage with Claude Desktop
- File paths can be absolute or relative Add this to your `claude_desktop_config.json`:
```json
{
"mcp-server-filesystem": {
"command": "mcp-server-filesystem",
"args": ["Users/username/Desktop", "Users/username/Desktop", "/path/to/other/allowed/dir"]
}
}