FEAT: Enable OPEA microservices to start as MCP servers

comps/asr/deployment/docker_compose/compose.yaml

@@ -14,11 +14,13 @@ services:
     environment:
       ASR_ENDPOINT: ${ASR_ENDPOINT}
       ASR_COMPONENT_NAME: ${ASR_COMPONENT_NAME:-OPEA_WHISPER_ASR}
+      ENABLE_MCP: ${ENABLE_MCP:-False}
   asr-whisper:
     extends: asr
     container_name: asr-whisper-service
     environment:
       ASR_COMPONENT_NAME: ${ASR_COMPONENT_NAME:-OPEA_WHISPER_ASR}
+      ENABLE_MCP: ${ENABLE_MCP:-False}
     depends_on:
       whisper-service:
         condition: service_healthy
@@ -27,6 +29,7 @@ services:
     container_name: asr-whisper-gaudi-service
     environment:
       ASR_COMPONENT_NAME: ${ASR_COMPONENT_NAME:-OPEA_WHISPER_ASR}
+      ENABLE_MCP: ${ENABLE_MCP:-False}
     depends_on:
       whisper-gaudi-service:
         condition: service_healthy

comps/asr/src/integrations/whisper.py

@@ -3,7 +3,7 @@
 
 import asyncio
 import os
-from typing import List
+from typing import List, Union
 
 import requests
 from fastapi import File, Form, UploadFile
@@ -32,7 +32,7 @@ def __init__(self, name: str, description: str, config: dict = None):
 
     async def invoke(
         self,
-        file: UploadFile = File(...),  # Handling the uploaded file directly
+        file: Union[str, UploadFile],  # accept base64 string or UploadFile
         model: str = Form("openai/whisper-small"),
         language: str = Form("english"),
         prompt: str = Form(None),
@@ -41,28 +41,39 @@ async def invoke(
         timestamp_granularities: List[str] = Form(None),
     ) -> AudioTranscriptionResponse:
         """Involve the ASR service to generate transcription for the provided input."""
-        # Read the uploaded file
-        file_contents = await file.read()
+        if isinstance(file, str):
+            data = {"audio": file}
+            # Send the file and model to the server
+            response = await asyncio.to_thread(
+                requests.post,
+                f"{self.base_url}/v1/asr",
+                json=data,
+            )
+            res = response.json()["asr_result"]
+            return AudioTranscriptionResponse(text=res)
+        else:
+            # Read the uploaded file
+            file_contents = await file.read()
 
-        # Prepare the files and data
-        files = {
-            "file": (file.filename, file_contents, file.content_type),
-        }
-        data = {
-            "model": model,
-            "language": language,
-            "prompt": prompt,
-            "response_format": response_format,
-            "temperature": temperature,
-            "timestamp_granularities": timestamp_granularities,
-        }
+            # Prepare the files and data
+            files = {
+                "file": (file.filename, file_contents, file.content_type),
+            }
+            data = {
+                "model": model,
+                "language": language,
+                "prompt": prompt,
+                "response_format": response_format,
+                "temperature": temperature,
+                "timestamp_granularities": timestamp_granularities,
+            }
 
-        # Send the file and model to the server
-        response = await asyncio.to_thread(
-            requests.post, f"{self.base_url}/v1/audio/transcriptions", files=files, data=data
-        )
-        res = response.json()["text"]
-        return AudioTranscriptionResponse(text=res)
+            # Send the file and model to the server
+            response = await asyncio.to_thread(
+                requests.post, f"{self.base_url}/v1/audio/transcriptions", files=files, data=data
+            )
+            res = response.json()["text"]
+            return AudioTranscriptionResponse(text=res)
 
     def check_health(self) -> bool:
         """Checks the health of the embedding service.

comps/asr/src/opea_asr_microservice.py

@@ -3,7 +3,7 @@
 
 import os
 import time
-from typing import List
+from typing import List, Union
 
 from fastapi import File, Form, UploadFile
 from integrations.whisper import OpeaWhisperAsr
@@ -19,12 +19,15 @@
     register_statistics,
     statistics_dict,
 )
+from comps.cores.mega.constants import MCPFuncType
 from comps.cores.proto.api_protocol import AudioTranscriptionResponse
 
 logger = CustomLogger("opea_asr_microservice")
 logflag = os.getenv("LOGFLAG", False)
 
 asr_component_name = os.getenv("ASR_COMPONENT_NAME", "OPEA_WHISPER_ASR")
+enable_mcp = os.getenv("ENABLE_MCP", "").strip().lower() in {"true", "1", "yes"}
+
 # Initialize OpeaComponentLoader
 loader = OpeaComponentLoader(asr_component_name, description=f"OPEA ASR Component: {asr_component_name}")
 
@@ -37,10 +40,13 @@
     port=9099,
     input_datatype=Base64ByteStrDoc,
     output_datatype=LLMParamsDoc,
+    enable_mcp=enable_mcp,
+    mcp_func_type=MCPFuncType.TOOL,
+    description="Convert audio to text.",
 )
 @register_statistics(names=["opea_service@asr"])
 async def audio_to_text(
-    file: UploadFile = File(...),  # Handling the uploaded file directly
+    file: Union[str, UploadFile],  # accept base64 string or UploadFile
     model: str = Form("openai/whisper-small"),
     language: str = Form("english"),
     prompt: str = Form(None),

comps/asr/src/requirements.txt

@@ -3,6 +3,7 @@ aiohttp
 datasets
 docarray[full]
 fastapi
+mcp
 opentelemetry-api
 opentelemetry-exporter-otlp
 opentelemetry-sdk

comps/cores/mega/constants.py

@@ -1,7 +1,7 @@
 # Copyright (C) 2024 Intel Corporation
 # SPDX-License-Identifier: Apache-2.0
 
-from enum import Enum
+from enum import Enum, auto
 
 
 class ServiceRoleType(Enum):
@@ -92,3 +92,11 @@ class MicroServiceEndpoint(Enum):
 
     def __str__(self):
         return self.value
+
+
+class MCPFuncType(Enum):
+    """The enum of a MCP function type."""
+
+    TOOL = auto()
+    RESOURCE = auto()
+    PROMPT = auto()

comps/cores/mega/micro_service.py

@@ -4,11 +4,12 @@
 import asyncio
 import os
 from collections import defaultdict, deque
+from collections.abc import Callable
 from enum import Enum
-from typing import Any, List, Optional, Type
+from typing import Any, List, Optional, Type, TypeAlias
 
 from ..proto.docarray import TextDoc
-from .constants import ServiceRoleType, ServiceType
+from .constants import MCPFuncType, ServiceRoleType, ServiceType
 from .http_service import HTTPService
 from .logger import CustomLogger
 from .utils import check_ports_availability
@@ -17,6 +18,7 @@
 
 logger = CustomLogger("micro_service")
 logflag = os.getenv("LOGFLAG", False)
+AnyFunction: TypeAlias = Callable[..., Any]
 
 
 class MicroService(HTTPService):
@@ -43,6 +45,9 @@
         dynamic_batching: bool = False,
         dynamic_batching_timeout: int = 1,
         dynamic_batching_max_batch_size: int = 32,
+        enable_mcp: bool = False,
+        mcp_func_type: Enum = MCPFuncType.TOOL,
+        func: AnyFunction = None,
     ):
         """Init the microservice."""
         self.service_role = service_role
@@ -56,6 +61,7 @@
         self.output_datatype = output_datatype
         self.use_remote_service = use_remote_service
         self.description = description
+        self.enable_mcp = enable_mcp
         self.dynamic_batching = dynamic_batching
         self.dynamic_batching_timeout = dynamic_batching_timeout
         self.dynamic_batching_max_batch_size = dynamic_batching_max_batch_size
@@ -82,7 +88,7 @@
                 "host": self.host,
                 "port": self.port,
                 "title": name,
-                "description": "OPEA Microservice Infrastructure",
+                "description": self.description or "OPEA Microservice Infrastructure",
             }
 
             super().__init__(uvicorn_kwargs=self.uvicorn_kwargs, runtime_args=runtime_args)
@@ -93,7 +99,21 @@
                 self.request_buffer = defaultdict(deque)
                 self.add_startup_event(self._dynamic_batch_processor())
 
-            self._async_setup()
+            if not enable_mcp:
+                self._async_setup()
+            else:
+                from mcp.server.fastmcp import FastMCP
+
+                self.mcp = FastMCP(name, host=self.host, port=self.port)
+                dispatch = {
+                    MCPFuncType.TOOL: self.mcp.add_tool,
+                    MCPFuncType.RESOURCE: self.mcp.add_resource,
+                    MCPFuncType.PROMPT: self.mcp.add_prompt,
+                }
+                try:
+                    dispatch[mcp_func_type](func, name=func.__name__, description=description)
+                except KeyError:
+                    raise ValueError(f"Unknown MCP func type: {mcp_func_type}")
 
         # overwrite name
         self.name = f"{name}/{self.__class__.__name__}" if name else self.__class__.__name__
@@ -144,6 +164,15 @@
         else:
             return f"{self.protocol}://{self.host}:{self.port}{self.endpoint}"
 
+    def start(self):
+        """Start the server using MCP if enabled, otherwise fall back to default."""
+        if self.enable_mcp:
+            self.mcp.run(
+                transport="sse",
+            )
+        else:
+            super().start()
+
     @property
     def api_key_value(self):
         return self.api_key
@@ -167,6 +196,9 @@
     dynamic_batching: bool = False,
     dynamic_batching_timeout: int = 1,
     dynamic_batching_max_batch_size: int = 32,
+    enable_mcp: bool = False,
+    description: str = None,
+    mcp_func_type: Enum = MCPFuncType.TOOL,
 ):
     def decorator(func):
         if name not in opea_microservices:
@@ -187,8 +219,22 @@
                 dynamic_batching=dynamic_batching,
                 dynamic_batching_timeout=dynamic_batching_timeout,
                 dynamic_batching_max_batch_size=dynamic_batching_max_batch_size,
+                enable_mcp=enable_mcp,
+                func=func,
+                description=description,
+                mcp_func_type=mcp_func_type,
             )
             opea_microservices[name] = micro_service
+
+        elif enable_mcp:
+            mcp_handle = opea_microservices[name].mcp
+            dispatch = {
+                MCPFuncType.TOOL: mcp_handle.add_tool,
+                MCPFuncType.RESOURCE: mcp_handle.add_resource,
+                MCPFuncType.PROMPT: mcp_handle.add_prompt,
+            }
+            dispatch[mcp_func_type](func, name=func.__name__, description=description)
+
         opea_microservices[name].app.router.add_api_route(endpoint, func, methods=methods)
 
         return func

requirements.txt

@@ -7,6 +7,7 @@ httpx
 kubernetes
 langchain
 langchain-community
+mcp
 opentelemetry-api
 opentelemetry-exporter-otlp
 opentelemetry-sdk

tests/asr/test_asr_whisper_mcp.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+# Copyright (C) 2025 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+set -x
+
+WORKPATH=$(dirname "$PWD")
+ip_address=$(hostname -I | awk '{print $1}')
+export TAG=comps
+export WHISPER_PORT=10104
+export ASR_PORT=10105
+export ENABLE_MCP=True
+cd $WORKPATH
+
+
+function build_docker_images() {
+    echo $(pwd)
+    docker build --no-cache -t opea/whisper:$TAG --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f comps/third_parties/whisper/src/Dockerfile .
+
+    if [ $? -ne 0 ]; then
+        echo "opea/whisper built fail"
+        exit 1
+    else
+        echo "opea/whisper built successful"
+    fi
+
+    docker build --no-cache -t opea/asr:$TAG --build-arg https_proxy=$https_proxy --build-arg http_proxy=$http_proxy -f comps/asr/src/Dockerfile .
+
+    if [ $? -ne 0 ]; then
+        echo "opea/asr built fail"
+        exit 1
+    else
+        echo "opea/asr built successful"
+    fi
+}
+
+function start_service() {
+    unset http_proxy
+    export ASR_ENDPOINT=http://$ip_address:$WHISPER_PORT
+
+    docker compose -f comps/asr/deployment/docker_compose/compose.yaml up whisper-service asr -d
+    sleep 1m
+}
+
+function validate_microservice() {
+    pip install mcp
+    python3 ${WORKPATH}/tests/utils/validate_svc_with_mcp.py $ip_address $ASR_PORT "asr"
+    if [ $? -ne 0 ]; then
+        docker logs whisper-service
+        docker logs asr-service
+        exit 1
+    fi
+
+}
+
+function stop_docker() {
+    docker ps -a --filter "name=whisper-service" --filter "name=asr-service" --format "{{.Names}}" | xargs -r docker stop
+}
+
+function main() {
+
+    stop_docker
+
+    build_docker_images
+    start_service
+
+    validate_microservice
+
+    stop_docker
+    echo y | docker system prune
+
+}
+
+main