Skip to main content

MCP server enabling AI assistants to execute terminal commands through a secure shell interface

Project description

ITMCP

Secure network administration tools for AI assistants through the Model Context Protocol (MCP).

License: MIT

Overview

ITMCP is an MCP server that enables AI assistants to safely execute networking commands inside a Docker container sandbox. It provides a secure interface for running common network diagnostic and administration tools while maintaining strict security controls.

The project implements the Model Context Protocol (MCP) to expose networking tools as callable functions for AI assistants, allowing them to perform network diagnostics and system administration tasks in a controlled environment.

Features

  • Docker Isolation: All commands run in a sandboxed Docker container for enhanced security
  • Security Controls: Comprehensive whitelisting of hosts, directories, and commands
  • Network Diagnostic Tools: SSH, ping, nslookup, telnet, dig, tcpdump, and more
  • File Operations: Secure access to view and analyze files with tools like cat, grep, head, tail
  • Process Management: View running processes with ps and top tools
  • Credential Management: Secure handling of SSH keys and passwords
  • MCP Integration: Full compatibility with the Model Context Protocol
  • Enterprise-Grade Security: Session management, audit logging, and access controls

Installation

Prerequisites

  • Python 3.10 or higher
  • Docker (for containerized execution)
  • MCP library (version 1.0.0 or higher)

Basic Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/itmcp.git
    cd itmcp
    
  2. Install dependencies:

    pip install -e .
    

Docker Setup

  1. Build the Docker container:

    docker build -t itmcp_container .
    
  2. Run the container:

    docker-compose up -d
    

Configuration

ITMCP uses a YAML-based configuration system and environment variables for setup.

Environment Variables

Create a .env file in the project root with the following variables:

# Docker configuration
USE_DOCKER=true
DOCKER_CONTAINER=itmcp_container

# SSH credentials configuration
SSH_CREDENTIALS_PATH=/app/secrets/ssh_credentials.json
SSH_KEYS_PATH=/app/secrets/keys

# Security whitelists
ALLOWED_HOSTS=localhost,127.0.0.1,example.com
ALLOWED_DIRECTORIES=/tmp,/var/log
ALLOWED_REMOTE_COMMANDS=ls,cat,grep

Security Whitelists

ITMCP implements three key whitelists for security:

  1. Allowed Hosts: Restricts which hosts can be targeted by network tools
  2. Allowed Directories: Limits file system access to specific directories
  3. Allowed Remote Commands: Controls which commands can be executed remotely

Available Tools

ITMCP provides the following network administration tools:

Tool Description
ssh_tool Connect to a target via SSH
ping_tool Ping a host to check connectivity
nslookup_tool Perform DNS lookup on a hostname or IP address
telnet_tool Test TCP connectivity to a host and port
dig_tool Perform DNS lookup with dig command
tcpdump_tool Capture network packets (limited time)
ps_tool List running processes
cat_tool Display content of a file
top_tool Display system processes (snapshot)
grep_tool Search for patterns in files
head_tool Display the beginning of a file
tail_tool Display the end of a file

Security Features

ITMCP implements enterprise-grade security features:

Session Management

  • Secure session creation with cryptographic tokens
  • Session expiration and timeout controls
  • Concurrent session limits
  • Session validation and regeneration

Audit Logging

  • Comprehensive command logging
  • User attribution for all actions
  • Success/failure logging
  • Security event flagging
  • Tamper-evident logs

Access Control

  • Command whitelisting
  • Directory restrictions
  • Host restrictions
  • Input validation and sanitization

Docker Integration

ITMCP uses Docker to create a secure sandbox for command execution:

  1. All commands are routed through the Docker container
  2. The container has limited access to the host system
  3. Resource limits can be applied to prevent abuse
  4. Network isolation provides an additional security layer

Usage Examples

MCP Configuration

Claude Desktop Configuration

To use ITMCP with Claude desktop, add the following to your config.json file:

{
  "servers": [
    {
      "name": "itmcp",
      "command": ["python", "-m", "itmcp.server"],
      "environment": {
        "USE_DOCKER": "true",
        "DOCKER_CONTAINER": "itmcp_container",
        "ALLOWED_HOSTS": "localhost,127.0.0.1,yahoo.com,firewall.local"
      }
    }
  ]
}

Cline Configuration

For Cline AI, a more detailed configuration is provided in the mcp-config.json file included in this repository:

{
    "servers": [
        {
            "name": "itmcp",
            "command": [
                "python",
                "-m",
                "itmcp.server"
            ],
            "environment": {
                "USE_DOCKER": "true",
                "DOCKER_CONTAINER": "itmcp_container",
                "ALLOWED_HOSTS": "localhost,127.0.0.1,yahoo.com,firewall.local",
                "ALLOWED_DIRECTORIES": "/tmp,/var/log",
                "ALLOWED_REMOTE_COMMANDS": "ls,cat,grep,ping,ssh,nslookup,dig,telnet,tcpdump,ps,top,head,tail"
            },
            "description": "Secure network administration tools running in a Docker sandbox",
            "tools": [
                {
                    "name": "ssh_tool",
                    "description": "Connect to a target via SSH"
                },
                {
                    "name": "ping_tool",
                    "description": "Ping a host to check connectivity"
                },
                {
                    "name": "nslookup_tool",
                    "description": "Perform DNS lookup on a hostname or IP address"
                },
                {
                    "name": "telnet_tool",
                    "description": "Test TCP connectivity to a host and port"
                },
                {
                    "name": "dig_tool",
                    "description": "Perform DNS lookup with dig command"
                },
                {
                    "name": "tcpdump_tool",
                    "description": "Capture network packets (limited time)"
                },
                {
                    "name": "ps_tool",
                    "description": "List running processes"
                },
                {
                    "name": "cat_tool",
                    "description": "Display content of a file"
                },
                {
                    "name": "top_tool",
                    "description": "Display system processes (snapshot)"
                },
                {
                    "name": "grep_tool",
                    "description": "Search for patterns in files"
                },
                {
                    "name": "head_tool",
                    "description": "Display the beginning of a file"
                },
                {
                    "name": "tail_tool",
                    "description": "Display the end of a file"
                }
            ]
        }
    ]
}

To use this configuration with Cline:

  1. Copy the mcp-config.json file to your Cline configuration directory
  2. Start Cline with the --mcp-config flag pointing to this file
  3. The ITMCP tools will be available for use in your Cline sessions

Example 1: Ping a Host

# Using the ping_tool to check connectivity to yahoo.com
<use_mcp_tool>
<server_name>itmcp</server_name>
<tool_name>ping_tool</tool_name>
<arguments>
{
  "target": "yahoo.com",
  "count": 4
}
</arguments>
</use_mcp_tool>

Example 2: SSH Connection to Firewall

# Using the ssh_tool to connect to a firewall and run a command
<use_mcp_tool>
<server_name>itmcp</server_name>
<tool_name>ssh_tool</tool_name>
<arguments>
{
  "target": "firewall.local",
  "user": "admin",
  "command": "show interface status"
}
</arguments>
</use_mcp_tool>

Example 3: DNS Lookup

# Using the dig_tool to perform a DNS lookup
<use_mcp_tool>
<server_name>itmcp</server_name>
<tool_name>dig_tool</tool_name>
<arguments>
{
  "target": "yahoo.com",
  "type": "MX"
}
</arguments>
</use_mcp_tool>

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your 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 - see the LICENSE file for details.

Author

Andrew Hopper

Security Considerations

ITMCP is designed with security in mind, but proper configuration is essential:

  • Always run in a Docker container for isolation
  • Carefully configure whitelists for hosts, directories, and commands
  • Regularly review audit logs for suspicious activity
  • Keep the system updated with security patches
  • Follow the security best practices in the documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

iflow_mcp_andrewhopper_itmcp-0.1.1.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

iflow_mcp_andrewhopper_itmcp-0.1.1-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file iflow_mcp_andrewhopper_itmcp-0.1.1.tar.gz.

File metadata

  • Download URL: iflow_mcp_andrewhopper_itmcp-0.1.1.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_andrewhopper_itmcp-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c5b506bcfd01306abf587989d6af9afeecb3dd241864d539a79e8e40bc84955f
MD5 3ecc242c9001d0816d3f19fa75d53ab7
BLAKE2b-256 dd40c4aebd7745372508719c59ea71b0b77bdc321ac54448252c205ab86888ee

See more details on using hashes here.

File details

Details for the file iflow_mcp_andrewhopper_itmcp-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: iflow_mcp_andrewhopper_itmcp-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Debian GNU/Linux","version":"13","id":"trixie","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for iflow_mcp_andrewhopper_itmcp-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e2f7a26b023539fff2cc078c991cf41c7046a258bf02ffc1d29fa108bf56fe94
MD5 87f209fdfb2fbf17cb8aec5507f80e48
BLAKE2b-256 538cbca57c41ed482b7b433dde68a43eb969fb5dc73854b9035fe2694c8e507c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page