local-only server
The server can only run on the client’s local machine because it depends on local resources.
Desktop Commander MCP
Search, update, manage files and run terminal commands with AI
Short version. Four key things. Terminal commands, diff based file editing, ripgrep based text search in folders, ability to read files from urls
Table of Contents
- Features
- Installation
- Usage
- Handling Long-Running Commands
- Work in Progress and TODOs
- Media links
- Testimonials
- Frequently Asked Questions
- Contributing
- License
This is server that allows Claude desktop app to execute long-running terminal commands on your computer and manage processes through Model Context Protocol (MCP) + Built on top of MCP Filesystem Server to provide additional search and replace file editing capabilities .
Features
- Execute terminal commands with output streaming
- Command timeout and background execution support
- Process management (list and kill processes)
- Session management for long-running commands
- Server configuration management:
- Get/set configuration values
- Update multiple settings at once
- Dynamic configuration changes without server restart
- Full filesystem operations:
- Read/write files
- Create/list directories
- Move files/directories
- Search files
- Get file metadata
- Code editing capabilities:
- Surgical text replacements for small changes
- Full file rewrites for major changes
- Multiple file support
- Pattern-based replacements
- vscode-ripgrep based recursive code or text search in folders
Installation
First, ensure you've downloaded and installed the Claude Desktop app and you have npm installed.
Option 1: Install through npx
Just run this in terminal
For debugging mode (allows Node.js inspector connection):
Restart Claude if running
Option 2: Using bash script installer (macOS)
For macOS users, you can use our automated bash installer which will check your Node.js version, install it if needed, and automatically configure Desktop Commander:
This script handles all dependencies and configuration automatically for a seamless setup experience.
Option 3: Installing via Smithery
To install Desktop Commander for Claude Desktop automatically via Smithery:
Option 4: Add to claude_desktop_config by hand
Add this entry to your claude_desktop_config.json:
- On Mac:
~/Library/Application\ Support/Claude/claude_desktop_config.json
- On Windows:
%APPDATA%\Claude\claude_desktop_config.json
- On Linux:
~/.config/Claude/claude_desktop_config.json
Restart Claude if running
Option 5: Checkout locally
- Clone and build:
Restart Claude if running
The setup command will:
- Install dependencies
- Build the server
- Configure Claude's desktop app
- Add MCP servers to Claude's config if needed
Updating Desktop Commander
When installed through npx (Option 1) or Smithery (Option 2), Desktop Commander will automatically update to the latest version whenever you restart Claude. No manual update process is needed.
For manual installations, you can update by running the setup command again.
Usage
The server provides a comprehensive set of tools organized into several categories:
Available Tools
Category | Tool | Description |
---|---|---|
Configuration | get_config | Get the complete server configuration as JSON (includes blockedCommands, defaultShell, allowedDirectories) |
set_config_value | Set a specific configuration value by key. Available settings: • blockedCommands : Array of shell commands that cannot be executed• defaultShell : Shell to use for commands (e.g., bash, zsh, powershell)• allowedDirectories : Array of filesystem paths the server can access for file operations (⚠️ terminal commands can still access files outside these directories) | |
Terminal | execute_command | Execute a terminal command with configurable timeout and shell selection |
read_output | Read new output from a running terminal session | |
force_terminate | Force terminate a running terminal session | |
list_sessions | List all active terminal sessions | |
list_processes | List all running processes with detailed information | |
kill_process | Terminate a running process by PID | |
Filesystem | read_file | Read contents from local filesystem or URLs (supports text and images) |
read_multiple_files | Read multiple files simultaneously | |
write_file | Completely replace file contents (best for large changes) | |
create_directory | Create a new directory or ensure it exists | |
list_directory | Get detailed listing of files and directories | |
move_file | Move or rename files and directories | |
search_files | Find files by name using case-insensitive substring matching | |
search_code | Search for text/code patterns within file contents using ripgrep | |
get_file_info | Retrieve detailed metadata about a file or directory | |
Text Editing | edit_block | Apply surgical text replacements (best for changes <20% of file size) |
Tool Usage Examples
Search/Replace Block Format:
Example:
URL Support
read_file
can now fetch content from both local files and URLs- Example:
read_file
withisUrl: true
parameter to read from web resources - Handles both text and image content from remote sources
- Images (local or from URLs) are displayed visually in Claude's interface, not as text
- Claude can see and analyze the actual image content
- Default 30-second timeout for URL requests
Handling Long-Running Commands
For commands that may take a while:
Configuration Management
⚠️ Important Security Warnings
- Always change configuration in a separate chat window from where you're doing your actual work. Claude may sometimes attempt to modify configuration settings (like
allowedDirectories
) if it encounters filesystem access restrictions during operation. - The
allowedDirectories
setting currently only restricts filesystem operations, not terminal commands. Terminal commands can still access files outside allowed directories. Full terminal sandboxing is on the roadmap.
Configuration Tools
You can manage server configuration using the provided tools:
The configuration is saved to config.json
in the server's working directory and persists between server restarts.
Best Practices
- Create a dedicated chat for configuration changes: Make all your config changes in one chat, then start a new chat for your actual work.
- Be careful with empty
allowedDirectories
: Setting this to an empty array ([]
) grants access to your entire filesystem for file operations. - Use specific paths: Instead of using broad paths like
/
, specify exact directories you want to access. - Always verify configuration after changes: Use
get_config({})
to confirm your changes were applied correctly.
Using Different Shells
You can specify which shell to use for command execution:
This allows you to use shell-specific features or maintain consistent environments across commands.
execute_command
returns after timeout with initial output- Command continues in background
- Use
read_output
with PID to get new output - Use
force_terminate
to stop if needed
Debugging
If you need to debug the server, you can install it in debug mode:
This will:
- Configure Claude to use a separate "desktop-commander" server
- Enable Node.js inspector protocol with
--inspect-brk=9229
flag - Pause execution at the start until a debugger connects
- Enable additional debugging environment variables
To connect a debugger:
- In Chrome, visit
chrome://inspect
and look for the Node.js instance - In VS Code, use the "Attach to Node Process" debug configuration
- Other IDEs/tools may have similar "attach" options for Node.js debugging
Important debugging notes:
- The server will pause on startup until a debugger connects (due to the
--inspect-brk
flag) - If you don't see activity during debugging, ensure you're connected to the correct Node.js process
- Multiple Node processes may be running; connect to the one on port 9229
- The debug server is identified as "desktop-commander-debug" in Claude's MCP server list
Troubleshooting:
- If Claude times out while trying to use the debug server, your debugger might not be properly connected
- When properly connected, the process will continue execution after hitting the first breakpoint
- You can add additional breakpoints in your IDE once connected
Model Context Protocol Integration
This project extends the MCP Filesystem Server to enable:
- Local server support in Claude Desktop
- Full system command execution
- Process management
- File operations
- Code editing with search/replace blocks
Created as part of exploring Claude MCPs: https://youtube.com/live/TlbjFDbl5Us
DONE
- 16-04-2025 Better configurations - Improved settings for allowed paths, commands and shell environments
- 14-04-2025 Windows environment fixes - Resolved issues specific to Windows platforms
- 14-04-2025 Linux improvements - Enhanced compatibility with various Linux distributions
- 12-04-2025 Better allowed directories and blocked commands - Improved security and path validation for file read/write and terminal command restrictions. Terminal still can access files ignoring allowed directories.
- 11-04-2025 Shell configuration - Added ability to configure preferred shell for command execution
- 07-04-2025 Added URL support -
read_file
command can now fetch content from URLs - 28-03-2025 Fixed "Watching /" JSON error - Implemented custom stdio transport to handle non-JSON messages and prevent server crashes
- 25-03-2025 Better code search (merged) - Enhanced code exploration with context-aware results
Work in Progress and TODOs
The following features are currently being explored:
- Support for WSL - Windows Subsystem for Linux integration
- Support for SSH - Remote server command execution
- Better file support like csv/pdf
- Terminal sandboxing for Mac/Linux/Windows for better security
- File reading modes - for example allow to read html as plain text or markdown
Website
Visit our official website at https://desktopcommander.app/ for the latest information, documentation, and updates.
Media
Learn more about this project through these resources:
Article
Claude with MCPs replaced Cursor & Windsurf. How did that happen? - A detailed exploration of how Claude with Model Context Protocol capabilities is changing developer workflows.
Video
Claude Desktop Commander Video Tutorial - Watch how to set up and use the Commander effectively.
Publication at AnalyticsIndiaMag
This Developer Ditched Windsurf, Cursor Using Claude with MCPs
Community
Join our Discord server to get help, share feedback, and connect with other users.
Testimonials
https://www.youtube.com/watch?v=ly3bed99Dy8&lc=UgyyBt6_ShdDX_rIOad4AaABAg
https://www.youtube.com/watch?v=ly3bed99Dy8&lc=UgztdHvDMqTb9jiqnf54AaABAg
https://www.youtube.com/watch?v=ly3bed99Dy8&lc=UgyQFTmYLJ4VBwIlmql4AaABAg
https://www.youtube.com/watch?v=ly3bed99Dy8&lc=Ugy4-exy166_Ma7TH-h4AaABAg
https://medium.com/@pharmx/you-sir-are-my-hero-62cff5836a3e
Contributing
If you find this project useful, please consider giving it a ⭐ star on GitHub! This helps others discover the project and encourages further development.
We welcome contributions from the community! Whether you've found a bug, have a feature request, or want to contribute code, here's how you can help:
- Found a bug? Open an issue at github.com/wonderwhy-er/DesktopCommanderMCP/issues
- Have a feature idea? Submit a feature request in the issues section
- Want to contribute code? Fork the repository, create a branch, and submit a pull request
- Questions or discussions? Start a discussion in the GitHub Discussions tab
All contributions, big or small, are greatly appreciated!
If you find this tool valuable for your workflow, please consider supporting the project.
Frequently Asked Questions
Here are answers to some common questions. For a more comprehensive FAQ, see our detailed FAQ document.
What is DesktopCommanderMCP?
It's an MCP tool that enables Claude Desktop to access your file system and terminal, turning Claude into a versatile assistant for coding, automation, codebase exploration, and more.
How is this different from Cursor/Windsurf?
Unlike IDE-focused tools, Claude Desktop Commander provides a solution-centric approach that works with your entire OS, not just within a coding environment. Claude reads files in full rather than chunking them, can work across multiple projects simultaneously, and executes changes in one go rather than requiring constant review.
Do I need to pay for API credits?
No. This tool works with Claude Desktop's standard Pro subscription ($20/month), not with API calls, so you won't incur additional costs beyond the subscription fee.
Does Desktop Commander automatically update?
Yes, when installed through npx or Smithery, Desktop Commander automatically updates to the latest version when you restart Claude. No manual update process is needed.
What are the most common use cases?
- Exploring and understanding complex codebases
- Generating diagrams and documentation
- Automating tasks across your system
- Working with multiple projects simultaneously
- Making surgical code changes with precise control
I'm having trouble installing or using the tool. Where can I get help?
Join our Discord server for community support, check the GitHub issues for known problems, or review the full FAQ for troubleshooting tips. You can also visit our website FAQ section for a more user-friendly experience. If you encounter a new issue, please consider opening a GitHub issue with details about your problem.
Data Collection
During installation and setup, Desktop Commander collects anonymous usage data to help improve the tool. This includes:
- Operating system information
- Node.js and NPM versions
- Installation method and shell environment
- Error messages (if any occur during setup)
This data is collected using Google Analytics analytics and is associated with a machine-generated unique ID. No personal information is collected. This helps us understand how the tool is being used and identify common issues.
We are currently working on adding a built-in opt-out option for this data collection in an upcoming release. For now, if you wish to opt out, you can block network connections to google-analytics.com
in your firewall settings.
License
MIT
You must be authenticated.
Tools
Allows Claude desktop app to execute terminal commands and edit files on your computer through MCP, with features including command execution, process management, and diff-based file editing.
- Search, update, manage files and run terminal commands with AI
- Table of Contents
- Features
- Installation
- Usage
- Handling Long-Running Commands
- Configuration Management
- Using Different Shells
- Debugging
- Model Context Protocol Integration
- DONE
- Work in Progress and TODOs
- Website
- Media
- Testimonials
- Contributing
- Frequently Asked Questions
- Data Collection
- License