sokrates-mcp 0.3.0__py3-none-any.whl → 0.4.0__py3-none-any.whl

sokrates_mcp/main.py

@@ -305,6 +305,30 @@ async def read_from_file(
     ) -> str:
     return await workflow.read_from_file(ctx=ctx, file_path=file_path)
 
+@mcp.tool(
+    name="read_files_from_directory",
+    description="Read files from the local disk from the given directory path and return the file contents. You can also provide a list of file extentsions to include optionally.",
+    tags={"directory","read","load","local"}
+)
+async def read_files_from_directory(
+    ctx: Context, 
+    directory_path: Annotated[str, Field(description="The source directory path to use for reading the files. This should be an absolute file path on the disk.")],
+    file_extensions: Annotated[list[str], Field(description="A list of file extensions to include when reading the files. For markdown files you could use ['.md']", default=None)],
+    ) -> str:
+    return await workflow.read_files_from_directory(ctx=ctx, directory_path=directory_path, file_extensions=file_extensions)
+
+@mcp.tool(
+    name="directory_tree",
+    description="Provides a recursive directory file listing for the given directory path.",
+    tags={"directory","list","local"}
+)
+async def directory_tree(
+    ctx: Context, 
+    directory_path: Annotated[str, Field(description="The source directory path to use for reading the files. This should be an absolute file path on the disk.")]
+    ) -> str:
+    return await workflow.directory_tree(ctx=ctx, directory_path=directory_path)
+
+
 @mcp.tool(
     name="store_to_file",
     description="Store a file with the provided content to the local drive at the provided file path.",

sokrates_mcp/workflow.py

@@ -1,4 +1,5 @@
 from pathlib import Path
+import logging
 from typing import List
 
 from fastmcp import Context
@@ -19,12 +20,8 @@ class Workflow:
     Args:
         config (MCPConfig): The MCP configuration object
     """
+    self.logger = logging.getLogger(f"{__name__}.{self.__class__.__name__}")
     self.config = config
-    default_provider = self.config.get_default_provider()
-    self.default_model = default_provider['default_model']
-    self.default_api_endpoint = default_provider['api_endpoint']
-    self.default_api_key = default_provider['api_key']
-
     self.prompt_refiner = PromptRefiner()
     
   def _get_model(self, provider, model=''):
@@ -81,7 +78,8 @@ class Workflow:
     """
     refinement_prompt = self.load_refinement_prompt(refinement_type)
     workflow = self._initialize_refinement_workflow(provider_name=provider, model=model)
-    
+    self.logger.info(f"Starting refinement workflow with provider: {provider} and model: {model}")
+
     await ctx.info(f"Prompt refinement and execution workflow started with refinement model: {workflow.model} . Waiting for the response from the LLM...")
     refined = workflow.refine_prompt(input_prompt=prompt, refinement_prompt=refinement_prompt)
     await ctx.info(self.WORKFLOW_COMPLETION_MESSAGE)
@@ -107,6 +105,8 @@ class Workflow:
     refinement_model = self._get_model(provider=prov, model=refinement_model)
     execution_model = self._get_model(provider=prov, model=execution_model)
 
+    self.logger.info(f"Starting refinement workflow with provider: {provider} with refinement model: {refinement_model} and execution model: {execution_model}")
+
     workflow = self._initialize_refinement_workflow(provider_name=provider, model=execution_model)
     await ctx.info(f"Prompt refinement and execution workflow started with refinement model: {refinement_model} and execution model {execution_model} . Waiting for the responses from the LLMs...")
     result = workflow.refine_and_send_prompt(input_prompt=prompt, refinement_prompt=refinement_prompt, refinement_model=refinement_model, execution_model=execution_model)
@@ -130,6 +130,7 @@ class Workflow:
     
     prov = self._get_provider(provider)
     model = self._get_model(provider=prov, model=model)
+    self.logger.info(f"Handing over prompt to provider: {provider} and model: {model}")
     llm_api = LLMApi(api_endpoint=prov['api_endpoint'], api_key=prov['api_key'])
 
     result = llm_api.send(prompt,model=model, temperature=temperature)
@@ -151,6 +152,7 @@ class Workflow:
     Returns:
         str: A JSON string containing the list of sub-tasks with complexity ratings.
     """
+    self.logger.info(f"Breaking down task with provider: {provider} and model: {model}")
     workflow = self._initialize_refinement_workflow(provider_name=provider, model=model)
     await ctx.info(f"Task break-down started with model: {workflow.model} . Waiting for the response from the LLM...")
     result = workflow.breakdown_task(task=task)
@@ -172,6 +174,8 @@ class Workflow:
     """
     prov = self._get_provider(provider)
     model = self._get_model(provider=prov, model=model)
+
+    self.logger.info(f"Generating random ideas with provider: {provider} and model: {model}")
     await ctx.info(f"Task `generate random ideas` started at provider: {prov['name']} with model: {model} , idea_count: {idea_count} and temperature: {temperature}. Waiting for the response from the LLM...")
 
     idea_generation_workflow = IdeaGenerationWorkflow(api_endpoint=prov['api_endpoint'],
@@ -205,6 +209,7 @@ class Workflow:
     prov = self._get_provider(provider)
     model = self._get_model(provider=prov, model=model)
 
+    self.logger.info(f"Generating ideas on topic with provider: {provider} and model: {model}")
     await ctx.info(f"Task `generate ideas on topic` started with topic: '{topic}' , model: {model} , idea_count: {idea_count} and temperature: {temperature}. Waiting for the response from the LLM...")
     idea_generation_workflow = IdeaGenerationWorkflow(api_endpoint=prov['api_endpoint'],
       api_key=prov['api_key'],
@@ -238,6 +243,7 @@ class Workflow:
     prov = self._get_provider(provider)
     model = self._get_model(provider=prov, model=model)
 
+    self.logger.info(f"Generating code review of type: {review_type} with provider: {provider} and model: {model}")
     await ctx.info(f"Generating code review of type: {review_type} - using model: {model} ...")
     run_code_review(file_paths=source_file_paths,
                     directory_path=source_directory,
@@ -261,6 +267,7 @@ class Workflow:
     Returns:
         str: Formatted list of configured providers.
     """
+    self.logger.info(f"Listing available providers")
     providers = self.config.available_providers()
     result = "# Configured providers"
     for prov in providers:
@@ -279,6 +286,7 @@ class Workflow:
     Returns:
         str: Formatted list of available models and API endpoint.
     """
+    self.logger.info(f"Listing models for provider: {provider_name}")
     await ctx.info(f"Retrieving endpoint information and list of available models for configured provider {provider_name} ...")
     if not provider_name:
       provider = self.config.get_default_provider()
@@ -302,6 +310,7 @@ class Workflow:
 
     """
     await ctx.info(f"Storing file to: {file_path} ...")
+    self.logger.info(f"Storing content to file: {file_path}")
     if not file_path:
       raise ValueError("No file_path provided.")
     if not file_content:
@@ -318,13 +327,30 @@ class Workflow:
 
     """
     await ctx.info(f"Reading file from: {file_path} ...")
-    if not file_path:
-      raise ValueError("No file_path provided.")
-    if not Path(file_path).is_file():
-      raise ValueError("No file exists at the given file path.")
-
-    content = FileHelper.read_file(file_path=file_path)
-    result = f"<file source_file_path='{file_path}'>\n{content}\n</file>"
+    templated_file = self._read_file_to_templated_format(file_path=file_path)
+    await ctx.info(self.WORKFLOW_COMPLETION_MESSAGE)
+    return templated_file
+  
+  async def read_files_from_directory(self, ctx: Context, directory_path: str, file_extensions: List[str]) -> str:
+    file_exts_str = '.*'
+    if file_extensions:
+      file_exts_str = ','.join(file_extensions)
+    self.logger.info(f"Reading content for directory: {directory_path}")
+    await ctx.info(f"Reading files from directory: {directory_path} with file extensions: {file_exts_str} ...")
+    all_files = FileHelper.directory_tree(directory=directory_path, file_extensions=file_extensions)
+    result = ""
+    for file_path in all_files:
+      file_content = self._read_file_to_templated_format(file_path)
+      result = "\n".join([result, file_content])
+    await ctx.info(self.WORKFLOW_COMPLETION_MESSAGE)
+    return result
+  
+  async def directory_tree(self, ctx: Context, directory_path: str) -> str:
+    self.logger.info(f"Listing directory tree for directory: {directory_path}")
+    await ctx.info(f"Listing files recursively for directory: {directory_path} ...")
+    all_file_paths = FileHelper.directory_tree(directory=directory_path)
+    result = f"Directory: {directory_path}\n{"\n- ".join(all_file_paths)}"
+    
     await ctx.info(self.WORKFLOW_COMPLETION_MESSAGE)
     return result
   
@@ -332,6 +358,7 @@ class Workflow:
     """Roll a dice with the provided number of sides and return the result
 
     """
+    self.logger.info(f"Rolling {number_of_dice} dice with  {side_count} sides {number_of_rolls} times")
     await ctx.info(f"Throwing {number_of_dice} dice with {side_count} sides {number_of_rolls} times ...")
     result = ""
     for throw_number in range(1,number_of_rolls):
@@ -340,4 +367,13 @@ class Workflow:
         dice_result = Utils.rand_int_inclusive(1, side_count)
         result = f"- Dice {dice_number} result: {dice_result}\n"
     await ctx.info(self.WORKFLOW_COMPLETION_MESSAGE)
-    return result
+    return result
+  
+  def _read_file_to_templated_format(self, file_path: str) -> str:
+    if not file_path:
+      raise ValueError("No file_path provided.")
+    if not Path(file_path).is_file():
+      raise ValueError("No file exists at the given file path.")
+
+    content = FileHelper.read_file(file_path=file_path)
+    return f"<file source_file_path='{file_path}'>\n{content}\n</file>"

{sokrates_mcp-0.3.0.dist-info → sokrates_mcp-0.4.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sokrates-mcp
-Version: 0.3.0
+Version: 0.4.0
 Summary: A templated MCP server for demonstration and quick start.
 Author-email: Julian Weber <julianweberdev@gmail.com>
 License: MIT License
@@ -158,12 +158,20 @@ providers:
 ### Starting the Server
 
 ```bash
+# from local git repo
 uv run sokrates-mcp
+
+# without checking out the git repo
+uvx sokrates-mcp
 ```
 
 ### Listing available command line options
 ```bash
+# from local git repo
 uv run sokrates-mcp --help
+
+# without checking out the git repo
+uvx sokrates-mcp --help
 ```
 
 ## Architecture & Technical Details
@@ -185,110 +193,30 @@ The server follows a modular design pattern:
 
 ## Available Tools
 
-### main.py
-
-- **refine_prompt**: Refines a given prompt by enriching it with additional context.
-  - Parameters:
-    - `prompt` (str): The input prompt to be refined
-    - `refinement_type` (str, optional): Type of refinement ('code' or 'default'). Default is 'default'
-    - `model` (str, optional): Model name for refinement. Default is 'default'
-
-- **refine_and_execute_external_prompt**: Refines a prompt and executes it with an external LLM.
-  - Parameters:
-    - `prompt` (str): The input prompt to be refined and executed
-    - `refinement_model` (str, optional): Model for refinement. Default is 'default'
-    - `execution_model` (str, optional): Model for execution. Default is 'default'
-    - `refinement_type` (str, optional): Type of refinement ('code' or 'default'). Default is 'default'
-
-- **handover_prompt**: Hands over a prompt to an external LLM for processing.
-  - Parameters:
-    - `prompt` (str): The prompt to be executed externally
-    - `model` (str, optional): Model name for execution. Default is 'default'
-
-- **breakdown_task**: Breaks down a task into sub-tasks with complexity ratings.
-  - Parameters:
-    - `task` (str): The full task description to break down
-    - `model` (str, optional): Model name for processing. Default is 'default'
-
-- **list_available_models**: Lists all available large language models accessible by the server.
-
-### mcp_config.py
-
-- **MCPConfig** class: Manages configuration settings for the MCP server.
-  - Parameters:
-    - `config_file_path` (str, optional): Path to YAML config file
-    - `api_endpoint` (str, optional): API endpoint URL
-    - `api_key` (str, optional): API key for authentication
-    - `model` (str, optional): Model name
-
-### workflow.py
-
-- **Workflow** class: Implements the business logic for prompt refinement and execution.
-  -  e.g.:
-    - `refine_prompt`: Refines a given prompt
-    - `refine_and_execute_external_prompt`: Refines and executes a prompt with an external LLM
-    - `handover_prompt`: Hands over a prompt to an external LLM for processing
-    - `breakdown_task`: Breaks down a task into sub-tasks
-    - `list_available_models`: Lists all available models
+See the [main.py](src/sokrates_mcp/main.py) file for a list of all mcp tools in the server
 
 ## Project Structure
 
 - `src/sokrates_mcp/main.py`: Sets up the MCP server and registers tools
 - `src/sokrates_mcp/mcp_config.py`: Configuration management
+- `src/sokrates_mcp/utils.py`: Helper and utility methods
 - `src/sokrates_mcp/workflow.py`: Business logic for prompt refinement and execution
 - `pyproject.toml`: Dependency management
 
 
-## Script List
-
-### `main.py`
-Sets up an MCP server using the FastMCP framework to provide tools for prompt refinement and execution workflows.
-#### Usage
-- `uv run python main.py` - Start the MCP server (default port: 8000)
-- `uv run fastmcp dev main.py` - Run in development mode with auto-reload
-
-### `mcp_config.py`
-Provides configuration management for the MCP server. Loads configuration from a YAML file and sets default values if needed.
-#### Usage
-- Import and use in other scripts:
-  ```python
-  from mcp_config import MCPConfig
-  config = MCPConfig(api_endpoint="https://api.example.com", model="my-model")
-  ```
-
-### `workflow.py`
-Implements the business logic for prompt refinement and execution workflows. Contains methods to refine prompts, execute them with external LLMs, break down tasks, etc.
-#### Usage
-- Import and use in other scripts:
-  ```python
-  from workflow import Workflow
-  from mcp_config import MCPConfig
-
-  config = MCPConfig()
-  workflow = Workflow(config)
-  result = await workflow.refine_prompt("Write a Python function to sort a list", refinement_type="code")
-  ```
-
-### `src/mcp_client_example.py`
-Demonstrates a basic Model Context Protocol (MCP) client using the fastmcp library. Defines a simple model and registers it with the client.
-
-#### Usage
-- Run as a standalone script:
-  ```bash
-  python src/mcp_client_example.py
-  ```
-- Or use with an ASGI server like Uvicorn:
-  ```bash
-  uvicorn src.mcp_client_example:main --factory
-  ```
-
 **Common Error:**
 If you see "ModuleNotFoundError: fastmcp", ensure:
-1. Dependencies are installed (`uv pip install .`)
+1. Dependencies are installed (`uv sync`)
 2. Python virtual environment is activated
 
 ## Changelog
 
+**0.4.0 (Aug 2025)**
+- adds new tools:
+  - read_files_from_directory
+  - directory_tree
+  - logging refactoring in workflow.py
+
 **0.3.0 (Aug 2025)**
 - adds new tools:
     - roll_dice

{sokrates_mcp-0.3.0.dist-info → sokrates_mcp-0.4.0.dist-info}/RECORD

@@ -1,13 +1,13 @@
 sokrates_mcp/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sokrates_mcp/main.py,sha256=yF-QgN5713Xapy8aOly_XOSZ9XSOWbSuHv5zwl_ynEI,22589
+sokrates_mcp/main.py,sha256=Mm9DcviqzZgoZphKO0mqgPtc2vqNaLQKqU_CVw5OkEI,23883
 sokrates_mcp/mcp_config.py,sha256=5MnKhmZTCUhZQwhq1mlxuZwaAyC7Sw9VkMZ-DfMACoM,12395
 sokrates_mcp/utils.py,sha256=LOXRXjuEVhqVjJeJ7Rnn7eAVwzZEbWz7Vn9pwVb9oac,795
-sokrates_mcp/workflow.py,sha256=1vMGle8BE1bU8x1PjiQKaEcnZe4tdf2QN-lQjkAhe-c,15267
-sokrates_mcp-0.3.0.dist-info/licenses/LICENSE,sha256=OgJ7nuNhaIefjDRK0wTGOErJ_c1984Eg9oUweycmal0,1068
+sokrates_mcp/workflow.py,sha256=_dipnb4bH3eaZ4NHvtswtmBud34O9l9TiyrsR_dBB0U,17510
+sokrates_mcp-0.4.0.dist-info/licenses/LICENSE,sha256=OgJ7nuNhaIefjDRK0wTGOErJ_c1984Eg9oUweycmal0,1068
 sokrates_mcp_client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 sokrates_mcp_client/mcp_client_example.py,sha256=L5_xH0u7lt0k0t_eiFFhN9FVU__seFhxHfRixdy14PU,3866
-sokrates_mcp-0.3.0.dist-info/METADATA,sha256=fEbkt21NJ7EJOFW3ftossAD85-kag0VrSDFE00CdHi8,9616
-sokrates_mcp-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-sokrates_mcp-0.3.0.dist-info/entry_points.txt,sha256=7gYOgoyRs_mE6dmwMJrAtrMns2mxv4ZbqXBznRh3sUc,56
-sokrates_mcp-0.3.0.dist-info/top_level.txt,sha256=Nbwxz5Mm6LVkglOxqt4ZyEO5A6D4VjjN8c6d-fQyc3k,33
-sokrates_mcp-0.3.0.dist-info/RECORD,,
+sokrates_mcp-0.4.0.dist-info/METADATA,sha256=KZPA5IfuO62VqkCgXN85I67hPfUBgVeBb0VfIeQv2qA,6408
+sokrates_mcp-0.4.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+sokrates_mcp-0.4.0.dist-info/entry_points.txt,sha256=7gYOgoyRs_mE6dmwMJrAtrMns2mxv4ZbqXBznRh3sUc,56
+sokrates_mcp-0.4.0.dist-info/top_level.txt,sha256=Nbwxz5Mm6LVkglOxqt4ZyEO5A6D4VjjN8c6d-fQyc3k,33
+sokrates_mcp-0.4.0.dist-info/RECORD,,