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 detailsget_resource_usage(): Monitor CPU, memory, and disk usageget_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 filefind_log_files(app_name): Locate log files for specific applications
Network & Process Diagnostics
check_network_connectivity(url, timeout=5): Test network connectionscheck_process_status(process_name): Check if processes are runningrun_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
- Fork the repository
- Create a feature branch
- Make your changes
- Add tests if applicable
- Submit a pull request
Support
For issues and questions, please use the GitHub issue tracker.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file troubleshooting_mcp_server-1.0.1.tar.gz.
File metadata
- Download URL: troubleshooting_mcp_server-1.0.1.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ce26673352ac80a06c67184ca95643590b014ff5127828d46828ae76b953298d
|
|
| MD5 |
862ed736d80f5330057facd30c201606
|
|
| BLAKE2b-256 |
64de391008af585eb5fd4654d1f6802318dbbcd435d0c88832c7d84e8f475cd0
|
File details
Details for the file troubleshooting_mcp_server-1.0.1-py3-none-any.whl.
File metadata
- Download URL: troubleshooting_mcp_server-1.0.1-py3-none-any.whl
- Upload date:
- Size: 8.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f634d4589cf72ac20d8ec93499624d318b7ef3dc14dc92a403176a024f9fdcb0
|
|
| MD5 |
9ac8939989565994e2be3929463e742c
|
|
| BLAKE2b-256 |
b17bf5b8670d6a510cf6198c7db82c48739ed0b479b7a161697bedad57debac1
|