universal-cli-mcp-server 0.1.0__tar.gz

universal_cli_mcp_server-0.1.0/.gitignore

@@ -0,0 +1,24 @@
+# Python
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+coverage.xml
+coverage-html/
+dist/
+build/
+*.egg-info/
+.venv/
+
+# Generated documentation and exports
+docs/*-mcp.md
+tools.json
+openapi.json
+
+# Editors and OS
+.idea/
+.vscode/
+.DS_Store
+Thumbs.db

universal_cli_mcp_server-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+                                 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 the direction
+      and management of the Work and the risks associated with using it,
+      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.

universal_cli_mcp_server-0.1.0/PKG-INFO

@@ -0,0 +1,381 @@
+Metadata-Version: 2.5
+Name: universal-cli-mcp-server
+Version: 0.1.0
+Summary: Swagger for command line tools — expose any CLI as a fully compliant MCP server
+Project-URL: Homepage, https://github.com/AndreasHeine/cli-mcp
+Project-URL: Repository, https://github.com/AndreasHeine/cli-mcp
+Project-URL: Issues, https://github.com/AndreasHeine/cli-mcp/issues
+Author: Andreas Heine
+License: Apache-2.0
+License-File: LICENSE
+Keywords: cli,discovery,json-schema,mcp,model-context-protocol,openapi
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.13
+Requires-Dist: httpx>=0.27
+Requires-Dist: mcp>=1.9
+Requires-Dist: pydantic>=2.9
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.9
+Requires-Dist: typer>=0.15
+Requires-Dist: uvicorn>=0.30
+Provides-Extra: dev
+Requires-Dist: mypy>=1.13; extra == 'dev'
+Requires-Dist: pre-commit>=4.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest-cov>=6.0; extra == 'dev'
+Requires-Dist: pytest>=8.3; extra == 'dev'
+Requires-Dist: ruff>=0.8; extra == 'dev'
+Requires-Dist: types-pyyaml>=6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# cli-mcp
+
+**Swagger for Command Line Tools**
+
+`cli-mcp` exposes command-line applications through a
+[Model Context Protocol](https://modelcontextprotocol.io) (MCP) server — without you
+writing a single line of MCP code.
+
+Like Swagger/OpenAPI describes an HTTP API, cli-mcp describes CLI commands, their arguments,
+and their results as structured tools. It also executes those tools with argument validation
+and configured execution controls, and can export OpenAPI documentation.
+Automatic discovery depends on the CLI's help format or supported framework; use a manifest
+when explicit metadata is needed. Windows `.bat`/`.cmd` targets are not supported.
+
+```text
+Today:      CLI Tool  ->  custom MCP wrapper  ->  MCP client
+With cli-mcp: CLI Tool ->  cli-mcp             ->  MCP client
+```
+
+```bash
+cli-mcp expose git
+cli-mcp expose kubectl
+cli-mcp expose docker
+cli-mcp expose opcua-nodeset-linker
+```
+
+```text
+✓ Binary detected
+✓ Commands discovered
+✓ Schemas generated
+✓ MCP tools published
+✓ MCP server started
+```
+
+Works with Claude, Copilot, Cursor, VS Code, Cline, Roo Code, Open WebUI and any other
+MCP-compatible client.
+
+---
+
+## Install
+
+Requires Python 3.13 or newer. CI covers Windows and Linux with Python 3.13 and 3.14.
+
+```bash
+pip install cli-mcp
+```
+
+or, for development:
+
+```bash
+git clone https://github.com/AndreasHeine/cli-mcp
+cd cli-mcp
+uv sync --extra dev
+uv run cli-mcp --help
+```
+
+## Quick start
+
+Only expose trusted programs. These quick-start examples do **not** enable read-only mode
+or sandboxing; discovery itself runs help commands on the host.
+
+```bash
+# Discover commands and serve them over stdio (the default transport)
+cli-mcp expose git
+
+# Look at the generated tools without starting a server
+cli-mcp inspect kubectl
+
+# Serve over Streamable HTTP
+cli-mcp serve docker --transport streamable-http --port 8801
+
+# Export machine-readable artefacts
+cli-mcp export git -o tools.md
+cli-mcp export-schema git -o schemas.json
+cli-mcp export-openapi git -o openapi.json
+
+# Validate discovery quality
+cli-mcp doctor git
+
+# Generate a configuration template
+cli-mcp init opcua-nodeset-linker -o cli-mcp.yaml
+```
+
+Client configuration (`.mcp.json`, Claude Desktop, Cursor, VS Code, …):
+
+The following is a common client configuration shape; VS Code and other clients may use
+different keys. See [clients.md](docs/clients.md) for client-specific recipes.
+
+```json
+{
+  "mcpServers": {
+    "git": {
+      "command": "cli-mcp",
+      "args": ["serve", "git"]
+    },
+    "docker": {
+      "url": "http://127.0.0.1:8801/mcp"
+    }
+  }
+}
+```
+
+---
+
+## Working directory and Windows shells
+
+Some CLIs resolve paths inside their input configuration relative to the process working
+directory, not relative to that configuration file. Configure an absolute existing directory
+for both discovery and execution:
+
+```yaml
+binary: my-cli
+execution:
+  cwd: 'C:\projects\my-cli'
+```
+
+Without `execution.cwd`, the launch directory is used. Use an absolute manifest path when
+changing the discovery directory. Configuration and tool definitions are loaded at startup:
+restart the server and reconnect the client after changes.
+
+PowerShell:
+
+```powershell
+$env:PYTHONDONTWRITEBYTECODE = '1'
+& 'C:\projects\cli-mcp\.venv\Scripts\python.exe' -B -m cli_mcp.cli.main expose --config 'C:\projects\cli-mcp\cli-mcp.yaml'
+```
+
+cmd.exe (run these as two separate commands):
+
+```bat
+set PYTHONDONTWRITEBYTECODE=1
+"C:\projects\cli-mcp\.venv\Scripts\python.exe" -B -m cli_mcp.cli.main expose --config "C:\projects\cli-mcp\cli-mcp.yaml"
+```
+
+These examples assume an existing development environment at the shown location.
+
+---
+
+## How discovery works
+
+`cli-mcp` tries discovery strategies in order. The first strategy that yields usable commands
+wins; manifest entries then add tools or replace discovered tools with the same name.
+The final include/exclude filters select which tools are published, not which help commands
+may execute.
+
+Import reflection is **disabled by default** and requires `--allow-reflection` or
+`discovery.allow_import_reflection: true`. It may execute target code.
+`discovery.max_depth` limits the recursive walk; `discovery.max_commands` limits both published
+tools and uncached help invocations, including root queries, failures and fallback flags.
+The help budget is checked before spawning processes; cache hits do not consume it.
+
+| Strategy | How it works | Frameworks |
+| --- | --- | --- |
+| **Native reflection** | Inspects the real command objects in the target process | Python: argparse, click, typer · Node.js: commander.js |
+| **Framework help grammars** | Parses framework-specific help output with type/default/required semantics | Go: cobra · Rust: clap · .NET: System.CommandLine · Node.js: yargs · click · argparse |
+| **Generic help parsing** | Recursive `tool --help` / `tool <command> --help` parser | anything with `--help` |
+| **Manifest file** | User-provided YAML metadata, authoritative for matching tool names | supported executables and scripts |
+
+Every discovered command becomes an MCP tool:
+
+```json
+{
+  "name": "reduce",
+  "description": "Reduce an OPC UA nodeset",
+  "inputSchema": {
+    "type": "object",
+    "properties": {
+      "input": { "type": "string", "description": "Input nodeset file" },
+      "output": { "type": "string", "description": "Reduced nodeset file" }
+    },
+    "required": ["input", "output"]
+  }
+}
+```
+
+Calling the tool executes the original CLI:
+
+```bash
+linker reduce --input model.xml --output reduced.xml
+```
+
+and returns:
+
+```json
+{
+  "stdout": "...",
+  "stderr": "",
+  "exitCode": 0,
+  "executionTimeMs": 125,
+  "argv": ["linker", "reduce", "--input", "model.xml", "--output", "reduced.xml"],
+  "sandboxed": false,
+  "truncated": false
+}
+```
+
+The actual `argv` contains the resolved launch command, including interpreter prefixes where
+needed. A connected client or completed MCP call does not prove CLI success: inspect `exitCode`
+and `stderr`. Exitcode 0 does not establish side-effect freedom; `sandboxed: false` means the
+target ran on the host.
+
+---
+
+## Security
+
+Security is a first-class concern, not an afterthought.
+
+```yaml
+binary: opcua-nodeset-linker
+
+security:
+  allowlist: [git, kubectl, docker, opcua-nodeset-linker]
+  readonly: true          # deny unless the complete argv is explicitly listed
+  readonly_argv: []       # configure verified exact invocations before use
+  approval: true          # human confirmation required
+  timeout_seconds: 30
+  max_output_bytes: 200000
+  sandbox:
+    backend: docker
+    image: my-cli-image:latest
+    network: false
+```
+
+- **Allow list** — a non-empty list restricts configured binaries by basename;
+  an empty list permits the configured binary. This is not an OS permission boundary.
+- **Read-only mode** — only explicitly listed complete argv vectors may execute;
+  known risky commands and flags are additionally blocked. An empty `readonly_argv` blocks
+  every execution and triggers a startup warning; publishing tools does not authorize them.
+- **Approval mode** — `auto`/`prompt` require a local human at a terminal; without a TTY
+  approval-required execution is refused. Clients cannot approve their own calls. Legacy
+  `explicit` refuses approval-required calls. Normal stdio clients do not provide a local TTY.
+- **Sandboxing** — run the CLI inside Docker or Podman; the default working-directory
+  mount is writable. Discovery still runs on the host. Firecracker support planned.
+- **Argument validation** — arguments are validated against the generated JSON schema
+  before the requested tool process is spawned. Arguments are not interpolated into
+  a shell string.
+
+Read-only, approval and sandboxing are opt-in. Exact argv permissions do not prove that a
+program, its environment or its input files are harmless. Discovery is outside tool execution
+guards. Output limits bound retained stdout/stderr, not the target's own CPU or memory use.
+HTTP/SSE defaults to loopback and does not configure authentication or TLS; do not expose it
+publicly without appropriate protection.
+
+Windows batch targets (`.bat`/`.cmd`) are rejected. Output is retained within a byte budget,
+including timeouts. See [security.md](docs/security.md) for limitations, configuration migration,
+and non-invasive Windows/Linux tests using a single loopback ping.
+
+---
+
+## Architecture
+
+Clean architecture, one responsibility per package:
+
+```text
+src/cli_mcp/
+├── cli/            # Typer entry point (expose/inspect/serve/export/doctor/init)
+├── discovery/      # provider protocol + strategies
+├── schema/         # JSON Schema, Markdown docs, OpenAPI
+├── executor/       # argv building, subprocess execution, approval, sandbox
+├── mcp/            # MCPServer assembly, tool adapters
+├── security/       # allow list, read-only rules, access policy
+├── config/         # pydantic settings + YAML loading
+├── transport/      # stdio, HTTP, Streamable HTTP, SSE
+└── plugins/        # entry-point based provider discovery
+```
+
+Dependencies point inward: the CLI depends on discovery/schema/executor/security; the MCP
+layer depends on nothing framework-specific. See
+[docs/architecture.md](docs/architecture.md).
+
+---
+
+## Plugin system
+
+Third parties add discovery providers without touching core code:
+
+```python
+from cli_mcp.discovery.base import DiscoveryContext, DiscoveryResult, TargetInfo
+
+
+class MyProvider:
+    name = "my-framework"
+    strategy = "help"
+    frameworks = ("my-framework",)
+
+    def supports(self, target: TargetInfo) -> bool:
+        return target.framework == "my-framework"
+
+    def discover(self, target: TargetInfo, ctx: DiscoveryContext) -> DiscoveryResult | None:
+        ...  # return CommandSpecs
+```
+
+Register it:
+
+```toml
+[project.entry-points."cli_mcp.discovery"]
+my-framework = "my_pkg.provider:MyProvider"
+```
+
+`cli-mcp providers` lists every registered provider.
+
+---
+
+## Development
+
+```bash
+uv run ruff check .
+uv run mypy src
+uv run pytest            # unit + integration + e2e, coverage gate at 90%
+pre-commit run --all-files
+```
+
+The full test suite creates temporary files and runs Git integration commands.
+For non-invasive validation without test caches, coverage files or generated target scripts,
+use the focused Windows/Linux commands in [security.md](docs/security.md).
+
+GitHub Actions run lint, type checking, Windows/Linux tests (Python 3.13/3.14), and
+distribution builds on pushes to `master`/`main` and pull requests. CI can also be started
+manually from the Actions tab. Dependencies are installed from the checked-in lockfile.
+
+Published GitHub releases (or a manual Release workflow run) validate and build distributions,
+then upload wheels and source distributions as workflow artifacts. **PyPI publishing is
+disabled** until a publishing account and trusted publisher are explicitly configured.
+
+---
+
+## Examples
+
+- [`examples/cli-mcp.yaml`](examples/cli-mcp.yaml) — full configuration
+- [`examples/sample-clis/`](examples/sample-clis) — small argparse/click/typer/commander apps used by the tests
+
+## Documentation
+
+- [configuration.md](docs/configuration.md) — every config key and CLI flag
+- [discovery.md](docs/discovery.md) — reflection, help parsing and manifests
+- [security.md](docs/security.md) — allow list, read-only, approval, sandboxing
+- [transports.md](docs/transports.md) — stdio, HTTP, Streamable HTTP, SSE
+- [clients.md](docs/clients.md) — configuration recipes for Claude, VS Code, Cursor, Cline, Open WebUI
+- [plugins.md](docs/plugins.md) — adding a discovery provider for a new framework
+- [architecture.md](docs/architecture.md) — how the pipeline fits together
+
+---
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE).