cli-mcp-server 0.1.1__py3-none-any.whl

cli_mcp_server-0.1.1.dist-info/METADATA

@@ -0,0 +1,233 @@
+Metadata-Version: 2.3
+Name: cli-mcp-server
+Version: 0.1.1
+Summary: Command line interface for MCP clients with secure execution and customizable security policies
+Project-URL: Homepage, https://github.com/MladenSU/cli-mcp-server
+Project-URL: Documentation, https://github.com/MladenSU/cli-mcp-server#readme
+Project-URL: Repository, https://github.com/MladenSU/cli-mcp-server.git
+Project-URL: Bug Tracker, https://github.com/MladenSU/cli-mcp-server/issues
+Author-email: Mladen <fangs-lever6n@icloud.com>
+License: MIT
+Keywords: cli,command-line,console,execute,mcp,security,terminal
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: mcp>=1.0.0
+Description-Content-Type: text/markdown
+
+# CLI MCP Server
+
+---
+
+A secure Model Context Protocol (MCP) server implementation for executing controlled command-line operations with
+comprehensive security
+features.
+
+![License](https://img.shields.io/badge/license-MIT-blue.svg)
+![Python Version](https://img.shields.io/badge/python-3.10%2B-blue)
+![MCP Protocol](https://img.shields.io/badge/MCP-Compatible-green)
+
+---
+
+# Table of Contents
+
+1. [Overview](#overview)
+2. [Features](#features)
+3. [Configuration](#configuration)
+4. [Available Tools](#available-tools)
+    - [run_command](#run_command)
+    - [show_security_rules](#show_security_rules)
+5. [Usage with Claude Desktop](#usage-with-claude-desktop)
+    - [Development/Unpublished Servers Configuration](#developmentunpublished-servers-configuration)
+    - [Published Servers Configuration](#published-servers-configuration)
+6. [Security Features](#security-features)
+7. [Error Handling](#error-handling)
+8. [Development](#development)
+    - [Prerequisites](#prerequisites)
+    - [Building and Publishing](#building-and-publishing)
+    - [Debugging](#debugging)
+9. [License](#license)
+
+---
+
+## Overview
+
+This MCP server enables secure command-line execution with robust security measures including command whitelisting, path
+validation, and
+execution controls. Perfect for providing controlled CLI access to LLM applications while maintaining security.
+
+## Features
+
+- 🔒 Secure command execution with strict validation
+- ⚙️ Configurable command and flag whitelisting
+- 🛡️ Path traversal prevention
+- 🚫 Shell operator injection protection
+- ⏱️ Execution timeouts and length limits
+- 📝 Detailed error reporting
+- 🔄 Async operation support
+
+## Configuration
+
+Configure the server using environment variables:
+
+| Variable             | Description                              | Default            |
+ |----------------------|------------------------------------------|--------------------|
+| `ALLOWED_DIR`        | Base directory for command execution     | Required           |
+| `ALLOWED_COMMANDS`   | Comma-separated list of allowed commands | `ls,cat,pwd`       |
+| `ALLOWED_FLAGS`      | Comma-separated list of allowed flags    | `-l,-a,--help`     |
+| `ALLOWED_PATTERNS`   | Comma-separated file patterns            | `*.txt,*.log,*.md` |
+| `MAX_COMMAND_LENGTH` | Maximum command string length            | `1024`             |
+| `COMMAND_TIMEOUT`    | Command execution timeout (seconds)      | `30`               |
+
+## Available Tools
+
+### run_command
+
+Executes whitelisted CLI commands within allowed directories.
+
+**Input Schema:**
+
+ ```json
+ {
+  "command": {
+    "type": "string",
+    "description": "Command to execute (e.g., 'ls -l' or 'cat file.txt')"
+  }
+}
+ ```
+
+### show_security_rules
+
+Displays current security configuration and restrictions.
+
+## Usage with Claude Desktop
+
+Add to your `~/Library/Application\ Support/Claude/claude_desktop_config.json`:
+
+> Development/Unpublished Servers Configuration
+
+ ```json
+{
+  "mcpServers": {
+    "cli-mcp-server": {
+      "command": "uv",
+      "args": [
+        "--directory",
+        "<path/to/the/repo>/cli-mcp-server",
+        "run",
+        "cli-mcp-server"
+      ],
+      "env": {
+        "ALLOWED_DIR": "</your/desired/dir>",
+        "ALLOWED_COMMANDS": "ls,cat,pwd,echo",
+        "ALLOWED_FLAGS": "-l,-a,--help,--version",
+        "ALLOWED_PATTERNS": "*.txt,*.log,*.md",
+        "MAX_COMMAND_LENGTH": "1024",
+        "COMMAND_TIMEOUT": "30"
+      }
+    }
+  }
+}
+ ```
+
+> Published Servers Configuration
+
+```json
+{
+  "mcpServers": {
+    "cli-mcp-server": {
+      "command": "uvx",
+      "args": [
+        "cli-mcp-server"
+      ],
+      "env": {
+        "ALLOWED_DIR": "</your/desired/dir>",
+        "ALLOWED_COMMANDS": "ls,cat,pwd,echo",
+        "ALLOWED_FLAGS": "-l,-a,--help,--version",
+        "ALLOWED_PATTERNS": "*.txt,*.log,*.md",
+        "MAX_COMMAND_LENGTH": "1024",
+        "COMMAND_TIMEOUT": "30"
+      }
+    }
+  }
+}
+```
+
+## Security Features
+
+- ✅ Command whitelist enforcement
+- ✅ Flag validation
+- ✅ Path traversal prevention
+- ✅ Shell operator blocking
+- ✅ Command length limits
+- ✅ Execution timeouts
+- ✅ Working directory restrictions
+
+## Error Handling
+
+The server provides detailed error messages for:
+
+- Security violations
+- Command timeouts
+- Invalid command formats
+- Path security violations
+- Execution failures
+
+## Development
+
+### Prerequisites
+
+- Python 3.10+
+- MCP protocol library
+
+## Development
+
+### Building and Publishing
+
+To prepare the package for distribution:
+
+1. Sync dependencies and update lockfile:
+    ```bash
+    uv sync
+    ```
+
+2. Build package distributions:
+    ```bash
+    uv build
+    ```
+
+   > This will create source and wheel distributions in the `dist/` directory.
+
+3. Publish to PyPI:
+   ```bash
+   uv publish --token {{YOUR_PYPI_API_TOKEN}}
+   ```
+
+### Debugging
+
+Since MCP servers run over stdio, debugging can be challenging. For the best debugging
+experience, we strongly recommend using the [MCP Inspector](https://github.com/modelcontextprotocol/inspector).
+
+You can launch the MCP Inspector via [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) with
+this command:
+
+```bash
+npx @modelcontextprotocol/inspector uv --directory {{your source code local directory}}/unichat-mcp-server run unichat-mcp-server
+```
+
+Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+ ---
+
+For more information or support, please open an issue on the project repository.

cli_mcp_server-0.1.1.dist-info/RECORD

@@ -0,0 +1,5 @@
+cli_mcp_server-0.1.1.dist-info/METADATA,sha256=i0nxSXCRdhvOKKSoA6yM8s6q7IkUZuKrA9_SFA08U34,6740
+cli_mcp_server-0.1.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+cli_mcp_server-0.1.1.dist-info/entry_points.txt,sha256=07bDmJJSXg-6VCFEFTOlsGoxI-0faJafT1yEEjUdN-U,55
+cli_mcp_server-0.1.1.dist-info/licenses/LICENSE,sha256=85rOR_IMpb2VzXBA4VCRZh_KWlaO1Rly8HDYDwGgMWk,1062
+cli_mcp_server-0.1.1.dist-info/RECORD,,

cli_mcp_server-0.1.1.dist-info/WHEEL

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

cli_mcp_server-0.1.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+cli-mcp-server = cli_mcp_server:main

cli_mcp_server-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mladen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.