Skip to content

[FEATURE] sse attempt #2 #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[FEATURE] sse attempt #2 #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 36 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Desktop Commander MCP
### Search, update, manage files and run terminal commands with AI
### Search, update, manage files and run terminal commands with AI (now with SSE support)

[![npm downloads](https://img.shields.io/npm/dw/@wonderwhy-er/desktop-commander)](https://www.npmjs.com/package/@wonderwhy-er/desktop-commander)
[![smithery badge](https://smithery.ai/badge/@wonderwhy-er/desktop-commander)](https://smithery.ai/server/@wonderwhy-er/desktop-commander)
Expand All @@ -9,7 +9,7 @@
[![Discord](https://img.shields.io/badge/Join%20Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/kQ27sNnZr7)


Work with code and text, run processes, and automate tasks, going far beyond other AI editors - without API token costs.
Work with code and text, run processes, and automate tasks, going far beyond other AI editors - without API token costs. Now with Server-Sent Events (SSE) support for remote connections!


![Desktop Commander MCP](https://raw.githubusercontent.com/wonderwhy-er/ClaudeComputerCommander/main/docs/vertical_video_mobile.mp4)
Expand Down Expand Up @@ -58,6 +58,12 @@ Execute long-running terminal commands on your computer and manage processes thr
- Multiple file support
- Pattern-based replacements
- vscode-ripgrep based recursive code or text search in folders
- **NEW: Server-Sent Events (SSE) support**:
- Run as an HTTP server for remote connections
- Support for the latest MCP Streamable HTTP Transport
- Compatible with various MCP clients
- Session management for multiple concurrent connections
- Cross-origin request support for web clients

## Installation
First, ensure you've downloaded and installed the [Claude Desktop app](https://claude.ai/download) and you have [npm installed](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
Expand Down Expand Up @@ -132,6 +138,31 @@ When installed through npx (Option 1) or Smithery (Option 3), Desktop Commander

For manual installations, you can update by running the setup command again.

### Using Server-Sent Events (SSE)

Desktop Commander can also be run as an HTTP server with Server-Sent Events (SSE) support, allowing remote connections from MCP clients:

```bash
# Install and run with SSE enabled (dual mode - both STDIO and HTTP)
npx @wonderwhy-er/desktop-commander-sse start:sse

# Run in SSE-only mode (HTTP server only, no STDIO)
npx @wonderwhy-er/desktop-commander-sse start:sse-only

# Specify a custom port (default is 3000)
npx @wonderwhy-er/desktop-commander-sse start:sse --port 8080
```

When running in SSE mode, the server provides an HTTP endpoint at `/mcp` that implements the MCP Streamable HTTP transport protocol. This allows you to connect to the server remotely using any MCP client that supports this protocol.

The server supports:
- GET requests for establishing Server-Sent Events connections
- POST requests for sending commands to the server
- Session management for multiple concurrent connections
- CORS headers for cross-origin requests from web clients (including claude.ai, cursor.sh, etc.)

The HTTP server is accessible at `http://localhost:3000/mcp` by default.

Comment on lines +141 to +165
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Documented SSE endpoint (/mcp) does not match the implementation (/messages)

src/http-server.ts uses /messages for the streaming endpoint, yet the README instructs users to connect to /mcp. This mismatch will lead to 404s and support questions.
Please align the docs with the code (or vice-versa) before shipping.

## Usage

The server provides a comprehensive set of tools organized into several categories:
Expand Down Expand Up @@ -297,6 +328,7 @@ This project extends the MCP Filesystem Server to enable:
Created as part of exploring Claude MCPs: https://youtube.com/live/TlbjFDbl5Us

## DONE
- **13-05-2025 Added Server-Sent Events (SSE) support** - Implemented Streamable HTTP transport protocol for remote connections
- **29-04-2025 Telemetry Opt Out through configuration** - There is now setting to disable telemetry in config, ask in chat
- **23-04-2025 Enhanced edit functionality** - Improved format, added fuzzy search and multi-occurrence replacements, should fail less and use edit block more often
- **16-04-2025 Better configurations** - Improved settings for allowed paths, commands and shell environments
Expand All @@ -313,6 +345,8 @@ Terminal still can access files ignoring allowed directories.

The following features are currently being explored:

- **Advanced SSE authentication** - Secure token-based authentication for remote connections
- **Remote collaborative sessions** - Allow multiple clients to connect to the same server session
- **Support for WSL** - Windows Subsystem for Linux integration
- **Support for SSH** - Remote server command execution
- **Better file support for formats like CSV/PDF**
Expand Down
Loading