Skip to content

Commit f4e349c

Browse files
authored
Merge pull request #58 from IBM/update-project-name-pypi
Updated pypi project name to avoid conflicts
2 parents fc82929 + c320bad commit f4e349c

File tree

3 files changed

+35
-3
lines changed

3 files changed

+35
-3
lines changed

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -799,6 +799,10 @@ publish: verify ## Verify, then upload to PyPI
799799
twine upload dist/* # creds via env vars or ~/.pypirc
800800
@echo "🚀 Upload finished – check https://pypi.org/project/$(PROJECT_NAME)/"
801801

802+
publish-testpypi: verify ## Verify, then upload to TestPyPI
803+
twine upload --repository testpypi dist/* # creds via env vars or ~/.pypirc
804+
@echo "🚀 Upload finished – check https://pypi.org/project/$(PROJECT_NAME)/"
805+
802806
# =============================================================================
803807
# 🦭 PODMAN CONTAINER BUILD & RUN
804808
# =============================================================================

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,28 @@ MCP Gateway builds on the MCP spec by sitting **in front of** MCP Server or REST
5050

5151
---
5252

53+
## Quick Start: PyPi
54+
55+
MCP Gateway is [published on PyPi](https://pypi.org/project/mcp-contextforge-gateway) as `mcp-contextforge-gateway`. You can install and start a server with:
56+
57+
```bash
58+
# Create a virtual environment and activate it
59+
python3 -m venv .venv
60+
. ./.venv/bin/activate
61+
62+
# Install mcp-contextforge-gateway
63+
pip install mcp-contextforge-gateway
64+
65+
# Run mcpgateway with default options, listening on port 4444
66+
mcpgateway
67+
68+
# Optional: configure env, and login with admin:password at http://127.0.0.1:9999/admin
69+
BASIC_AUTH_PASSWORD=password mcpgateway --host 127.0.0.1 --port 9999
70+
71+
# List all options
72+
mcpgateway --help
73+
```
74+
5375
## Quick Start (Pre-built Image)
5476

5577
If you just want to run the gateway using the official image from GitHub Container Registry:

pyproject.toml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,13 @@ build-backend = "setuptools.build_meta"
1111
# 📦 Core project metadata (PEP 621)
1212
# ----------------------------------------------------------------
1313
[project]
14-
name = "mcpgateway"
14+
name = "mcp-contextforge-gateway"
1515
version = "0.1.0"
16-
description = "A production-ready MCP Gateway built with FastAPI and support for virtual servers"
17-
keywords = ["MCP", "Gateway", "API", "Agents", "Tools"]
16+
description = "A production-grade MCP Gateway & Proxy built with FastAPI. Supports multi-server registration, virtual server composition, authentication, retry logic, observability, protocol translation, and a unified federated tool catalog."
17+
keywords = ["MCP","API","gateway","proxy","tools",
18+
"agents","agentic ai","model context protocol","multi-agent","fastapi",
19+
"json-rpc","sse","websocket","federation","security","authentication"
20+
]
1821
classifiers = [
1922
"Development Status :: 4 - Beta",
2023
"Intended Audience :: Developers",
@@ -23,6 +26,9 @@ classifiers = [
2326
"Programming Language :: Python :: 3.11",
2427
"Programming Language :: Python :: 3.12",
2528
"Framework :: FastAPI",
29+
"Framework :: AsyncIO",
30+
"Topic :: Internet :: WWW/HTTP :: WSGI :: Application",
31+
"Topic :: Software Development :: Libraries :: Application Frameworks"
2632
]
2733
readme = "README.md"
2834
requires-python = ">=3.10,<3.13"

0 commit comments

Comments
 (0)