digitalkin 0.2.13__tar.gz → 0.2.15__tar.gz

{digitalkin-0.2.13 → digitalkin-0.2.15}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: digitalkin
-Version: 0.2.13
+Version: 0.2.15
 Summary: SDK to build kin used in DigitalKin
 Author-email: "DigitalKin.ai" <contact@digitalkin.ai>
 License: Attribution-NonCommercial-ShareAlike 4.0 International
@@ -452,36 +452,36 @@ Classifier: License :: Other/Proprietary License
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: digitalkin-proto>=0.1.10
+Requires-Dist: digitalkin-proto>=0.1.15
 Requires-Dist: grpcio-health-checking>=1.71.0
 Requires-Dist: grpcio-reflection>=1.71.0
 Requires-Dist: grpcio-status>=1.71.0
-Requires-Dist: pydantic>=2.11.4
+Requires-Dist: pydantic>=2.11.5
 Provides-Extra: dev
-Requires-Dist: typos>=1.32.0; extra == "dev"
-Requires-Dist: ruff>=0.11.9; extra == "dev"
-Requires-Dist: mypy>=1.15.0; extra == "dev"
-Requires-Dist: pyright>=1.1.400; extra == "dev"
+Requires-Dist: typos>=1.33.1; extra == "dev"
+Requires-Dist: ruff>=0.11.13; extra == "dev"
+Requires-Dist: mypy>=1.16.0; extra == "dev"
+Requires-Dist: pyright>=1.1.401; extra == "dev"
 Requires-Dist: pre-commit>=4.2.0; extra == "dev"
 Requires-Dist: bump2version>=1.0.1; extra == "dev"
 Requires-Dist: build>=1.2.2; extra == "dev"
 Requires-Dist: twine>=6.1.0; extra == "dev"
-Requires-Dist: cryptography>=44.0.3; extra == "dev"
-Requires-Dist: taskiq[reload]>=0.11.17; extra == "dev"
+Requires-Dist: cryptography>=45.0.4; extra == "dev"
 Provides-Extra: examples
 Requires-Dist: openai>=1.75.0; extra == "examples"
 Provides-Extra: tests
-Requires-Dist: freezegun>=1.5.1; extra == "tests"
+Requires-Dist: freezegun>=1.5.2; extra == "tests"
 Requires-Dist: hdrhistogram>=0.10.3; extra == "tests"
 Requires-Dist: grpcio-testing>=1.71.0; extra == "tests"
 Requires-Dist: psutil>=7.0.0; extra == "tests"
-Requires-Dist: pytest>=8.3.4; extra == "tests"
-Requires-Dist: pytest-asyncio>=0.26.0; extra == "tests"
+Requires-Dist: pytest>=8.4.0; extra == "tests"
+Requires-Dist: pytest-asyncio>=1.0.0; extra == "tests"
 Requires-Dist: pytest-cov>=6.1.0; extra == "tests"
 Provides-Extra: taskiq
-Requires-Dist: rstream>=0.20.9; extra == "taskiq"
+Requires-Dist: rstream>=0.30.0; extra == "taskiq"
 Requires-Dist: taskiq-aio-pika>=0.4.2; extra == "taskiq"
-Requires-Dist: taskiq-redis>=1.0.8; extra == "taskiq"
+Requires-Dist: taskiq-redis>=1.0.9; extra == "taskiq"
+Requires-Dist: taskiq[reload]>=0.11.17; extra == "taskiq"
 Dynamic: license-file
 
 # DigitalKin Python SDK

{digitalkin-0.2.13 → digitalkin-0.2.15}/examples/modules/cpu_intensive_module.py

@@ -127,6 +127,16 @@ class CPUOutput(BaseModel):
     )
 
 
+class CPUConfigSetup(BaseModel):
+    """Config Setup model definining data that will be pre-computed for each setup and module instance."""
+
+    files: list[str] = Field(
+        ...,
+        title="Files to embed",
+        description="List of files to embed in the setup lifecycle.",
+    )
+
+
 class CPUSetup(BaseModel):
     """Setup model defining module configuration parameters."""
 
@@ -175,7 +185,7 @@ client_config = ClientConfig(
 )
 
 
-class CPUIntensiveModule(BaseModule[CPUInput, CPUOutput, CPUSetup, CPUToolSecret]):
+class CPUIntensiveModule(BaseModule[CPUInput, CPUOutput, CPUSetup, CPUToolSecret, None]):
     """A CPU endpoint tool module module."""
 
     name = "CPUIntensiveModule"
@@ -202,7 +212,6 @@ class CPUIntensiveModule(BaseModule[CPUInput, CPUOutput, CPUSetup, CPUToolSecret
             "client_config": client_config,
         },
         "filesystem": {
-            "config": {},
             "client_config": client_config,
         },
         "cost": {

{digitalkin-0.2.13 → digitalkin-0.2.15}/examples/modules/minimal_llm_module.py

@@ -11,7 +11,6 @@ from pydantic import BaseModel, Field
 from digitalkin.grpc_servers.utils.models import ClientConfig, SecurityMode, ServerMode
 from digitalkin.modules._base_module import BaseModule
 from digitalkin.services.services_models import ServicesStrategy
-from digitalkin.services.setup.setup_strategy import SetupData
 
 # Configure logging with clear formatting
 logging.basicConfig(
@@ -154,6 +153,16 @@ class OpenAISetup(BaseModel):
     )
 
 
+class OpenAIConfigSetup(BaseModel):
+    """Setup model defining module configuration parameters."""
+
+    rag_files: list[bytes] = Field(
+        ...,
+        title="RAG Files",
+        description="Files used for retrieval-augmented generation (RAG) with the OpenAI module.",
+    )
+
+
 class OpenAIToolSecret(BaseModel):
     """Secret model defining module configuration parameters."""
 
@@ -167,13 +176,22 @@ client_config = ClientConfig(
 )
 
 
-class OpenAIToolModule(BaseModule[OpenAIInput, OpenAIOutput, OpenAISetup, OpenAIToolSecret]):
+class OpenAIToolModule(
+    BaseModule[
+        OpenAIInput,
+        OpenAIOutput,
+        OpenAISetup,
+        OpenAIToolSecret,
+        OpenAIConfigSetup,
+    ]
+):
     """A openAI endpoint tool module module."""
 
     name = "OpenAIToolModule"
     description = "A module that interacts with OpenAI API to process text"
 
     # Define the schema formats for the module
+    config_setup_format = OpenAIConfigSetup
     input_format = OpenAIInput
     output_format = OpenAIOutput
     setup_format = OpenAISetup
@@ -205,7 +223,27 @@ class OpenAIToolModule(BaseModule[OpenAIInput, OpenAIOutput, OpenAISetup, OpenAI
         },
     }
 
-    async def initialize(self, setup_data: SetupData) -> None:
+    async def run_config_setup(
+        self,
+        config_setup_data: OpenAIConfigSetup,
+        setup_data: OpenAISetup,
+        callback: Callable,
+    ) -> None:
+        """Configure the module with additional setup data.
+
+        Args:
+            config_setup_data: Additional configuration content.
+            setup_data: Initial setup data for the module.
+            callback: Function to send output data back to the client.
+        """
+        logger.info("Configuring OpenAIToolModule with additional setup data. %s", config_setup_data)
+
+        # Here you can process config_content and update setup_data as needed
+        # For now, we just return the original setup_data
+        setup_data.developer_prompt = "| + |".join(f.decode("utf-8") for f in config_setup_data.rag_files)
+        await callback(setup_data)
+
+    async def initialize(self, setup_data: OpenAISetup) -> None:
         """Initialize the module capabilities.
 
         This method is called when the module is loaded by the server.

{digitalkin-0.2.13 → digitalkin-0.2.15}/examples/modules/text_transform_module.py

@@ -93,7 +93,6 @@ class TextTransformModule(BaseModule[TextTransformInput, TextTransformOutput, Te
             "client_config": client_config,
         },
         "filesystem": {
-            "config": {},
             "client_config": client_config,
         },
     }

digitalkin-0.2.15/examples/services/filesystem_module.py

@@ -0,0 +1,198 @@
+"""Example module implementation to test ArchetypeModule functionality."""
+
+import asyncio
+import datetime
+from collections.abc import Callable
+from typing import TYPE_CHECKING, Any
+
+from pydantic import BaseModel, Field
+
+from digitalkin.logger import logger
+from digitalkin.models.module import ModuleStatus
+from digitalkin.modules.archetype_module import ArchetypeModule
+from digitalkin.services.services_config import ServicesConfig
+from digitalkin.services.services_models import ServicesMode
+from digitalkin.services.filesystem.filesystem_strategy import FilesystemRecord, FileFilter, UploadFileData
+
+
+class ExampleInput(BaseModel):
+    """Input model for example module."""
+
+    message: str = Field(description="Message to process")
+    number: int = Field(description="Number to process")
+
+
+class ExampleOutput(BaseModel):
+    """Output model for example module."""
+
+    processed_message: str = Field(description="The processed message")
+    processed_number: int = Field(description="The processed number")
+    timestamp: datetime.datetime = Field(description="When the processing was done")
+
+
+class ExampleSetup(BaseModel):
+    """Setup model for example module."""
+
+    processing_mode: str = Field(description="Mode to process data in", default="default")
+    multiply_factor: int = Field(description="Factor to multiply number by", default=1)
+
+
+class ExampleSecret(BaseModel):
+    """Secret model for example module."""
+
+    api_key: str = Field(description="API key for external service")
+
+
+class ExampleStorage(BaseModel):
+    """Secret model for example module."""
+
+    test_key: str = Field(description="Test value for storage")
+
+
+class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, ExampleSecret, None]):
+    """Example module that demonstrates ArchetypeModule functionality."""
+
+    name = "ExampleModule"
+    description = "An example module for testing purposes"
+    input_format = ExampleInput
+    output_format = ExampleOutput
+    setup_format = ExampleSetup
+    secret_format = ExampleSecret
+    metadata = {"name": "ExampleModule", "description": "A module for testing ArchetypeModule functionality"}
+
+    # Define services_config_params with default values
+    services_config_strategies = {}
+    services_config_params = {"cost": {"config": {}}, "storage": {"config": {}}} # Filesystem has no config but it's enabled
+
+    def __init__(self, job_id: str, mission_id: str, setup_version_id: str) -> None:
+        """Initialize the example module.
+
+        Args:
+            job_id: Unique identifier for the job
+            name: Optional name for the module
+        """
+        # Initialize services configuration using the class attribute before the instance is created
+        self.services_config = ServicesConfig(
+            services_config_strategies=self.services_config_strategies,
+            services_config_params=self.services_config_params,
+            mode=ServicesMode.LOCAL,
+        )
+
+        super().__init__(job_id, mission_id, setup_version_id)
+
+    async def initialize(self, setup_data: ExampleSetup) -> None:
+        """Initialize the module.
+
+        Args:
+            setup_data: Setup data for the module
+        """
+        logger.info("Initializing ExampleModule with setup data: %s", setup_data)
+        self.setup = self.setup_format.model_validate(setup_data)
+        logger.info("Initialization complete, using processing mode: [%s]", self.setup.processing_mode)
+
+    async def run(
+        self,
+        input_data: dict[str, Any],
+        setup_data: ExampleSetup,
+        callback: Callable,
+    ) -> None:
+        """Run the module.
+
+        Args:
+            input_data: Input data for the module
+            setup_data: Setup data for the module
+            callback: Callback function to report progress
+        """
+        # Validate the input data
+        input_model = self.input_format.model_validate(input_data)
+        logger.info("Running with input data: %s", input_model)
+
+        # Process the data
+        processed_message = f"Processed: {input_model.message}"
+        processed_number = input_model.number * self.setup.multiply_factor
+
+        # Create output model
+        file = UploadFileData(
+            content=b"%s\n%s" % (processed_message.encode(), str(processed_number).encode()),
+            name="example_output.txt",
+            file_type="text/plain",
+            content_type="text/plain",
+            metadata={"example_key": "example_value"},
+            replace_if_exists=True,
+        )
+
+        records, uploaded, failed = self.filesystem.upload_files(files=[file])
+        for record in records:
+            logger.info("Uploaded file: %s, uploaded: %d, failed: %d", record, uploaded, failed)
+            logger.info("Stored file with ID: %s", record.id)
+            callback(record.model_dump())
+        # Call the callback with the output data
+
+
+        # Wait a bit to simulate processing time
+        await asyncio.sleep(1)
+
+    async def run_config_setup(
+        self,
+        setup_data: ExampleSetup,
+    ) -> None:
+        """Run the configuration setup for the module.
+
+        Args:
+            setup_data: Setup data for the module
+        """
+        logger.info("Running config setup with data: %s", setup_data)
+        # Here we could implement any additional configuration logic if needed
+
+    async def cleanup(self) -> None:
+        """Clean up the module."""
+        logger.info("Cleaning up ExampleModule")
+        # Nothing to clean up in this example
+
+
+async def test_module() -> None:
+    """Test the example module."""
+    # Create the module
+    module = ExampleModule(job_id="test-job-123", mission_id="test-mission-123", setup_version_id="test-setup-123")
+
+    # Define input and setup data
+    input_data = ExampleInput(message="Hello, world!", number=42)
+
+    setup_data = ExampleSetup(processing_mode="test", multiply_factor=10)
+
+    # Define a callback function
+    def callback(result) -> None:
+        logger.info(f"callback {result}")
+
+    # Start the module
+    await module.start(input_data, setup_data, callback)
+
+    # Wait for the module to complete
+    while module.status not in {ModuleStatus.STOPPED, ModuleStatus.FAILED}:
+        await asyncio.sleep(0.5)
+
+    # Check the storage
+    if module.status == ModuleStatus.STOPPED:
+        files, nb_results = module.filesystem.get_files(
+            filters=FileFilter(name="example_output.txt", context="test-mission-123"),
+        )
+        for file in files:
+            module.filesystem.update_file(file.id, file_type="updated")
+            # module.filesystem.delete_files(filters=FileFilter(name="example_output.txt", context="test-mission-123"), permanent=True)
+
+            logger.info("Retrieved file: %s with ID: %s", file.name, file.id)
+            try:
+                file_record = module.filesystem.get_file(file_id=file.id, include_content=True)
+                if file_record:
+                    logger.info("File ID: %s", file_record.id)
+                    logger.info("File name: %s", file_record.name)
+                    logger.info("File type: %s", file_record.file_type)
+                    logger.info("File status: %s", file_record.status)
+                    logger.info("File content: %s", file_record.content.decode())
+            except Exception:
+                logger.error("No file retrieved")
+
+
+if __name__ == "__main__":
+    # Run the module test
+    asyncio.run(test_module())

{digitalkin-0.2.13/examples/modules → digitalkin-0.2.15/examples/services}/storage_module.py

@@ -51,7 +51,7 @@ class ExampleStorage(BaseModel):
     test_key: str = Field(description="Test value for storage")
 
 
-class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, ExampleSecret]):
+class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, ExampleSecret, None]):
     """Example module that demonstrates ArchetypeModule functionality."""
 
     name = "ExampleModule"
@@ -64,14 +64,15 @@ class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, E
 
     # Define services_config_params with default values
     services_config_strategies = {}
-    services_config_params = {"storage": {"config": {"example": ExampleOutput}}, "filesystem": {"config": {}}}
+    services_config_params = {"storage": {"config": {"example": ExampleOutput}},"cost": {"config":{}}}
 
-    def __init__(self, job_id: str, mission_id: str) -> None:
+    def __init__(self, job_id: str, mission_id: str, setup_version_id: str) -> None:
         """Initialize the example module.
 
         Args:
             job_id: Unique identifier for the job
-            name: Optional name for the module
+            mission_id: Unique identifier for the mission
+            setup_version_id: Unique identifier for the setup version
         """
         # Initialize services configuration using the class attribute before the instance is created
         self.services_config = ServicesConfig(
@@ -80,7 +81,7 @@ class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, E
             mode=ServicesMode.LOCAL,
         )
 
-        super().__init__(job_id, mission_id)
+        super().__init__(job_id, mission_id, setup_version_id)
 
     async def initialize(self, setup_data: ExampleSetup) -> None:
         """Initialize the module.
@@ -92,6 +93,18 @@ class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, E
         self.setup = self.setup_format.model_validate(setup_data)
         logger.info("Initialization complete, using processing mode: [%s]", self.setup.processing_mode)
 
+    async def run_config_setup(
+        self,
+        setup_data: ExampleSetup,
+    ) -> None:
+        """Run the configuration setup for the module.
+
+        Args:
+            setup_data: Setup data for the module
+        """
+        logger.info("Running config setup with data: %s", setup_data)
+        # Here we could implement any additional configuration logic if needed
+
     async def run(
         self,
         input_data: dict[str, Any],
@@ -142,7 +155,7 @@ class ExampleModule(ArchetypeModule[ExampleInput, ExampleOutput, ExampleSetup, E
 async def test_module() -> None:
     """Test the example module."""
     # Create the module
-    module = ExampleModule(job_id="test-job-123", mission_id="test-mission-123")
+    module = ExampleModule(job_id="test-job-123", mission_id="test-mission-123", setup_version_id="test-setup-123")
 
     # Define input and setup data
     input_data = ExampleInput(message="Hello, world!", number=42)
@@ -171,7 +184,7 @@ async def test_module() -> None:
 def test_storage_directly() -> None:
     """Test the storage service directly."""
     # Initialize storage service
-    storage = ServicesConfig().storage(mission_id="test-mission", config={"example": ExampleStorage})
+    storage = ServicesConfig().storage(mission_id="test-mission",setup_version_id="test-setup-123", config={"example": ExampleStorage})
 
     # Create a test record
     storage.store("example", "test_table", {"test_key": "test_value"}, "OUTPUT")

{digitalkin-0.2.13 → digitalkin-0.2.15}/pyproject.toml

@@ -12,7 +12,7 @@
 
     keywords = [ "digitalkin", "kin", "agent", "gprc", "sdk" ]
     # Version of the package automatically updated by bump2version (that is why it is separated)
-    version = "0.2.13"
+    version = "0.2.15"
 
     classifiers = [
         "Development Status :: 3 - Alpha",
@@ -29,41 +29,41 @@
     ]
 
     dependencies = [
-        "digitalkin-proto>=0.1.10",
+        "digitalkin-proto>=0.1.15",
         "grpcio-health-checking>=1.71.0",
         "grpcio-reflection>=1.71.0",
         "grpcio-status>=1.71.0",
-        "pydantic>=2.11.4",
+        "pydantic>=2.11.5",
     ]
 
     [project.optional-dependencies]
         dev = [
-            "typos>=1.32.0",
-            "ruff>=0.11.9",
-            "mypy>=1.15.0",
-            "pyright>=1.1.400",
+            "typos>=1.33.1",
+            "ruff>=0.11.13",
+            "mypy>=1.16.0",
+            "pyright>=1.1.401",
             "pre-commit>=4.2.0",
             "bump2version>=1.0.1",
             "build>=1.2.2",
             "twine>=6.1.0",
-            "cryptography>=44.0.3",
-            "taskiq[reload]>=0.11.17",
+            "cryptography>=45.0.4",
         ]
         examples = [ "openai>=1.75.0" ]
         tests = [
-            "freezegun>=1.5.1",
+            "freezegun>=1.5.2",
             "hdrhistogram>=0.10.3",
             "grpcio-testing>=1.71.0",
             "psutil>=7.0.0",
-            "pytest>=8.3.4",
-            "pytest-asyncio>=0.26.0",
+            "pytest>=8.4.0",
+            "pytest-asyncio>=1.0.0",
             "pytest-cov>=6.1.0",
         ]
         taskiq = [
-            "rstream>=0.20.9",
+            "rstream>=0.30.0",
             "taskiq-aio-pika>=0.4.2",
-            "taskiq-redis>=1.0.8",
-]
+            "taskiq-redis>=1.0.9",
+            "taskiq[reload]>=0.11.17",
+        ]
 
     [project.urls]
         Homepage      = "https://github.com/DigitalKin-ai/digitalkin"
@@ -115,8 +115,8 @@
         "tool_module.py",
         "trigger_module.py",
         "generate_certificates.py",
-        "test_*.py",
-        "tests/*",
+        # "test_*.py",
+        # "tests/*",
         "examples/*",
     ]
     preview = true
@@ -186,9 +186,33 @@
                 "TRY002",
                 "FBT001",
                 "FBT002",
+                "ANN001",
                 "ANN003",
                 "ANN002",
                 "ARG002",
+                "PLR0914",
+                "PLR2004",
+                "PLR0915",
+                "PLR1702",
+                "D417",
+                "ARG001",
+                "D103",
+                "D102",
+                "D101",
+                "D107",
+                "N802",
+                "DOC201",
+                "DOC501",
+                "PERF203",
+                "C901",
+                "PLR0911",
+                "G004",
+                "ERA001",
+                "E501",
+                "ANN401",
+                "PLR0912",
+                "ANN201",
+                "D100"
             ]
 
         [tool.ruff.lint.pylint]

{digitalkin-0.2.13 → digitalkin-0.2.15}/src/digitalkin/__version__.py

@@ -5,4 +5,4 @@ from importlib.metadata import PackageNotFoundError, version
 try:
     __version__ = version("digitalkin")
 except PackageNotFoundError:
-    __version__ = "0.2.13"
+    __version__ = "0.2.15"

{digitalkin-0.2.13 → digitalkin-0.2.15}/src/digitalkin/grpc_servers/module_servicer.py

@@ -81,6 +81,62 @@ class ModuleServicer(module_service_pb2_grpc.ModuleServiceServicer, ArgParser):
         )
         self.setup = GrpcSetup() if self.args.services_mode == ServicesMode.REMOTE else DefaultSetup()
 
+    async def ConfigSetupModule(  # noqa: N802
+        self,
+        request: lifecycle_pb2.ConfigSetupModuleRequest,
+        context: grpc.aio.ServicerContext,
+    ) -> lifecycle_pb2.ConfigSetupModuleResponse:
+        """Configure the module setup.
+
+        Args:
+            request: The configuration request.
+            context: The gRPC context.
+
+        Returns:
+            A response indicating success or failure.
+
+        Raises:
+            ServicerError: if the setup data is not returned or job creation fails.
+        """
+        logger.info("ConfigSetupVersion called for module: '%s'", self.module_class.__name__)
+        # Process the module input
+        # TODO: Secret should be used here as well
+        setup_version = request.setup_version
+        config_setup_data = self.module_class.create_config_setup_model(json_format.MessageToDict(request.content))
+        setup_version_data = self.module_class.create_setup_model(
+            json_format.MessageToDict(request.setup_version.content)
+        )
+
+        if not setup_version_data:
+            msg = "No setup data returned."
+            raise ServicerError(msg)
+
+        if not config_setup_data:
+            msg = "No config setup data returned."
+            raise ServicerError(msg)
+
+        # create a task to run the module in background
+        job_id = await self.job_manager.create_config_setup_instance_job(
+            config_setup_data,
+            setup_version_data,
+            request.mission_id,
+            setup_version.id,
+        )
+
+        if job_id is None:
+            context.set_code(grpc.StatusCode.NOT_FOUND)
+            context.set_details("Failed to create module instance")
+            return lifecycle_pb2.ConfigSetupModuleResponse(success=False)
+
+        updated_setup_data = await self.job_manager.generate_config_setup_module_response(job_id)
+        logger.warning(f"Updated setup data: {updated_setup_data=}")
+        setup_version.content = json_format.ParseDict(
+            updated_setup_data,
+            struct_pb2.Struct(),
+            ignore_unknown_fields=True,
+        )
+        return lifecycle_pb2.ConfigSetupModuleResponse(success=True, setup_version=setup_version)
+
     async def StartModule(  # noqa: N802
         self,
         request: lifecycle_pb2.StartModuleRequest,
@@ -116,7 +172,7 @@ class ModuleServicer(module_service_pb2_grpc.ModuleServiceServicer, ArgParser):
         setup_data = self.module_class.create_setup_model(setup_data_class.current_setup_version.content)
 
         # create a task to run the module in background
-        job_id = await self.job_manager.create_job(
+        job_id = await self.job_manager.create_module_instance_job(
             input_data,
             setup_data,
             mission_id=request.mission_id,
@@ -391,3 +447,39 @@ class ModuleServicer(module_service_pb2_grpc.ModuleServiceServicer, ArgParser):
             success=True,
             secret_schema=secret_format_struct,
         )
+
+    async def GetConfigSetupModule(  # noqa: N802
+        self,
+        request: information_pb2.GetConfigSetupModuleRequest,
+        context: grpc.ServicerContext,
+    ) -> information_pb2.GetConfigSetupModuleResponse:
+        """Get information about the module's setup and configuration.
+
+        Args:
+            request: The get module setup request.
+            context: The gRPC context.
+
+        Returns:
+            A response with the module's setup information.
+        """
+        logger.debug("GetConfigSetupModule called for module: '%s'", self.module_class.__name__)
+
+        # Get setup schema if available
+        try:
+            # Convert schema to proto format
+            config_setup_schema_proto = self.module_class.get_config_setup_format(llm_format=request.llm_format)
+            config_setup_format_struct = json_format.Parse(
+                text=config_setup_schema_proto,
+                message=struct_pb2.Struct(),  # pylint: disable=no-member
+                ignore_unknown_fields=True,
+            )
+        except NotImplementedError as e:
+            logger.warning(e)
+            context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+            context.set_details(e)
+            return information_pb2.GetConfigSetupModuleResponse()
+
+        return information_pb2.GetConfigSetupModuleResponse(
+            success=True,
+            config_setup_schema=config_setup_format_struct,
+        )