Skip to content

Add uvx support for one-line execution#9

Open
ztripez wants to merge 1 commit intocanvrno:mainfrom
ztripez:feature/uvx
Open

Add uvx support for one-line execution#9
ztripez wants to merge 1 commit intocanvrno:mainfrom
ztripez:feature/uvx

Conversation

@ztripez
Copy link

@ztripez ztripez commented Jun 30, 2025

Summary

  • Add uvx support enabling one-line execution: uvx proxmox-mcp
  • Update README with uvx as primary installation method
  • Improve error messaging with helpful setup instructions

Changes

  • Add main() function: Proper entry point for uvx/pip script execution
  • Enhanced documentation: uvx quick start instructions as the recommended method
  • Better error handling: Clear setup guidance when configuration is missing
  • Backward compatibility: Maintains existing direct script execution support
  • Bug fix: Correct config template path reference in README

Usage

After this change, users can run the server with:

export PROXMOX_MCP_CONFIG="/path/to/config.json"
uvx proxmox-mcp

Test plan

  • Verify Python syntax is valid
  • Confirm entry point configuration in pyproject.toml is correct
  • Test backward compatibility with direct execution
  • Validate improved error messages guide users properly

The pyproject.toml already had the correct [project.scripts] configuration, so no changes were needed there.

- Add main() function as proper entry point for uvx/pip execution
- Update README with uvx quick start instructions as primary method
- Improve error messaging with helpful setup instructions
- Maintain backward compatibility with direct script execution
- Fix config template path reference in README

Users can now run: uvx proxmox-mcp (after setting PROXMOX_MCP_CONFIG)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant