Winterm MCP

🚀 WinTerm MCP Service

A Model Context Protocol server that provides programmatic access to Windows terminals. This server enables AI models to interact with the Windows command-line interface through a set of standardized tools.

🚀 Quick Start

The WinTerm MCP Service is a powerful tool that allows AI models to interact with Windows command-line interfaces. Here's how you can get started:

✨ Features

• Write to Terminal: Execute commands or write text to the Windows terminal.
• Read Terminal Output: Retrieve the output of previously executed commands.
• Send Control Characters: Send control signals (e.g., Ctrl+C) to the terminal.
• Windows Native: Specifically designed for Windows command-line interactions.

📦 Installation

1. Clone the repository:

   git clone https://github.com/capecoma/winterm-mcp.git
   cd winterm-mcp
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

4. Configure Claude Desktop:

Add the server configuration to %APPDATA%/Claude/claude_desktop_config.json:

{
  "mcpServers": {
    "github.com/capecoma/winterm-mcp": {
      "command": "node",
      "args": ["path/to/build/index.js"],
      "disabled": false,
      "autoApprove": []
    }
  }
}

⚠️ Important Note

Replace "path/to/build/index.js" with the actual path to your built index.js file.

💻 Usage Examples

Basic Usage

write_to_terminal

Write text or commands to the terminal.

{
  "command": "echo Hello, World!"
}

read_terminal_output

Read a specified number of lines from the terminal output.

{
  "linesOfOutput": 5
}

send_control_character

Send a control character (e.g., Ctrl+C) to the terminal.

{
  "letter": "C"
}

Advanced Usage

For development with automatic rebuild functionality:

npm run dev

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.