Merge pull request #29 from simonbaird/use-quay-image-maybe

Add new shorter "Quick start" method utilizing image from quay.io

Author: simonbaird

.containerignore

@@ -1,4 +1,4 @@
 .env
 .venv
 __pycache__
-*.pyc 
+*.pyc

.editorconfig

@@ -0,0 +1,3 @@
+[*]
+insert_final_newline = true
+trim_trailing_whitespace = true

Containerfile

@@ -11,4 +11,4 @@ RUN pip install --no-cache-dir -r requirements.txt
 COPY . .
 
 # Entrypoint
-CMD ["python", "server.py"] 
+CMD ["python", "server.py"]

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

Makefile

@@ -3,22 +3,30 @@ _default: run
 
 SHELL := /bin/bash
 SCRIPT_DIR := $(patsubst %/,%,$(dir $(abspath $(lastword $(MAKEFILE_LIST)))))
-IMG := localhost/jira-mcp:latest
 ENV_FILE := $(HOME)/.rh-jira-mcp.env
 EXAMPLE_MCP := example.mcp.json
 
-.PHONY: build run clean test cursor-config setup
+# TODO: Find a better home for this
+PUBLIC_IMG := quay.io/sbaird/jira-mcp
+LOCAL_IMG := localhost/jira-mcp:latest
+
+IMG := $(LOCAL_IMG)
 
+# To use the pre-built main branch image from https://quay.io/repository/sbaird/jira-mcp?tab=tags
+# instead of your locally built image, uncomment this and re-run `make cursor-config`.
+#IMG := $(PUBLIC_IMG)
+
+.PHONY: build
 build:
 	@echo "🛠️ Building image"
-	podman build -t $(IMG) .
+	podman build -t $(LOCAL_IMG) .
 
-# TODO: Find a better home for this
-PUBLIC_IMG := quay.io/sbaird/jira-mcp
+# This requires a push credential for quay.io/sbaird/jira-mcp
+.PHONY: push
 push:
 	@echo "🛠️ Pushing to $(PUBLIC_IMG)"
 	@for tag in latest git-$(shell git rev-parse --short HEAD); do \
-	  podman tag $(IMG) $(PUBLIC_IMG):$$tag; \
+	  podman tag $(LOCAL_IMG) $(PUBLIC_IMG):$$tag; \
 	  podman push $(PUBLIC_IMG):$$tag; \
 	done
 
@@ -27,9 +35,11 @@ push:
 # - The --tty option is used here since we might run this in a
 #   terminal, but for the mcp.json version we don't use --tty.
 # - You can use Ctrl-D to quit nicely.
+.PHONY: run
 run:
 	@podman run -i --tty --rm --env-file $(ENV_FILE) $(IMG)
 
+.PHONY: clean
 clean:
 	podman rmi -i $(IMG)
 
@@ -43,6 +53,7 @@ IMG_ARG_IDX = $(shell yq '.mcpServers.jiraMcp.args|length - 1' $(EXAMPLE_MCP))
 # configure Cursor by adding or updating an entry in the ~/.cursor/mcp.json
 # file. Beware it might overwrite your customizations.
 MCP_JSON=$(HOME)/.cursor/mcp.json
+.PHONY: cursor-config
 cursor-config:
 	@echo "🛠️ Modifying $(MCP_JSON)"
 	@#
@@ -63,4 +74,30 @@ $(ENV_FILE):
 	@cp example.env $@
 	@echo "🛠️ Env file created. Edit $@ to add your Jira token"
 
+.PHONY: setup
 setup: build cursor-config $(ENV_FILE)
+
+VENV=.venv
+$(VENV):
+	@# black is not in requirements.txt since we don't want it in the image
+	@python -mvenv $@ && \
+	  source $@/bin/activate && \
+	  pip install --upgrade pip && \
+	  pip install -r requirements.txt && \
+	  pip install black
+	@echo "Now do this:"
+	@echo "  source $@/bin/activate"
+
+.PHONY: venv-setup
+venv-setup: $(VENV)
+
+.PHONY: fmt
+fmt:
+	@black *.py
+
+.PHONY: fmt-check
+fmt-check:
+	@black --check *.py
+
+.PHONY: ci
+ci: fmt-check

README.md

@@ -11,13 +11,43 @@ A containerized Python MCP server for Cursor to provide access to Jira.
 See also [redhat-ai-tools/jira-mcp-snowflake](https://github.com/redhat-ai-tools/jira-mcp-snowflake)
 which provides another way to access Red Hat Jira data.
 
-## Prerequisites
+## Quick Start
+
+1. **Prepare a Jira token**
+   * Go to [Red Hat Jira Personal Access Tokens](https://issues.redhat.com/secure/ViewProfile.jspa?selectedTab=com.atlassian.pats.pats-plugin:jira-user-personal-access-tokens) and create a token
+   * Create a .env file similar to [example.env](example.env)
 
-- **podman** - Install with `sudo dnf install podman` (Fedora/RHEL) or `brew install podman` (macOS)
-- **make** - Usually pre-installed on most systems
-- **yq** - Install with `brew install yq` (macOS)
+2. **Configure Cursor**
+   * In Cursor go to "Settings", "Tools & Integrations", and click "New MCP Server"
+   * Paste in the following JSON, (or insert just the `jiraMcp` object under the `mcpServers` key).
+   * Update `"/path/to/your/dotenv/file.env"` to point to the file from step 1.
+   * Save
 
-## Quick Start
+```
+{
+  "mcpServers": {
+    "jiraMcp": {
+      "command": "podman",
+      "args": [
+        "run",
+        "-i",
+        "--rm",
+        "--env-file",
+        "/path/to/your/dotenv/file.env",
+        "quay.io/sbaird/jira-mcp:latest"
+      ],
+      "description": "A containerized MCP server to query Jira issues"
+    }
+  }
+}
+```
+
+## Quick Start (for developers)
+
+0. **Prerequisites**
+    - **podman** - Install with `sudo dnf install podman` (Fedora/RHEL) or `brew install podman` (macOS)
+    - **yq** - Install with `sudo dnf install yq` (Fedora/RHEL) or `brew install yq` (macOS)
+    - **make** - Usually pre-installed on most systems
 
 1. **Get the code**
   ```bash
@@ -42,7 +72,7 @@ If you want to turn it on, edit the `.rh-jira-mcp.env` file in your home directo
 
 5. **Check if it is working in Cursor**
 
-To confirm it's working, run Cursor, go to Settings and click on "Tools & Integrations". Under MCP Tools you should see "jiraMcp" with 20 tools enabled if 
+To confirm it's working, run Cursor, go to Settings and click on "Tools & Integrations". Under MCP Tools you should see "jiraMcp" with 20 tools enabled if
 `JIRA_ENABLE_WRITE=false` (the default value) or 30 tools enabled if `JIRA_ENABLE_WRITE=true`.
 
 ## Using with an HTTP-based MCP application

pyproject.toml

@@ -0,0 +1,2 @@
+[tool.black]
+line-length = 100