Skip to main content

A Model Context Protocol server for system troubleshooting and diagnostics

Project description

Troubleshooting MCP Server

A Model Context Protocol (MCP) server that provides system troubleshooting and diagnostic tools for developers and system administrators.

Features

  • System Information: Get comprehensive system details including OS, hardware, and software versions
  • Resource Monitoring: Check CPU, memory, and disk usage
  • Log File Access: Read and tail log files from common system locations
  • Network Diagnostics: Test connectivity to hosts and services
  • Process Management: Check if processes are running and get detailed information
  • Environment Analysis: Inspect environment variables and development tool versions
  • Safe Command Execution: Run whitelisted diagnostic commands securely

Installation

Using uvx (recommended)

uvx troubleshooting-mcp-server

Using pip

pip install troubleshooting-mcp-server

From source

git clone https://github.com/yourusername/troubleshooting-mcp-server
cd troubleshooting-mcp-server
pip install -e .

Usage

As an MCP Server

Add to your MCP client configuration:

{
  "mcpServers": {
    "troubleshooting": {
      "command": "uvx",
      "args": ["troubleshooting-mcp-server"],
      "env": {}
    }
  }
}

Standalone Testing

python -m troubleshooting_mcp_server.server test

Available Tools

System Information

  • get_system_info(): Get OS, hardware, and software details
  • get_resource_usage(): Monitor CPU, memory, and disk usage
  • get_environment_info(): Check environment variables and tool versions

Log Management

  • read_log_file(file_path): Read complete log files (with size limits)
  • tail_log_file(file_path, lines=50): Get last N lines of a log file
  • find_log_files(app_name): Locate log files for specific applications

Network & Process Diagnostics

  • check_network_connectivity(url, timeout=5): Test network connections
  • check_process_status(process_name): Check if processes are running
  • run_diagnostic_command(command): Execute safe diagnostic commands

Security Features

  • Path Restrictions: Log file access limited to safe directories
  • Command Whitelist: Only approved diagnostic commands can be executed
  • File Size Limits: Large files require using tail function
  • Timeout Protection: Commands have execution time limits

Supported Platforms

  • macOS (primary support)
  • Linux (basic support)
  • Windows (limited support)

License

MIT License - see LICENSE file for details.

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests if applicable
  5. Submit a pull request

Support

For issues and questions, please use the GitHub issue tracker.

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

troubleshooting_mcp_server-1.0.1.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

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

troubleshooting_mcp_server-1.0.1-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file troubleshooting_mcp_server-1.0.1.tar.gz.

File metadata

File hashes

Hashes for troubleshooting_mcp_server-1.0.1.tar.gz
Algorithm Hash digest
SHA256 ce26673352ac80a06c67184ca95643590b014ff5127828d46828ae76b953298d
MD5 862ed736d80f5330057facd30c201606
BLAKE2b-256 64de391008af585eb5fd4654d1f6802318dbbcd435d0c88832c7d84e8f475cd0

See more details on using hashes here.

File details

Details for the file troubleshooting_mcp_server-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for troubleshooting_mcp_server-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f634d4589cf72ac20d8ec93499624d318b7ef3dc14dc92a403176a024f9fdcb0
MD5 9ac8939989565994e2be3929463e742c
BLAKE2b-256 b17bf5b8670d6a510cf6198c7db82c48739ed0b479b7a161697bedad57debac1

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