MCP Lcu Server

🚀 MCP Linux Utility Plugin

The MCP Linux Utility Plugin is a powerful tool that allows users to access and control various functions of a Linux system via the MCP protocol. This README provides detailed instructions on how to install, configure, and use this plugin.

🚀 Quick Start

📦 Installation

1. Get the code

   git clone https://github.com/your-username/mcplinux.git
   cd mcplinux
   

2. Install dependencies

   • For Python 3 environment:

     pip install -r requirements.txt
     

3. Start the plugin

   • Start the MCP plugin server:

     python3 server.py [--port PORT] [--config CONFIG_FILE]
     

     Here, --port is optional, with a default value of 5000; --config is the path to the configuration file.

4. Configure the plugin

   • Create or edit the config.yml file:

     server:
       port: 5000
       host: 0.0.0.0
     
     filesystem:
       allowed_paths:
         - "/safe/directory"
         - "/another/safe/path"
     
     network:
       allowed_domains:
         - "example.com"
         - "another.example.org"
     
     command:
       enabled: true
       allowed_commands:
         - "ls"
         - "cat /etc/os-release"
       blocked_commands:
         - "rm"
         - "sudo"
       allow_sudo: false
       timeout: 30  # seconds
       output_limit: 1024  # bytes
     
     monitoring:
       interval: 60  # seconds
     

💻 Usage Examples

Basic Usage

1. Start the plugin server

   python3 server.py --port 5000
   

   This will start the server at the address http://localhost:5000.

2. Access resources via MCP

   • Use the MCP client to access resources:

     from mcpclient import MCPClient
     
     client = MCPClient("localhost", 5000)
     print(client.request("linux://system/info"))  # Get system information
     

Advanced Usage

System Tools

• Command Execution
  • Execute shell commands:

    result = client.execute("ls /safe/directory")
    print(result)
    

  • Configuration options:

    command:
      enabled: true
      allowed_commands:
        - "ls"
        - "cat /etc/os-release"
      blocked_commands:
        - "rm"
        - "sudo"
      allow_sudo: false
      timeout: 30  # seconds
      output_limit: 1024  # bytes
    

File System Operations

• Access files

  file_info = client.request("linux://fs/info/usr/local/bin/myfile")
  print(file_info)
  

• Read directory contents

  dir_content = client.request(f"linux://fs/dir/{safe_path}")
  print(dir_content)
  

Network Configuration

• Get network interface status

  network_stats = client.request("linux://network/interfaces")
  print(network_stats)
  

• Set the default gateway

  curl -X POST "http://localhost:5000/api/network/gateway" -d '{"gateway":"192.168.1.1"}'
  

Monitoring Functions

• Get system load

  load_avg = client.request("linux://system/load")
  print(load_avg)
  

• Collect disk usage

  disk_usage = client.request("linux://system/disk")
  print(disk_usage)
  

🔒 Security Precautions

Configure Security Parameters

• Limit access paths

  filesystem:
    allowed_paths:
      - "/safe/directory"
      - "/another/safe/path"
  

• Restrict network domains

  network:
    allowed_domains:
      - "example.com"
      - "another.example.org"
  

Command Execution Security

command:
  enabled: true
  allowed_commands:
    - "ls"
    - "cat /etc/os-release"
  blocked_commands:
    - "rm"
    - "sudo"
  allow_sudo: false
  timeout: 30  # seconds
  output_limit: 1024  # bytes

📄 License

The MCP Linux Utility Plugin project is released under the MIT License. For details, please refer to the LICENSE file.

Example: Use the MCP client to get system information

from mcpclient import MCPClient

# Create an MCP client instance
client = MCPClient("localhost", 5000)

# Get system information
system_info = client.request("linux://system/info")
print("System Information:")
print(system_info)

# Get network interface status
network_interfaces = client.request("linux://network/interfaces")
print("\nNetwork Interfaces:")
print(network_interfaces)

# Get disk usage
disk_usage = client.request("linux://system/disk")
print("\nDisk Usage:")
print(disk_usage)

Example: Modify network settings via API

# Set the default gateway
curl -X POST "http://localhost:5000/api/network/gateway" -d '{"gateway":"192.168.1.1"}'