Skip to content

Commit c84b639

Browse files
committed
update README
1 parent 34d7615 commit c84b639

File tree

2 files changed

+22
-8
lines changed

2 files changed

+22
-8
lines changed

Makefile

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
.PHONY: setup run dev install deploy test clean format type-check
1+
.PHONY: setup run dev install test
22

33
# Set the Python version from cookiecutter or default to 3.12
44
PYTHON_VERSION := 3.12
5+
TRANSPORT_MODE ?= "stdio"
56

67
# Setup with uv
78
setup:
@@ -15,7 +16,7 @@ setup:
1516

1617
# Run the server directly
1718
run:
18-
uv run src/alertmanager_mcp_server/server.py
19+
uv run src/alertmanager_mcp_server/server.py --transport ${TRANSPORT_MODE}
1920

2021
# Run in development mode with MCP inspector
2122
dev:
@@ -32,3 +33,11 @@ docker-build:
3233
# Run with Docker
3334
docker-run:
3435
docker run -p 8000:8000 kiennt26/alertmanager_mcp_server:latest
36+
37+
# Clean up build artifacts
38+
clean:
39+
rm -rf build/
40+
rm -rf dist/
41+
rm -rf *.egg-info/
42+
find . -type d -name __pycache__ -exec rm -rf {} +
43+
find . -type f -name "*.pyc" -delete

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
- [2. Features](#2-features)
1616
- [3. Quickstart](#3-quickstart)
1717
- [3.1. Prerequisites](#31-prerequisites)
18+
- [Installing via Smithery](#installing-via-smithery)
1819
- [3.2. Local Run](#32-local-run)
1920
- [3.3. Docker Run](#33-docker-run)
2021
- [4. Tools](#4-tools)
@@ -163,12 +164,16 @@ This project uses [uv](https://github.com/astral-sh/uv) to manage dependencies.
163164
```bash
164165
# Clone the repository
165166
$ git clone https://github.com/ntk148v/alertmanager-mcp-server.git
166-
$ uv venv
167-
$ source .venv/bin/activate # On Unix/macOS
168-
$ .venv\Scripts\activate # On Windows
169-
$ uv pip install -e .
170-
# run test
171-
$ pytest
167+
$ cd alertmanager-mcp-server
168+
$ make setup
169+
# Run test
170+
$ make test
171+
# Run in development mode
172+
$ mcp dev
173+
$ TRANSPORT_MODE=sse mcp dev
174+
175+
# Install in Claude Desktop
176+
$ make install
172177
```
173178

174179
## 6. License

0 commit comments

Comments
 (0)