MCP Terminal Server

🚀 MCP Terminal Server

A secure command-line interface server for the Model Context Protocol (MCP), enabling AI models to interact with your terminal while maintaining security and control.

🚀 Quick Start

To use the MCP Terminal Server with Claude Desktop, follow these steps:

1. Add the server configuration to your Claude Desktop configuration file:

{
  "mcpServers": {
    "terminal": {
      "command": "npx",
      "args": [
        "@dillip285/mcp-terminal",
        "--allowed-paths",
        "/path/to/allowed/directory"
      ]
    }
  }
}

2. Restart Claude Desktop to apply the changes. You can now use the terminal functionality through Claude, enjoying secure file access and command execution.

✨ Features

• 🔒 Secure command execution with configurable permissions.
• 📁 File system operations within allowed paths.
• 🌍 Environment variable management.
• 💻 Cross-platform support (Windows, macOS, Linux).
• 🔌 Connect to remote systems via command execution.

💻 Usage Examples

Available Tools

• execute_command: Securely run terminal commands (including SSH and remote commands).

🔧 Technical Details

Security

• All operations are restricted to the specified allowed paths.
• Commands are verified and sanitized before execution.
• Environment variables are strictly managed.
• Security-related errors are properly handled.

📦 Installation

Development

# Clone the repository
git clone https://github.com/dillip285/mcp-terminal.git

# Install dependencies
npm install

# Configure npm authentication
cp .npmrc.example .npmrc
# Edit .npmrc and add your NPM_TOKEN

# Run tests
npm test

# Build the project
npm run build

Publishing

To publish the package:

1. Copy .npmrc.example to .npmrc.
2. Add your npm authentication token to .npmrc.
3. Run npm publish --access public.

⚠️ Important Note

Never commit the authentication token in the .npmrc file. It has already been added to .gitignore.

🤝 Contribution

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

📄 License

This project is under the MIT License. For more details, please refer to the LICENSE file.

🔗 Related Projects

• Model Context Protocol
• Claude Desktop

🛠️ Support

For bug reports and feature requests, please open an Issue.