Merge pull request #8 from Kode-Rex/mcp

added in docker changes

Author: T-rav

.github/workflows/docker_mcp.yml

@@ -0,0 +1,38 @@
+name: Build and publish MCP Docker image
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docker/**'
+      - '.github/workflows/docker_mcp.yml'
+  workflow_dispatch:
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ./docker/Dockerfile
+          push: true
+          tags: |
+            webcat/mcp:latest
+            webcat/mcp:${{ github.sha }}
+          cache-from: type=registry,ref=webcat/mcp:buildcache
+          cache-to: type=registry,ref=webcat/mcp:buildcache,mode=max 

.github/workflows/main_webcatgpt.yml

@@ -4,10 +4,12 @@ on:
   push:
     branches:
       - main
+    paths:
+      - 'customgpt/**'  # Only trigger when files in customgpt directory change
   workflow_dispatch:
 
 env:
-  AZURE_FUNCTIONAPP_PACKAGE_PATH: 'src' # set this to the path to your web app project, defaults to the repository root
+  AZURE_FUNCTIONAPP_PACKAGE_PATH: 'customgpt' # updated to the new path
   PYTHON_VERSION: '3.11' # set this to the python version to use
 
 jobs:
@@ -35,8 +37,8 @@ jobs:
 
       - name: Run tests
         run: |
-          # Set Python path to include src directory
-          PYTHONPATH=$PYTHONPATH:$(pwd)/${{ env.AZURE_FUNCTIONAPP_PACKAGE_PATH }} pytest -v tests/
+          # Set Python path to include customgpt directory
+          PYTHONPATH=$PYTHONPATH:$(pwd)/${{ env.AZURE_FUNCTIONAPP_PACKAGE_PATH }} pytest -v customgpt/tests/
 
   build:
     needs: test # Only run build if tests pass

README.md

@@ -2,35 +2,50 @@
 
 ## Introduction
 
-Web Cat is a serverless Python-based API hosted on Azure Functions, designed to scrape and process website content responsibly. Leveraging the readability library and BeautifulSoup, `Web Cat` extracts the main body of text and related images from web pages, making it easy to integrate website content ChatGPT through the use of Custom GPTs. 
+Web Cat is a collection of Python-based APIs designed to enhance AI models with web search and content extraction capabilities. The project includes:
 
-Using the `@Web Cat` GPT enhances ideation by seamlessly integrating web content into conversations, eliminating the need for manual copy-pasting or suffering through out dated data issues. 
+1. A serverless Python-based API hosted on Azure Functions
+2. A Model Context Protocol (MCP) server that provides web search capabilities for AI models
+
+Both implementations are designed to responsibly scrape and process website content, making it easy to integrate web content into AI applications like ChatGPT through Custom GPTs.
+
+## Components
+
+### Azure Functions API
+
+The Azure Functions API leverages the readability library and BeautifulSoup to extract the main body of text and related images from web pages.
+
+### MCP Server
+
+The Model Context Protocol (MCP) server is a FastAPI-based implementation that provides web search capabilities with enhanced content extraction. It follows the MCP specification for standardized AI model interactions.
 
 ## Features
- - **Content Extraction**: Utilizes the readability library for clean text extraction.
- - **Text Processing**: Further processes extracted content for improved usability.
- - **Search Functionality**: Integrates with Serper.dev to provide web search capabilities.
+ - **Content Extraction**: Utilizes the readability library for clean text extraction
+ - **Text Processing**: Further processes extracted content for improved usability
+ - **Search Functionality**: Integrates with Serper.dev to provide web search capabilities
+ - **MCP Compliance**: Follows standardized Model Context Protocol specifications
+ - **Rate Limiting**: Protects the API from abuse with configurable rate limits
+ - **API Versioning**: Ensures backward compatibility as the API evolves
 
 ## Getting Started
 
-### Prerequisites
+For the Azure Functions API:
+- See the `customgpt` directory for specific documentation
 
-- Azure Functions Core Tools
-- Python 3.11
-- An Azure account and subscription
+For the MCP Server:
+- See the `docker` directory for build and deployment instructions
 
-## Local Development
+## Limitations and Considerations
+- **Text-Based Content**: The APIs are optimized for text and image content and may not accurately represent other multimedia or dynamic web content.
+- **API Keys**: A Serper API key is required for search functionality
 
-Prepare your local environment by running:
+## Contributing
 
-```bash
-cd src
-pip install -r requirements.txt
-func start
-```
+Contributions are welcome! Please feel free to submit a Pull Request.
 
-## Limitations and Considerations
-- **Text-Based Content**: The API is optimized for text and image content and may not accurately represent other multimedia or dynamic web content.
+## License
+
+This project is licensed under the terms of the license included in the repository.
 
 ## Usage
 

src/function_app.py customgpt/function_app.pysrc/function_app.py renamed to customgpt/function_app.py

@@ -7,8 +7,8 @@
 import sys
 import pytest
 
-# Add the src directory to the path so tests can import function_app
-sys.path.insert(0, os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))), "src"))
+# Update path to import from current directory structure
+sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 
 def main():
     """Run all tests in the tests directory."""

src/host.json customgpt/host.jsonsrc/host.json renamed to customgpt/host.json

@@ -4,7 +4,7 @@
 import os
 from unittest.mock import patch, MagicMock, mock_open
 
-# Add the src directory to the path so we can import the function_app
+# Update the import path to use the current directory structure
 sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 
 import function_app