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

Commit 41bcee5

Browse files
authored
README - added explanation on local development (#23)
* local dev explanation * fix version of docker image
1 parent 6a7a5ef commit 41bcee5

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
@@ -52,7 +52,7 @@ Use our official [Port MCP server](https://pypi.org/project/mcp-server-port/) pa
5252
### Docker Installation
5353
Use our official Docker image:
5454
```bash
55-
docker pull ghcr.io/port-labs/port-mcp-server:0.2.8
55+
docker pull ghcr.io/port-labs/port-mcp-server:0.2.2
5656
```
5757

5858
### Additional configurations
@@ -285,6 +285,7 @@ For manual installation follow these steps:
285285
}
286286
```
287287

288+
288289
# Available Tools
289290

290291
## Blueprint Tools
@@ -406,6 +407,60 @@ For manual installation follow these steps:
406407
- `prompt` (string): The prompt to send to the AI agent
407408
- Returns: Invocation status and message from the AI agent
408409

410+
411+
# Local Development
412+
413+
For developing and testing new functionalities locally before publishing a new version, you can configure your MCP client (e.g., Cursor) to use your local cloned repository.
414+
415+
## Prerequisites
416+
417+
1. **Clone the repository**: If you haven't already, clone the `port-mcp-server` repository to your local machine.
418+
2. **Set up the environment**:
419+
* Navigate to the cloned repository's root directory.
420+
* Run `make install`. This command should set up a virtual environment (venv) and install all necessary dependencies.
421+
* Ensure the virtual environment is created (usually in a `.venv` directory within the repository).
422+
423+
## Configuration Example
424+
425+
Below is an example of how you might configure your local development server. You'll need to replace the placeholder paths with the actual paths on your system.
426+
427+
**Important:**
428+
* The `command` should point to the Python executable within your local repository's virtual environment.
429+
* The `PYTHONPATH` in the `env` object should point to the root directory of your cloned repository.
430+
431+
```json
432+
{
433+
"mcpServers": {
434+
"port_local": {
435+
"command": "/path/to/your/port-mcp-server/.venv/bin/python", // Replace with the actual path to the venv Python
436+
"args": [
437+
"-m",
438+
"src",
439+
"--client-id",
440+
"<YOUR_PORT_CLIENT_ID>",
441+
"--client-secret",
442+
"<YOUR_PORT_CLIENT_SECRET>",
443+
"--region",
444+
"<YOUR_PORT_REGION>", // e.g., EU or US
445+
"--log-level",
446+
"DEBUG" // Or your preferred log level
447+
],
448+
"env": {
449+
"PORT_CLIENT_ID": "<YOUR_PORT_CLIENT_ID>",
450+
"PORT_CLIENT_SECRET": "<YOUR_PORT_CLIENT_SECRET>",
451+
"PORT_REGION": "<YOUR_PORT_REGION>",
452+
"PORT_LOG_LEVEL": "DEBUG",
453+
"PYTHONPATH": "/path/to/your/port-mcp-server" // Replace with the actual path to your repository
454+
}
455+
}
456+
}
457+
}
458+
```
459+
460+
After setting this up, your MCP client will use your local version of the server, allowing you to test changes from your current branch.
461+
462+
463+
409464
# Feedback and Roadmap
410465

411466
We're continuously improving Port MCP and would love to hear from you! Please share your feedback and feature requests on our [roadmap page](https://roadmap.getport.io/ideas).

0 commit comments

Comments
 (0)