Skip to content
This repository was archived by the owner on Feb 24, 2026. It is now read-only.

Commit 3d9737b

Browse files
CopilotMatanga1-2
andauthored
Add comprehensive UVX installation guide with step-by-step instructions (#47)
* Initial plan for issue * Add comprehensive UVX installation guide with step-by-step instructions Co-authored-by: Matanga1-2 <24847398+Matanga1-2@users.noreply.github.com> * Update README.md --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Matanga1-2 <24847398+Matanga1-2@users.noreply.github.com> Co-authored-by: Matanga1-2 <matangrady@gmail.com>
1 parent 9861821 commit 3d9737b

File tree

1 file changed

+56
-1
lines changed

1 file changed

+56
-1
lines changed

README.md

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,60 @@ Port MCP Server can be installed using two methods:
5757

5858
### Package Installation (uvx)
5959

60-
Use our official [Port MCP server](https://pypi.org/project/mcp-server-port/) package.
60+
Use our official [Port MCP server](https://pypi.org/project/mcp-server-port/) package with uvx for easy installation and management.
61+
62+
#### Step-by-Step Installation Guide
63+
64+
1. **Create a Python Virtual Environment** (Recommended)
65+
```bash
66+
python -m venv venv
67+
```
68+
69+
2. **Activate the Virtual Environment**
70+
```bash
71+
# On Linux/macOS:
72+
source venv/bin/activate
73+
74+
# On Windows:
75+
venv\Scripts\activate
76+
```
77+
78+
3. **Install the UV Package Manager**
79+
```bash
80+
# Using Homebrew (macOS/Linux):
81+
brew install uv
82+
83+
# Or using pip:
84+
pip install uv
85+
```
86+
87+
4. **Verify UV Installation**
88+
```bash
89+
which uv
90+
```
91+
92+
5. **Set Required Environment Variables**
93+
```bash
94+
export PORT_CLIENT_ID="your_port_client_id"
95+
export PORT_CLIENT_SECRET="your_port_client_secret"
96+
export PORT_REGION="EU" # or "US"
97+
```
98+
99+
6. **Set Python Path** (if using virtual environment)
100+
```bash
101+
export PYTHONPATH="/path/to/your/venv/bin/python"
102+
```
103+
104+
7. **Run the MCP Server**
105+
```bash
106+
uvx mcp-server-port --client-id your_port_client_id --client-secret your_port_client_secret --region EU --log-level DEBUG
107+
```
108+
109+
8. **Verify Server is Running**
110+
You should start seeing logs from the server. You can also check the log file:
111+
```bash
112+
cat /tmp/port-mcp.log
113+
```
61114

62115
### Docker Installation
63116

@@ -67,6 +120,8 @@ Use our official Docker image:
67120
docker pull ghcr.io/port-labs/port-mcp-server:latest
68121
```
69122

123+
See below for detailed instructions on each MCP client.
124+
70125
### Additional configurations
71126

72127
You can pass these additional arguments for more advanced configuration:

0 commit comments

Comments
 (0)