Remote Command MCP

🚀 Remote Command MCP Server

A Model Context Protocol (MCP) server that supports executing remote commands across different operating systems. This server provides a unified interface to execute shell commands and automatically handles platform-specific differences between Windows and Unix-like systems.

🚀 Quick Start

The Remote Command MCP Server offers a seamless way to execute commands across various operating systems. Follow the steps below to get started.

✨ Features

• Cross-platform command execution: Run commands on both Windows and Unix-like systems effortlessly.
• Automated command normalization: Automatically adapt commands to the differences between Windows and Unix systems.
• Built-in error handling and output stream forwarding: Get detailed error messages and forward output streams.
• Working directory specification support: Specify the working directory for command execution.
• Platform-specific shell selection: Choose a specific shell based on the platform.

📦 Installation

1. Clone the repository:

git clone https://github.com/deepsuthar496/Remote-Command-MCP
cd remote-command-server

2. Install dependencies:

npm install

3. Build the project:

npm run build

4. Configure the configuration file:
   • Windows: Write the settings into the config.json file and place it in the src directory.
   • Unix/Linux: Write the settings into the config.json file and place it in the src directory.

💻 Usage Examples

Basic Usage

execute_command("ls")

Advanced Usage

Specify the working directory

execute_command("ls", { cwd: "/path/to/directory" })

Cross-platform command conversion

execute_command("dir", { platform: "unix" }) // Automatically converted to `ls`

Support for pipeline operators

execute_command("ls | grep .txt", { shell: "/bin/sh" })

📚 Documentation

Main Functions

• Cross-platform command execution: Automatically convert platform-specific commands, for example:

  • Windows: dir
  • Unix/Linux: ls

• Error handling: Provide detailed error messages, including stdout and stderr outputs.

Error Handling

If the command execution fails, you will receive an error message:

{
  "content": [
    {
      "type": "text",
      "text": "Command execution error: Command failed with exit code 1"
    }
  ],
  "isError": true
}

Project Structure

remote-command-server/
├── src/
│   └── index.ts    # Main server implementation file
├── package.json
├── tsconfig.json
└── README.md

Build Command

npm run build

This command compiles the TypeScript code and generates an executable file in the build directory.

🔧 Contribution Guide

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add some amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.

📄 License

This project is licensed under the MIT License. Please refer to the LICENSE file for details.