refactor: remove README creation functionality and eliminate code duplication

  - Create shared constants.py for SETTINGS_DIR, CONFIG_FILE, INDEX_FILE, CACHE_FILE
  - Remove duplicate temporary directory management between server.py and project_settings.py
  - Eliminate redundant README creation logic in both global and project-specific directories
  - Consolidate create_temp_directory and check_temp_directory tools to use ProjectSettings
  - Reduce I/O operations and code complexity by ~70 lines
  - Improve maintainability through centralized constant management

Author: johnhuang316

src/code_index_mcp/constants.py

@@ -0,0 +1,9 @@
+"""
+Shared constants for the Code Index MCP server.
+"""
+
+# Directory and file names
+SETTINGS_DIR = "code_indexer"
+CONFIG_FILE = "config.json"
+INDEX_FILE = "file_index.pickle"
+CACHE_FILE = "content_cache.pickle"

src/code_index_mcp/project_settings.py

@@ -12,14 +12,13 @@
 import hashlib
 from datetime import datetime
 
+from .constants import (
+    SETTINGS_DIR, CONFIG_FILE, INDEX_FILE, CACHE_FILE
+)
+
 class ProjectSettings:
     """Class for managing project settings and index data"""
 
-    SETTINGS_DIR = "code_indexer"
-    CONFIG_FILE = "config.json"
-    INDEX_FILE = "file_index.pickle"
-    CACHE_FILE = "content_cache.pickle"
-
     def __init__(self, base_path, skip_load=False):
         """Initialize project settings
 
@@ -50,18 +49,13 @@ def __init__(self, base_path, skip_load=False):
                 print(f"Using current directory as fallback: {system_temp}")
 
             # Create code_indexer directory
-            temp_base_dir = os.path.join(system_temp, self.SETTINGS_DIR)
+            temp_base_dir = os.path.join(system_temp, SETTINGS_DIR)
             print(f"Code indexer directory path: {temp_base_dir}")
 
             if not os.path.exists(temp_base_dir):
                 print(f"Creating code indexer directory: {temp_base_dir}")
                 os.makedirs(temp_base_dir, exist_ok=True)
-
-                # Create a README.md file explaining the purpose of this directory
-                readme_path = os.path.join(temp_base_dir, "README.md")
-                with open(readme_path, 'w', encoding='utf-8') as f:
-                    f.write("# Code Indexer Cache Directory\n\nThis directory contains cached data for the Code Index MCP tool.\nEach subdirectory corresponds to a different project.\n")
-                print(f"README file created: {readme_path}")
+                print(f"Code indexer directory created: {temp_base_dir}")
             else:
                 print(f"Code indexer directory already exists: {temp_base_dir}")
         except Exception as e:
@@ -104,24 +98,7 @@ def ensure_settings_dir(self):
                 print(f"Creating project settings directory: {self.settings_path}")
                 # Create directory structure
                 os.makedirs(self.settings_path, exist_ok=True)
-
-                # Create a README.md file explaining the purpose of this directory
-                readme_path = os.path.join(self.settings_path, "README.md")
-                readme_content = (
-                    f"# Code Indexer Cache Directory for {self.base_path}\n\n"
-                    f"This directory contains cached data for the Code Index MCP tool:\n\n"
-                    f"- `config.json`: Project configuration\n"
-                    f"- `file_index.pickle`: Index of project files\n"
-                    f"- `content_cache.pickle`: Cached file contents\n\n"
-                    f"These files are automatically generated and stored in the system temporary directory.\n"
-                )
-
-                try:
-                    with open(readme_path, 'w', encoding='utf-8') as f:
-                        f.write(readme_content)
-                    print(f"README file created: {readme_path}")
-                except Exception as e:
-                    print(f"Warning: Could not create README file: {e}")
+                print(f"Project settings directory created: {self.settings_path}")
             else:
                 print(f"Project settings directory already exists: {self.settings_path}")
 
@@ -148,38 +125,38 @@ def ensure_settings_dir(self):
     def get_config_path(self):
         """Get the path to the configuration file"""
         try:
-            path = os.path.join(self.settings_path, self.CONFIG_FILE)
+            path = os.path.join(self.settings_path, CONFIG_FILE)
             # Ensure directory exists
             os.makedirs(os.path.dirname(path), exist_ok=True)
             return path
         except Exception as e:
             print(f"Error getting config path: {e}")
             # If error occurs, use file in current directory as fallback
-            return os.path.join(os.getcwd(), self.CONFIG_FILE)
+            return os.path.join(os.getcwd(), CONFIG_FILE)
 
     def get_index_path(self):
         """Get the path to the index file"""
         try:
-            path = os.path.join(self.settings_path, self.INDEX_FILE)
+            path = os.path.join(self.settings_path, INDEX_FILE)
             # Ensure directory exists
             os.makedirs(os.path.dirname(path), exist_ok=True)
             return path
         except Exception as e:
             print(f"Error getting index path: {e}")
             # If error occurs, use file in current directory as fallback
-            return os.path.join(os.getcwd(), self.INDEX_FILE)
+            return os.path.join(os.getcwd(), INDEX_FILE)
 
     def get_cache_path(self):
         """Get the path to the cache file"""
         try:
-            path = os.path.join(self.settings_path, self.CACHE_FILE)
+            path = os.path.join(self.settings_path, CACHE_FILE)
             # Ensure directory exists
             os.makedirs(os.path.dirname(path), exist_ok=True)
             return path
         except Exception as e:
             print(f"Error getting cache path: {e}")
             # If error occurs, use file in current directory as fallback
-            return os.path.join(os.getcwd(), self.CACHE_FILE)
+            return os.path.join(os.getcwd(), CACHE_FILE)
 
     def _get_timestamp(self):
         """Get current timestamp"""
@@ -257,7 +234,7 @@ def save_index(self, file_index):
             if not os.access(dir_path, os.W_OK):
                 print(f"Warning: Directory is not writable: {dir_path}")
                 # Use current directory as fallback
-                index_path = os.path.join(os.getcwd(), self.INDEX_FILE)
+                index_path = os.path.join(os.getcwd(), INDEX_FILE)
                 print(f"Using fallback path: {index_path}")
 
             with open(index_path, 'wb') as f:
@@ -268,7 +245,7 @@ def save_index(self, file_index):
             print(f"Error saving index: {e}")
             # Try saving to current directory
             try:
-                fallback_path = os.path.join(os.getcwd(), self.INDEX_FILE)
+                fallback_path = os.path.join(os.getcwd(), INDEX_FILE)
                 print(f"Trying fallback path: {fallback_path}")
                 with open(fallback_path, 'wb') as f:
                     pickle.dump(file_index, f)
@@ -304,7 +281,7 @@ def load_index(self):
                     return {}
             else:
                 # Try loading from current directory
-                fallback_path = os.path.join(os.getcwd(), self.INDEX_FILE)
+                fallback_path = os.path.join(os.getcwd(), INDEX_FILE)
                 if os.path.exists(fallback_path):
                     print(f"Trying fallback path: {fallback_path}")
                     try:
@@ -340,7 +317,7 @@ def save_cache(self, content_cache):
             if not os.access(dir_path, os.W_OK):
                 print(f"Warning: Directory is not writable: {dir_path}")
                 # Use current directory as fallback
-                cache_path = os.path.join(os.getcwd(), self.CACHE_FILE)
+                cache_path = os.path.join(os.getcwd(), CACHE_FILE)
                 print(f"Using fallback path: {cache_path}")
 
             with open(cache_path, 'wb') as f:
@@ -351,7 +328,7 @@ def save_cache(self, content_cache):
             print(f"Error saving cache: {e}")
             # Try saving to current directory
             try:
-                fallback_path = os.path.join(os.getcwd(), self.CACHE_FILE)
+                fallback_path = os.path.join(os.getcwd(), CACHE_FILE)
                 print(f"Trying fallback path: {fallback_path}")
                 with open(fallback_path, 'wb') as f:
                     pickle.dump(content_cache, f)
@@ -387,7 +364,7 @@ def load_cache(self):
                     return {}
             else:
                 # Try loading from current directory
-                fallback_path = os.path.join(os.getcwd(), self.CACHE_FILE)
+                fallback_path = os.path.join(os.getcwd(), CACHE_FILE)
                 if os.path.exists(fallback_path):
                     print(f"Trying fallback path: {fallback_path}")
                     try:
@@ -462,7 +439,7 @@ def get_stats(self):
                     stats['all_files'] = all_files
 
                     # Get details for specific files
-                    for filename in [self.CONFIG_FILE, self.INDEX_FILE, self.CACHE_FILE]:
+                    for filename in [CONFIG_FILE, INDEX_FILE, CACHE_FILE]:
                         file_path = os.path.join(self.settings_path, filename)
                         if os.path.exists(file_path):
                             try:

src/code_index_mcp/server.py

@@ -16,8 +16,9 @@
 from mcp.server.fastmcp import FastMCP, Context, Image
 from mcp import types
 
-# Import the ProjectSettings class - using relative import
+# Import the ProjectSettings class and constants - using relative import
 from .project_settings import ProjectSettings
+from .constants import SETTINGS_DIR
 
 # Create the MCP server
 mcp = FastMCP("CodeIndexer", dependencies=["pathlib"])
@@ -532,7 +533,7 @@ def get_settings_info(ctx: Context) -> Dict[str, Any]:
     # Check if base_path is set
     if not base_path:
         # Even if base_path is not set, we can still show the temp directory
-        temp_dir = os.path.join(tempfile.gettempdir(), "code_indexer")
+        temp_dir = os.path.join(tempfile.gettempdir(), SETTINGS_DIR)
         return {
             "status": "not_configured",
             "message": "Project path not set. Please use set_project_path to set a project directory first.",
@@ -549,7 +550,7 @@ def get_settings_info(ctx: Context) -> Dict[str, Any]:
     stats = settings.get_stats()
 
     # Get temp directory
-    temp_dir = os.path.join(tempfile.gettempdir(), "code_indexer")
+    temp_dir = os.path.join(tempfile.gettempdir(), SETTINGS_DIR)
 
     return {
         "settings_directory": settings.settings_path,
@@ -563,27 +564,18 @@ def get_settings_info(ctx: Context) -> Dict[str, Any]:
 @mcp.tool()
 def create_temp_directory() -> Dict[str, Any]:
     """Create the temporary directory used for storing index data."""
-    temp_dir = os.path.join(tempfile.gettempdir(), "code_indexer")
+    temp_dir = os.path.join(tempfile.gettempdir(), SETTINGS_DIR)
 
     result = {
         "temp_directory": temp_dir,
         "existed_before": os.path.exists(temp_dir),
     }
 
     try:
-        # Create the directory if it doesn't exist
-        if not os.path.exists(temp_dir):
-            os.makedirs(temp_dir, exist_ok=True)
-            result["created"] = True
-
-            # Create a README file
-            readme_path = os.path.join(temp_dir, "README.md")
-            with open(readme_path, 'w', encoding='utf-8') as f:
-                f.write("# Code Indexer Cache Directory\n\nThis directory contains cached data for the Code Index MCP tool.\nEach subdirectory corresponds to a different project.\n")
-            result["readme_created"] = True
-        else:
-            result["created"] = False
-
+        # Use ProjectSettings to handle directory creation consistently
+        temp_settings = ProjectSettings("", skip_load=True)
+        
+        result["created"] = not result["existed_before"]
         result["exists_now"] = os.path.exists(temp_dir)
         result["is_directory"] = os.path.isdir(temp_dir)
     except Exception as e:
@@ -594,7 +586,7 @@ def create_temp_directory() -> Dict[str, Any]:
 @mcp.tool()
 def check_temp_directory() -> Dict[str, Any]:
     """Check the temporary directory used for storing index data."""
-    temp_dir = os.path.join(tempfile.gettempdir(), "code_indexer")
+    temp_dir = os.path.join(tempfile.gettempdir(), SETTINGS_DIR)
 
     result = {
         "temp_directory": temp_dir,
@@ -778,19 +770,16 @@ def main():
     """Entry point for the code indexer."""
     print("Starting Code Index MCP Server...", file=sys.stderr)
 
-    # Ensure temporary directory exists
-    temp_dir = os.path.join(tempfile.gettempdir(), "code_indexer")
+    # Ensure temporary directory exists using ProjectSettings
+    temp_dir = os.path.join(tempfile.gettempdir(), SETTINGS_DIR)
     print(f"Temporary directory: {temp_dir}")
 
-    if not os.path.exists(temp_dir):
-        print(f"Creating temporary directory: {temp_dir}")
-        try:
-            os.makedirs(temp_dir, exist_ok=True)
-            print(f"Temporary directory created successfully")
-        except Exception as e:
-            print(f"Error creating temporary directory: {e}", file=sys.stderr)
-    else:
-        print(f"Temporary directory already exists")
+    try:
+        # Use ProjectSettings to handle directory creation consistently
+        temp_settings = ProjectSettings("", skip_load=True)
+        print(f"Temporary directory setup completed")
+    except Exception as e:
+        print(f"Error setting up temporary directory: {e}", file=sys.stderr)
 
     mcp.run()