linux-mcp-server 0.1.0a2__py3-none-any.whl

linux_mcp_server-0.1.0a2.dist-info/METADATA

@@ -0,0 +1,233 @@
+Metadata-Version: 2.4
+Name: linux-mcp-server
+Version: 0.1.0a2
+Summary: MCP server for read-only Linux system administration, diagnostics, and troubleshooting
+Author: RHEL Lightspeed
+License-File: LICENSE
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Natural Language :: English
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Systems Administration
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: asyncssh>=2.14.0
+Requires-Dist: bcrypt
+Requires-Dist: mcp>=0.9.0
+Requires-Dist: psutil>=5.9.0
+Description-Content-Type: text/markdown
+
+[![CI](https://github.com/rhel-lightspeed/linux-mcp-server/actions/workflows/ci.yml/badge.svg)](https://github.com/rhel-lightspeed/linux-mcp-server/actions/workflows/ci.yml)
+[![Coverage](https://codecov.io/gh/rhel-lightspeed/linux-mcp-server/graph/badge.svg?token=TtUkG1y0rx)](https://codecov.io/gh/rhel-lightspeed/linux-mcp-server)
+![PyPI](https://img.shields.io/pypi/v/linux-mcp-server?label=PyPI)
+
+
+# Linux MCP Server
+
+A Model Context Protocol (MCP) server for read-only Linux system administration, diagnostics, and troubleshooting on RHEL-based systems.
+
+
+## Features
+
+- **Read-Only Operations**: All tools are strictly read-only for safe diagnostics
+- **Remote SSH Execution**: Execute commands on remote systems via SSH with key-based authentication
+- **Multi-Host Management**: Connect to different remote hosts in the same session
+- **Comprehensive Diagnostics**: System info, services, processes, logs, network, and storage
+- **Configurable Log Access**: Control which log files can be accessed via environment variables
+- **RHEL/systemd Focused**: Optimized for Red Hat Enterprise Linux systems
+
+
+## Installation
+
+Python 3.10 or later is required.
+
+### Install with `pip`
+
+Create and activate a virtual environment, then install using `pip`:
+```bash
+pip install linux-mcp-server
+```
+
+Or install in the Python user directory
+```bash
+pip install --user linux-mcp-server
+```
+
+### Install with `uv`
+
+Install using `uv`
+```bash
+uv tool install linux-mcp-server
+```
+
+See the [complete installation guide](docs/Install.md) for more details.
+
+
+## Configuration
+
+Key environment variables:
+- `LINUX_MCP_ALLOWED_LOG_PATHS` - Comma-separated list of log files that can be accessed
+- `LINUX_MCP_LOG_LEVEL` - Logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
+- `LINUX_MCP_SSH_KEY_PATH` - Path to SSH private key for remote execution
+
+See [Environment Variables](docs/Install.md#environment-variables) for more details.
+
+
+## Audit Logging
+
+All server operations are logged in both human-readable and JSON formats with automatic daily rotation and configurable retention. Logs are stored in `~/.local/share/linux-mcp-server/logs/`.
+
+
+## Tool execution
+
+All tools support optional `host` and `username` parameters for remote execution via SSH:
+
+- **Authentication**: SSH key-based authentication only (no password support)
+- **Key Discovery**: Automatically discovers SSH keys from `~/.ssh/` or use `LINUX_MCP_SSH_KEY_PATH`
+- **Connection Pooling**: Reuses SSH connections for efficiency
+- **Multi-Host**: Each tool call can target a different remote host
+
+**Requirements**:
+- SSH key-based authentication must be configured on remote hosts
+- Remote user must have appropriate permissions for diagnostic commands
+
+
+## Usage
+
+### Running the Server
+
+#### Installed using `pip`
+
+Run from within the virtual environment:
+```bash
+[path to virtual environment]/bin/linux-mcp-server
+```
+
+Or run from the Python user directory:
+```bash
+~/.local/bin/linux-mcp-server
+```
+
+#### Installed using `uv`
+
+```bash
+uv tool run linux-mcp-server
+```
+
+For detailed usage instructions, available tools, and example troubleshooting sessions, see [Usage](docs/Usage.md).
+
+### Using with Claude Desktop
+
+For complete Claude Desktop integration instructions including platform-specific config file locations and alternative configurations, see [Claude Desktop Integration](docs/Install.md#claude-desktop-integration).
+
+
+## Available Tools
+
+### System Information
+- `get_system_information` - OS version, kernel, hostname, uptime
+- `get_cpu_information` - CPU details and load averages
+- `get_memory_information` - RAM usage and swap details
+- `get_disk_usage` - Filesystem usage and mount points
+- `get_hardware_information` - Hardware details (CPU architecture, PCI/USB devices, memory hardware)
+
+### Service Management
+- `list_services` - List all systemd services with status
+- `get_service_status` - Detailed status of a specific service
+- `get_service_logs` - Recent logs for a specific service
+
+### Process Management
+- `list_processes` - Running processes with CPU/memory usage
+- `get_process_info` - Detailed information about a specific process
+
+### Logs & Audit
+- `get_journal_logs` - Query systemd journal with filters
+- `get_audit_logs` - Read audit logs (if available)
+- `read_log_file` - Read specific log file (whitelist-controlled)
+
+### Network Diagnostics
+- `get_network_interfaces` - Network interface information
+- `get_network_connections` - Active network connections
+- `get_listening_ports` - Ports listening on the system
+
+### Storage & Disk Analysis
+- `list_block_devices` - Block devices and partitions
+- `list_directories_by_size` - List directories sorted by size (largest first) with top N limit
+- `list_directories_by_name` - List all directories sorted alphabetically (A-Z or Z-A)
+- `list_directories_by_modified_date` - List all directories sorted by modification date (newest/oldest first)
+
+
+## Architecture Overview
+
+```mermaid
+graph TB
+    Client["Client Layer<br/>MCP Client (e.g. Claude Desktop)"]
+
+    subgraph Server["MCP Server"]
+        FastMCP[FastMCP Server]
+
+        subgraph Tools["Tool Categories"]
+            direction LR
+            subgraph Row1[" "]
+                SystemInfo[System Info]
+                Services[Services]
+                Processes[Processes]
+            end
+            subgraph Row2[" "]
+            Logs[Logs & Audit]
+                Network[Network]
+                Storage[Storage]
+            end
+        end
+
+        Executor[SSH Executor]
+        Logger[Audit Logger]
+    end
+
+    subgraph Targets["Execution Targets"]
+        direction LR
+        Local[Local System]
+        Remote[Remote Hosts<br/>SSH]
+    end
+
+    Client -->|MCP Protocol| FastMCP
+    FastMCP --> Tools
+    Tools --> Executor
+    Executor --> Targets
+
+    FastMCP -.-> Logger
+    Executor -.-> Logger
+
+    style Client fill:#4a9eff,stroke:#2563eb,color:#fff
+    style FastMCP fill:#f59e0b,stroke:#d97706,color:#fff
+    style SystemInfo fill:#64748b,stroke:#475569,color:#fff
+    style Services fill:#64748b,stroke:#475569,color:#fff
+    style Processes fill:#64748b,stroke:#475569,color:#fff
+    style Logs fill:#64748b,stroke:#475569,color:#fff
+    style Network fill:#64748b,stroke:#475569,color:#fff
+    style Storage fill:#64748b,stroke:#475569,color:#fff
+    style Executor fill:#10b981,stroke:#059669,color:#fff
+    style Logger fill:#8b5cf6,stroke:#7c3aed,color:#fff
+    style Local fill:#eab308,stroke:#ca8a04,color:#fff
+    style Remote fill:#eab308,stroke:#ca8a04,color:#fff
+    style Row1 fill:none,stroke:none
+    style Row2 fill:none,stroke:none
+```
+
+### Key Components
+
+- **FastMCP Server**: Core MCP protocol server handling tool registration and invocation
+- **Tool Categories**: Six categories of read-only diagnostic tools (system info, services, processes, logs, network, storage)
+- **SSH Executor**: Routes commands to local subprocess or remote SSH execution with connection pooling
+- **Audit Logger**: Comprehensive logging in both human-readable and JSON formats with automatic rotation
+- **Multi-Target Execution**: Single server instance can execute commands on local system or multiple remote hosts

linux_mcp_server-0.1.0a2.dist-info/RECORD

@@ -0,0 +1,24 @@
+linux_mcp_server/__init__.py,sha256=alJtQ0tfC5ZhUYGrzM4o_xDbwm7lFntEbUhKBYXUu-g,86
+linux_mcp_server/__main__.py,sha256=bIvw9JDojEOSAyRU3j5pspl25UfpgLyVdy_8414fo38,798
+linux_mcp_server/audit.py,sha256=aWoLUmYR6vzDdTOEmvEEkFywW5k6W8I7ckXNjUP1rFQ,8516
+linux_mcp_server/logging_config.py,sha256=bfBU3vqEn1W_mUg3JDIl7A4mgsbYs8GZ3y9B6MJekYo,5174
+linux_mcp_server/server.py,sha256=SeBx5umDMnSGOKh5asZFfHVAZSAAqQUD2oDfzEhvdKw,315
+linux_mcp_server/connection/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+linux_mcp_server/connection/ssh.py,sha256=Z9fq3zcqz-stQtyx2_M1uWTBm_SBxi116_qtty2LuTo,11627
+linux_mcp_server/tools/__init__.py,sha256=5O_HHSRiwoHJ_TP875UMlK_Fo6X-96TdluFnrt7EK1Q,1677
+linux_mcp_server/tools/logs.py,sha256=E0waRWNP94-0E-CIM3T5MwFDfDr7QCntXrlqu0BN7b0,7461
+linux_mcp_server/tools/network.py,sha256=bDhgevaueeOxmy68yP39uB8U3vY1ci2TIQECI0fbCKA,10758
+linux_mcp_server/tools/processes.py,sha256=sQU2We4TcLFPtK-e2ddx3VYos-w-Mub_IZPSOQWs0uk,10328
+linux_mcp_server/tools/services.py,sha256=-pAusZM6AQZu8EUp7zCXcDpELcaYaPUXadufWFt5_xM,5172
+linux_mcp_server/tools/storage.py,sha256=edr1fDXTFnyu6_SZBnKft43SUKcDILMh1ygc-OiuAtg,6784
+linux_mcp_server/tools/system_info.py,sha256=g2ZbNiZDtYG7LCJwZxx6frkjbdeuKbTZctJbj5ftWFY,19404
+linux_mcp_server/utils/__init__.py,sha256=28xG2GP65TF1DvjbD2HX8R__VHUHAWEiDNU53oQdBpQ,130
+linux_mcp_server/utils/enum.py,sha256=SKBSHNiLyPp-rvJbDPkVak2XdxFgaLdGbwAWEY4P6Xk,271
+linux_mcp_server/utils/format.py,sha256=6wP8pefLZYK6eQ1VwPfVHUfzjVhjHDnTjoG_LBiGON4,617
+linux_mcp_server/utils/types.py,sha256=xaZoz9tpBMbYGmdzKw8JcmK-qJU4csUDnVlhV0WA25U,170
+linux_mcp_server/utils/validation.py,sha256=UTLLH_jC-mA96QCcHShWrRUXtCVFEWz75_7J2DopR_Q,1755
+linux_mcp_server-0.1.0a2.dist-info/METADATA,sha256=tbBga18z4KrPRE9Vsk_hoT5Q2i6o001TdSH3neS1j5A,8357
+linux_mcp_server-0.1.0a2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+linux_mcp_server-0.1.0a2.dist-info/entry_points.txt,sha256=TVzOzNkzp99ltOQ8SHTA1U-92A_hydczj6EhsqPVChg,67
+linux_mcp_server-0.1.0a2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+linux_mcp_server-0.1.0a2.dist-info/RECORD,,

linux_mcp_server-0.1.0a2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

linux_mcp_server-0.1.0a2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+linux-mcp-server = linux_mcp_server.__main__:cli

linux_mcp_server-0.1.0a2.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.