Skip to content

Commit ed3ff19

Browse files
floatingIce91DevRev
andauthored
updated readme to inlude uv/uvx installation details (#25)
This PR updates the readme to include installation guide for uv/uvx commands, which is a dependency for running this project https://app.devrev.ai/devrev/works/ISS-175688 Co-authored-by: DevRev <[email protected]>
1 parent 160ec2e commit ed3ff19

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,58 @@ A Model Context Protocol server for DevRev. This server provides comprehensive a
2222
- **`update_part`**: Update existing parts by modifying properties such as name, description, assignees, or target dates.
2323
- **`list_parts`**: List and filter parts based on various criteria like dates, assignees, parent parts, and more.
2424

25+
## Prerequisites
26+
27+
Before using this MCP server, you need to install either `uvx` or `uv`, which are modern Python package and project management tools.
28+
29+
### Installing uv (Recommended)
30+
31+
`uv` is a fast Python package installer and resolver. It includes `uvx` for running Python applications.
32+
33+
#### On macOS and Linux:
34+
```bash
35+
curl -LsSf https://astral.sh/uv/install.sh | sh
36+
```
37+
38+
#### On Windows:
39+
```powershell
40+
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
41+
```
42+
43+
#### Alternative Installation Methods:
44+
45+
**Using Homebrew (macOS):**
46+
```bash
47+
brew install uv
48+
```
49+
50+
**Using pip:**
51+
```bash
52+
pip install uv
53+
```
54+
55+
### Verifying Installation
56+
57+
After installation, verify that `uv` and `uvx` are available:
58+
59+
```bash
60+
# Check uv version
61+
uv --version
62+
63+
# Check uvx version
64+
uvx --version
65+
```
66+
67+
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.
68+
69+
### Troubleshooting
70+
71+
If you encounter issues:
72+
1. Restart your terminal after installation
73+
2. Check that the installation directory is in your PATH
74+
3. On macOS/Linux, the default installation adds uv to `~/.cargo/bin/`
75+
4. Refer to the [official uv documentation](https://docs.astral.sh/uv/) for more detailed installation instructions
76+
2577
## Configuration
2678

2779
### Get the DevRev API Key

0 commit comments

Comments
 (0)