Merge pull request #2 from liatrio/fix-workflow-issues

fix: fixed invalid routes, removed docker compose, and some README up…

Author: jburns24

.env.example

@@ -9,5 +9,4 @@ PORT=8000
 HOST=0.0.0.0
 
 # Optional: FastMCP Configuration
-FASTMCP_SERVER_AUTH=GITHUB
-FASTMCP_DEBUG=false
+FASTMCP_DEBUG=false

.github/workflows/release.yml

@@ -16,34 +16,33 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      
+
       - name: Install uv
         uses: astral-sh/setup-uv@v2
-        
+
       - name: Set up Python
         run: uv python install 3.11
-        
+
       - name: Install dependencies
         run: uv sync
-        
+
       - name: Run tests
         run: |
           uv run ruff check src/
           uv run black --check src/
           # uv run pytest  # Add when tests are implemented
-          
+
       - name: Build package
         run: uv build
-        
+
       - name: Test server import
         run: uv run python -c "from fastmcp_github_oauth_example import create_server; print('✅ Server import successful')"
 
       - name: Test GoReleaser build
         if: github.event_name == 'pull_request'
-        uses: goreleaser/goreleaser-action@v5
+        uses: goreleaser/goreleaser-action@v6
         with:
           distribution: goreleaser
-          version: latest
           args: build --snapshot --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -55,34 +54,33 @@ jobs:
     permissions:
       contents: write
       packages: write
-      
+
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          
+
       - name: Install uv
         uses: astral-sh/setup-uv@v2
-        
-      - name: Set up Python  
+
+      - name: Set up Python
         run: uv python install 3.11
-        
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
-        
+
       - name: Login to Container Registry
         uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
-          
+
       - name: Run GoReleaser
-        uses: goreleaser/goreleaser-action@v5
+        uses: goreleaser/goreleaser-action@v6
         with:
           distribution: goreleaser
-          version: latest
           args: release --clean
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          GITHUB_REPOSITORY_OWNER: ${{ github.repository_owner }}
+          GITHUB_REPOSITORY_OWNER: ${{ github.repository_owner }}

README.md

@@ -72,22 +72,12 @@ uv sync
 cp .env.example .env
 # Edit .env with your GitHub OAuth credentials
 
-# Run the server
-uv run github-oauth-server
+# Run the server (loads environment from .env)
+uv run --env-file .env github-oauth-server
 ```
 
 ### 3. Docker Deployment
 
-#### Using Docker Compose (Recommended)
-
-```bash
-# Build and run with Docker Compose
-docker-compose up -d
-
-# View logs
-docker-compose logs -f
-```
-
 #### Using Published Image
 
 ```bash
@@ -98,7 +88,7 @@ docker run -d \
   -e GITHUB_CLIENT_SECRET=your_client_secret \
   -e BASE_URL=http://localhost:8000 \
   --name fastmcp-server \
-  ghcr.io/YOUR_ORG/fastmcp-github-oauth-example:latest
+  ghcr.io/YOUR_ORG/fastmcp-github-oauth-example:<architecture-tag>
 ```
 
 ### 4. Verify Installation
@@ -141,13 +131,14 @@ The easiest way to test the server is using the MCP Inspector:
 
 ```bash
 # Start the MCP server (in one terminal)
-uv run github-oauth-server
+uv run --env-file .env github-oauth-server
 
 # Test with MCP Inspector (in another terminal)
 npx @modelcontextprotocol/inspector@latest http://localhost:8000/mcp/
 ```
 
 The MCP Inspector will:
+
 1. Open a web interface for testing MCP servers
 2. Handle the GitHub OAuth flow automatically
 3. Allow you to test all available tools interactively
@@ -193,19 +184,19 @@ fastmcp-github-oauth-example/
 uv sync --group dev
 
 # Run with auto-reload (development)
-uv run python -m fastmcp_github_oauth_example.server
+uv run --env-file .env python -m fastmcp_github_oauth_example.server
 
 # Format code
 uv run black src/
 
-# Lint code  
+# Lint code
 uv run ruff check src/
 
 # Build package
 uv build
 
 # Test GoReleaser build (no Docker push)
-goreleaser build --snapshot --clean
+GITHUB_REPOSITORY_OWNER=YOUR_ORG goreleaser build --snapshot --clean
 ```
 
 ### Testing
@@ -218,15 +209,8 @@ uv run black --check src/
 # Test server import
 uv run python -c "from fastmcp_github_oauth_example import create_server"
 
-# Test Docker build locally
-docker build -t test-image .
-docker run --rm -p 8000:8000 \
-  -e GITHUB_CLIENT_ID=test \
-  -e GITHUB_CLIENT_SECRET=test \
-  test-image
-
 # Test GoReleaser snapshot build
-goreleaser release --snapshot --clean
+GITHUB_REPOSITORY_OWNER=YOUR_ORG goreleaser release --snapshot --clean
 ```
 
 ## Deployment
@@ -306,7 +290,7 @@ Enable detailed logging:
 
 ```bash
 # Local development
-FASTMCP_DEBUG=true uv run github-oauth-server
+FASTMCP_DEBUG=true uv run --env-file .env github-oauth-server
 
 # Docker
 docker run -e FASTMCP_DEBUG=true -p 8000:8000 fastmcp-github-oauth-example
@@ -362,4 +346,4 @@ This example is provided under the MIT License.
 - [uv Python Package Manager](https://github.com/astral-sh/uv)
 - [GoReleaser Documentation](https://goreleaser.com)
 - [GoReleaser uv Builder](https://goreleaser.com/customization/builds/uv/)
-- [Docker Best Practices](https://docs.docker.com/develop/dev-best-practices/)
+- [Docker Best Practices](https://docs.docker.com/develop/dev-best-practices/)

docker-compose.yml

@@ -4,21 +4,9 @@
 from fastmcp.server.auth.providers.github import GitHubProvider
 from fastmcp.server.dependencies import get_access_token
 from starlette.responses import JSONResponse
-from starlette.routing import Route
 from starlette.requests import Request
 
 
-def create_health_endpoint():
-    """Create health check endpoint for container monitoring."""
-
-    async def health(request: Request):
-        return JSONResponse(
-            {"status": "healthy", "service": "fastmcp-github-oauth", "version": "0.1.0"}
-        )
-
-    return Route("/health", health, methods=["GET"])
-
-
 def create_server():
     """Create and configure the FastMCP server."""
 
@@ -44,9 +32,16 @@ def create_server():
     mcp = FastMCP(
         name="GitHub OAuth Example Server",
         auth=auth_provider,
-        routes=[create_health_endpoint()],  # Add health check
     )
 
+    # Add health check endpoint using custom route decorator
+    @mcp.custom_route("/health", methods=["GET"])
+    async def health_check(request: Request):
+        """Health check endpoint for container monitoring."""
+        return JSONResponse(
+            {"status": "healthy", "service": "fastmcp-github-oauth", "version": "0.1.0"}
+        )
+
     @mcp.tool
     async def get_user_info() -> Dict[str, Any]:
         """Returns information about the authenticated GitHub user."""
@@ -128,6 +123,9 @@ def main():
         )
 
         mcp.run(transport="http", port=port, host=host)
+    except KeyboardInterrupt:
+        print("\n🛑 Shutting down server gracefully...")
+        exit(0)
     except ValueError as e:
         print(f"❌ Configuration Error: {e}")
         print("💡 Make sure to set GITHUB_CLIENT_ID and GITHUB_CLIENT_SECRET")