From a333aceb9e2bc4615207e581ba27ad323dd2a2c7 Mon Sep 17 00:00:00 2001 From: DevRev Date: Wed, 25 Jun 2025 17:58:18 +0530 Subject: [PATCH] updated readme to inlude uv/uvx installation details --- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/README.md b/README.md index 5154fbc..ef1c130 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,58 @@ A Model Context Protocol server for DevRev. This server provides comprehensive a - **`update_part`**: Update existing parts by modifying properties such as name, description, assignees, or target dates. - **`list_parts`**: List and filter parts based on various criteria like dates, assignees, parent parts, and more. +## Prerequisites + +Before using this MCP server, you need to install either `uvx` or `uv`, which are modern Python package and project management tools. + +### Installing uv (Recommended) + +`uv` is a fast Python package installer and resolver. It includes `uvx` for running Python applications. + +#### On macOS and Linux: +```bash +curl -LsSf https://astral.sh/uv/install.sh | sh +``` + +#### On Windows: +```powershell +powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" +``` + +#### Alternative Installation Methods: + +**Using Homebrew (macOS):** +```bash +brew install uv +``` + +**Using pip:** +```bash +pip install uv +``` + +### Verifying Installation + +After installation, verify that `uv` and `uvx` are available: + +```bash +# Check uv version +uv --version + +# Check uvx version +uvx --version +``` + +Both commands should return version information. If you get "command not found" errors, you may need to restart your terminal or add the installation directory to your PATH. + +### Troubleshooting + +If you encounter issues: +1. Restart your terminal after installation +2. Check that the installation directory is in your PATH +3. On macOS/Linux, the default installation adds uv to `~/.cargo/bin/` +4. Refer to the [official uv documentation](https://docs.astral.sh/uv/) for more detailed installation instructions + ## Configuration ### Get the DevRev API Key