Terminal MCP Server

🚀 Terminal MCP Server

This repository contains an implementation of the Model Context Protocol (MCP) server for terminal commands.

🚀 Quick Start

✨ Features

This server enables Claude to execute terminal commands within specified directories through the Terminal MCP Server.

📦 Installation

Prerequisites

• Node.js (v16 or higher)
• npm (v7 or higher)

Local Installation

1. Clone the repository:

git clone https://github.com/algae514/terminal-mcp-server.git
cd terminal-mcp-server

2. Install dependencies:

npm install

3. Build the project:

npm run build

4. Make the startup script executable:

chmod +x start-server.sh

Configuration

To use this server with Claude, you need to update your Claude configuration file to include the Terminal MCP Server.

Update your Claude configuration file (usually located at ~/.config/claude/claude_desktop_config.json or similar) to include the following:

{
  "mcpServers": {
    "filesystem": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-filesystem",
        "/path/to/directory1",
        "/path/to/directory2",
        "/path/to/directory3"
      ]
    },
    "terminal": {
      "command": "/path/to/terminal-mcp-server/start-server.sh",
      "args": []
    }
  }
}

Replace /path/to/directory1, /path/to/directory2, etc., with the directories you want to make accessible to Claude.

Replace /path/to/terminal-mcp-server with the actual location where you cloned the repository.

💻 Usage Examples

Basic Usage

After configuration, Claude can execute terminal commands in the specified directories via the Terminal MCP Server.

🔧 Technical Details

Security Precautions

• To allow the terminal to run commands in a directory, you need to provide these locations in the maven - tool.json file. Example URLs have been provided.
• Be extremely cautious about the directories exposed to Claude, as it will be able to execute commands in such locations.
• Consider using a dedicated user with restricted permissions to run the server.
• Check the commands executed by Claude to ensure they are safe and appropriate.

📄 License

MIT License