Merge pull request #91 from IBM/migrate-wrapper

Migrate wrapper to mcpgateway.wrapper

Author: crivetimihai

.dockerignore

@@ -1,3 +1,4 @@
+.devcontainer
 .github
 docker-compose.yml
 podman-compose-sonarqube.yaml

.github/CODEOWNERS

@@ -1,8 +1,5 @@
 # All files in the repo
 * @crivetimihai
 
-# Ownership for the mcpgateway-wrapper
-/mcpgateway-wrapper/ @crivetimihai @kevalmahajan @madhav165
-
 # Ownership for all tests
 /tests/ @crivetimihai @kevalmahajan @madhav165

.github/ISSUE_TEMPLATE/bug-report-code.md

@@ -17,7 +17,7 @@ Select the area of the project impacted:
 
 - [ ] `mcpgateway` - API
 - [ ] `mcpgateway` - UI (admin panel)
-- [ ] `mcpgateway-wrapper` - stdio wrapper
+- [ ] `mcpgateway.wrapper` - stdio wrapper
 - [ ] Federation or Transports
 - [ ] CLI, Makefiles, or shell scripts
 - [ ] Container setup (Docker/Podman/Compose)

.github/workflows/python-package.yml

@@ -32,8 +32,8 @@ jobs:
       # 3️⃣  Install build front-end; Keep pip current
       - name: Install build tool
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install build   # PyPA-endorsed PEP 517 builder
+          python3 -m pip install --upgrade pip
+          python3 -m pip install build   # PyPA-endorsed PEP 517 builder
 
       # 4️⃣  Invoke the Makefile 'dist' target (creates ./dist/*.whl & *.tar.gz)
       - name: Build distributions

.pre-commit-config.yaml

@@ -89,7 +89,7 @@ repos:
       - id: forbid-ai-stock-phrases
         name: ❌ Forbid AI Stock Phrases
         description: Prevents common AI-generated phrases from being committed.
-        entry: '(?i)(source=chatgpt.com|turn0search0|filecite|as an ai language model|i am an ai developed by|this response was generated by|i don''t have real-time information|i don''t have access to real-time|i can''t browse the internet|i cannot browse the internet|my knowledge cutoff|my training data|i''m not able to access|i don''t have the ability to)'
+        entry: '(?i)(source=chatgpt.com|turn0search0|filecite|unchanged|as an ai language model|i am an ai developed by|this response was generated by|i don''t have real-time information|i don''t have access to real-time|i can''t browse the internet|i cannot browse the internet|my knowledge cutoff|my training data|i''m not able to access|i don''t have the ability to)'
         language: pygrep
         types: [text]
         exclude: ^\.pre-commit-config\.yaml$

CHANGELOG.md

@@ -6,7 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
 
 ---
 
-## [0.2.0] - 2025-06-08 (pending)
+## [0.2.0] - 2025-06-15 (pending)
+
+### Added
+
+* Moved mcpgateway-wrapper to mcpgateway/wrapper.py so it can run as a Python module (python3 -m mcpgateway.wrapper)
+* Integrated version into UI. API and separate /version endpoint also available.
+* Added /ready endpoint
 
 ### Fixed
 

DEVELOPING.md

@@ -1,28 +1,58 @@
-## Development Testing with MCP Inspector
+# Development Quick-Start
 
-```
+## 🧪 Development Testing with **MCP Inspector**
+
+```bash
+# Gateway & auth
 export MCP_GATEWAY_BASE_URL=http://localhost:4444
 export MCP_SERVER_CATALOG_URLS=http://localhost:4444/servers/1
-export MCP_AUTH_TOKEN="your_bearer_token"
+export MCP_AUTH_TOKEN="<your_bearer_token>"
+```
 
+| Mode                                                        | Command                                                                      | Notes                                                                         |
+| ----------------------------------------------------------- | ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
+| **SSE (direct)**                                            | `npx @modelcontextprotocol/inspector`                                        | Connects straight to the Gateway's SSE endpoint.                              |
+| **Stdio wrapper** <br/>*(for clients that can't speak SSE)* | `npx @modelcontextprotocol/inspector python -m mcpgateway.wrapper`           | Spins up the wrapper **in-process** and points Inspector to its stdio stream. |
+| **Stdio wrapper via uv / uvenv**                            | `npx @modelcontextprotocol/inspector uvenv run python -m mcpgateway.wrapper` | Uses the lightning-fast `uv` virtual-env if installed.                        |
 
-npx @modelcontextprotocol/inspector # SSE
-npx @modelcontextprotocol/inspector uv --directory "/home/cmihai/mcpgateway-wrapper" run mcpgateway-wrapper # wrapper
-```
+🔍 MCP Inspector boots at **[http://localhost:5173](http://localhost:5173)** – open it in a browser and add:
 
-🔍 MCP Inspector is up and running at http://localhost:5173 🚀
+```text
+Server URL: http://localhost:4444/servers/1/sse
+Headers:    Authorization: Bearer <your_bearer_token>
+```
 
+---
 
-## SuperGateway
+## 🌉 SuperGateway (stdio-in ⇢ SSE-out bridge)
 
-Supergateway runs a MCP stdio-based servers over SSE (Server-Sent Events) with one command. This is useful for remote access, debugging, or connecting to SSE-based clients when your MCP server only speaks stdio.
+SuperGateway lets you expose *any* MCP **stdio** server over **SSE** with a single command – perfect for
+remote debugging or for clients that only understand SSE.
 
-`npx -y supergateway --stdio "uvx run mcp-server-git"``
-or
-```
+```bash
+# Using uvx (ships with uv)
+npx -y supergateway --stdio "uvx run mcp-server-git"
+# OR: using uvenv (pip-based)
 pip install uvenv
 npx -y supergateway --stdio "uvenv run mcp-server-git"
 ```
 
-SSE endpoint: GET http://localhost:8000/sse
-POST messages: POST http://localhost:8000/message
+| Endpoint                 | Method | URL                                                            |
+| ------------------------ | ------ | -------------------------------------------------------------- |
+| **SSE stream**           | `GET`  | [http://localhost:8000/sse](http://localhost:8000/sse)         |
+| **Message back-channel** | `POST` | [http://localhost:8000/message](http://localhost:8000/message) |
+
+Combine this with the Gateway:
+
+```bash
+# Register the SuperGateway SSE endpoint as a peer
+curl -X POST -H "Authorization: Bearer $MCPGATEWAY_BEARER_TOKEN" \
+     -H "Content-Type: application/json" \
+     -d '{"name":"local-supergateway","url":"http://localhost:8000/sse"}' \
+     http://localhost:4444/gateways
+```
+
+The tools hosted by **`mcp-server-git`** are now available in the Gateway catalog, and therefore
+also visible through `mcpgateway.wrapper` or any other MCP client.
+
+```

MANIFEST.in

@@ -9,6 +9,7 @@ include pyproject.toml
 include gunicorn.config.py
 include Containerfile
 include Containerfile.lite
+include __init__
 
 # 2️⃣  Top-level config, examples and helper scripts
 include *.py
@@ -32,12 +33,16 @@ include .pycodestyle
 include .pylintrc
 include .whitesource
 include .coveragerc
-#include .gitignore            # purely optional but many projects ship it
+# include .gitignore            # purely optional but many projects ship it
+include .bumpversion.cfg
+include .yamllint
+include .editorconfig
 
 # 4️⃣  Runtime data that lives *inside* the package at import time
 recursive-include mcpgateway/templates *.html
 recursive-include mcpgateway/static *.css *.js *.gif *.png *.svg
 recursive-include mcpgateway *.pyi py.typed
+recursive-include mcpgateway *.ico
 
 # 5️⃣  (Optional) include MKDocs-based docs in the sdist
 graft docs
@@ -48,3 +53,6 @@ prune build
 prune dist
 prune .eggs
 prune *.egg-info
+prune charts
+prune k8s
+prune .devcontainer

Makefile

@@ -162,12 +162,12 @@ certs:                           ## Generate ./certs/cert.pem & ./certs/key.pem
 test:
 	@echo "🧪 Running tests..."
 	@test -d "$(VENV_DIR)" || make venv
-	@/bin/bash -c "source $(VENV_DIR)/bin/activate && python -m pip install pytest pytest-asyncio pytest-cov -q && python -m pytest --maxfail=0 --disable-warnings -v"
+	@/bin/bash -c "source $(VENV_DIR)/bin/activate && python3 -m pip install pytest pytest-asyncio pytest-cov -q && python3 -m pytest --maxfail=0 --disable-warnings -v"
 
 pytest-examples:
 	@echo "🧪 Testing README examples..."
 	@test -d "$(VENV_DIR)" || make venv
-	@/bin/bash -c "source $(VENV_DIR)/bin/activate && python -m pip install pytest pytest-examples -q && pytest -v test_readme.py"
+	@/bin/bash -c "source $(VENV_DIR)/bin/activate && python3 -m pip install pytest pytest-examples -q && pytest -v test_readme.py"
 
 test-curl:
 	./test_endpoints.sh
@@ -342,10 +342,10 @@ lint:
 ## --------------------------------------------------------------------------- ##
 autoflake:                          ## 🧹  Strip unused imports / vars
 	@$(VENV_DIR)/bin/autoflake --in-place --remove-all-unused-imports \
-	          --remove-unused-variables -r mcpgateway mcpgateway-wrapper tests
+	          --remove-unused-variables -r mcpgateway tests
 
 black:                              ## 🎨  Reformat code with black
-	@echo "🎨  black …" && $(VENV_DIR)/bin/black -l 200 mcpgateway mcpgateway-wrapper tests
+	@echo "🎨  black …" && $(VENV_DIR)/bin/black -l 200 mcpgateway tests
 
 isort:                              ## 🔀  Sort imports
 	@echo "🔀  isort …" && $(VENV_DIR)/bin/isort .
@@ -375,19 +375,19 @@ pre-commit:                         ## 🪄  Run pre-commit hooks
 	@$(VENV_DIR)/bin/pre-commit run --all-files --show-diff-on-failure
 
 ruff:                               ## ⚡  Ruff lint + format
-	@$(VENV_DIR)/bin/ruff check mcpgateway && $(VENV_DIR)/bin/ruff format mcpgateway mcpgateway-wrapper tests
+	@$(VENV_DIR)/bin/ruff check mcpgateway && $(VENV_DIR)/bin/ruff format mcpgateway tests
 
 ty:                                 ## ⚡  Ty type checker
-	@$(VENV_DIR)/bin/ty check mcpgateway mcpgateway-wrapper tests
+	@$(VENV_DIR)/bin/ty check mcpgateway tests
 
 pyright:                            ## 🏷️  Pyright type-checking
-	@$(VENV_DIR)/bin/pyright mcpgateway mcpgateway-wrapper tests
+	@$(VENV_DIR)/bin/pyright mcpgateway tests
 
 radon:                              ## 📈  Complexity / MI metrics
-	@$(VENV_DIR)/bin/radon mi -s mcpgateway mcpgateway-wrapper tests && \
-	$(VENV_DIR)/bin/radon cc -s mcpgateway mcpgateway-wrapper tests && \
-	$(VENV_DIR)/bin/radon hal mcpgateway mcpgateway-wrapper tests && \
-	$(VENV_DIR)/bin/radon raw -s mcpgateway mcpgateway-wrapper tests
+	@$(VENV_DIR)/bin/radon mi -s mcpgateway tests && \
+	$(VENV_DIR)/bin/radon cc -s mcpgateway tests && \
+	$(VENV_DIR)/bin/radon hal mcpgateway tests && \
+	$(VENV_DIR)/bin/radon raw -s mcpgateway tests
 
 pyroma:                             ## 📦  Packaging metadata check
 	@$(VENV_DIR)/bin/pyroma -d .
@@ -414,10 +414,10 @@ depend:                             ## 📦  List dependencies
 	pdm list --freeze
 
 snakeviz:                           ## 🐍  Interactive profile visualiser
-	@python -m cProfile -o mcp.prof app/server.py && snakeviz mcp.prof --server
+	@python3 -m cProfile -o mcp.prof app/server.py && snakeviz mcp.prof --server
 
 pstats:                             ## 📊  Static call-graph image
-	@python -m cProfile -o mcp.pstats app/server.py && \
+	@python3 -m cProfile -o mcp.pstats app/server.py && \
 	 gprof2dot -w -e 3 -n 3 -s -f pstats mcp.pstats | \
 	 dot -Tpng -o $(DOCS_DIR)/pstats.png
 
@@ -429,22 +429,22 @@ tox:                                ## 🧪  Multi-Python tox matrix
 	uv pip install tox-travis tox-pdm
 	pdm add -G dev
 	pdm python install 3.11 3.12
-	python -m tox -p 2
+	python3 -m tox -p 2
 
 sbom:								## 🛡️  Generate SBOM & security report
 	@echo "🛡️   Generating SBOM & security report…"
 	@rm -Rf "$(VENV_DIR).sbom"
 	@python3 -m venv "$(VENV_DIR).sbom"
 	@/bin/bash -c "source $(VENV_DIR).sbom/bin/activate && python3 -m pip install --upgrade pip setuptools pdm uv && python3 -m uv pip install .[dev]"
 	@/bin/bash -c "source $(VENV_DIR)/bin/activate && python3 -m uv pip install cyclonedx-bom sbom2doc"
-	@/bin/bash -c "source $(VENV_DIR)/bin/activate && python -m cyclonedx_py environment --validate '$(VENV_DIR).sbom' --pyproject pyproject.toml --gather-license-texts > $(PROJECT_NAME).sbom.json"
+	@/bin/bash -c "source $(VENV_DIR)/bin/activate && python3 -m cyclonedx_py environment --validate '$(VENV_DIR).sbom' --pyproject pyproject.toml --gather-license-texts > $(PROJECT_NAME).sbom.json"
 	@/bin/bash -c "source $(VENV_DIR)/bin/activate && sbom2doc -i $(PROJECT_NAME).sbom.json -f markdown -o $(DOCS_DIR)/docs/test/sbom.md"
 	@trivy sbom $(PROJECT_NAME).sbom.json | tee -a $(DOCS_DIR)/docs/test/sbom.md
 	@/bin/bash -c "source $(VENV_DIR).sbom/bin/activate && python3 -m pdm outdated | tee -a $(DOCS_DIR)/docs/test/sbom.md"
 
 pytype:								## 🧠  Pytype static type analysis
 	@echo "🧠  Pytype analysis…"
-	@$(VENV_DIR)/bin/pytype -V 3.12 -j auto mcpgateway mcpgateway-wrapper tests
+	@$(VENV_DIR)/bin/pytype -V 3.12 -j auto mcpgateway tests
 
 check-manifest:						## 📦  Verify MANIFEST.in completeness
 	@echo "📦  Verifying MANIFEST.in completeness…"
@@ -641,7 +641,7 @@ pysonar-scanner:
 	@echo "🐍 Scanning code with pysonar-scanner (PyPI) …"
 	@test -f $(SONAR_PROPS) || { echo "❌ $(SONAR_PROPS) not found."; exit 1; }
 	python3 -m pip install --upgrade --quiet pysonar-scanner
-	python -m pysonar_scanner \
+	python3 -m pysonar_scanner \
 		-Dproject.settings=$(SONAR_PROPS) \
 		-Dsonar.host.url=$(SONAR_HOST_URL) \
 		$(if $(SONAR_TOKEN),-Dsonar.login=$(SONAR_TOKEN),)
@@ -739,7 +739,7 @@ pip-audit:
 	@echo "🔒  pip-audit vulnerability scan…"
 	@test -d "$(VENV_DIR)" || $(MAKE) venv
 	@/bin/bash -c "source $(VENV_DIR)/bin/activate && \
-		python -m pip install --quiet --upgrade pip-audit && \
+		python3 -m pip install --quiet --upgrade pip-audit && \
 		pip-audit --progress-spinner ascii --strict || true"
 
 # =============================================================================
@@ -777,15 +777,15 @@ containerfile-update:
 .PHONY: dist wheel sdist verify publish
 
 dist: clean                ## Build wheel + sdist
-	python -m build
+	python3 -m build
 	@echo "🛠  Wheel & sdist written to ./dist"
 
 wheel:                     ## Build wheel only
-	python -m build -w
+	python3 -m build -w
 	@echo "🛠  Wheel written to ./dist"
 
 sdist:                     ## Build source distribution only
-	python -m build -s
+	python3 -m build -s
 	@echo "🛠  Source distribution written to ./dist"
 
 verify: dist               ## Build, run metadata & manifest checks
@@ -1897,7 +1897,7 @@ shell-linters-install:     ## 🔧  Install shellcheck, shfmt, bashate
 	if ! $(VENV_DIR)/bin/bashate -h >/dev/null 2>&1 ; then \
 	  echo "🛠  Installing bashate (into venv)…" ; \
 	  test -d "$(VENV_DIR)" || $(MAKE) venv ; \
-	  /bin/bash -c "source $(VENV_DIR)/bin/activate && python -m pip install --quiet bashate" ; \
+	  /bin/bash -c "source $(VENV_DIR)/bin/activate && python3 -m pip install --quiet bashate" ; \
 	fi
 	@echo "✅  Shell linters ready."