Merge branch 'main' into pr-2-infrastructure-ci-cd

Author: lamaalrajih

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,11 +1,3 @@
----
-name: Bug Report
-about: Report a bug or issue with the KiCad MCP Server
-title: "[BUG] "
-labels: bug
-assignees: ''
----
-
 ## Bug Description
 <!-- A clear and concise description of the bug -->
 

.gitignore

@@ -18,6 +18,11 @@ __pycache__/
 dist/
 build/
 *.egg-info/
+*.egg
+*.whl
+
+# PyPI
+.pypirc
 
 # Unit test / coverage reports
 htmlcov/

.python-version

@@ -0,0 +1 @@
+3.10

MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include LICENSE
+include requirements.txt
+include .env.example
+recursive-include kicad_mcp *.py
+recursive-include docs *.md

kicad_mcp/__init__.py

@@ -1,4 +1,27 @@
 """
 KiCad MCP Server - A Model Context Protocol server for KiCad.
 """
+from .server import *
+from .config import *
+from .context import *
+
 __version__ = "0.1.0"
+__author__ = "Lama Al Rajih"
+__description__ = "Model Context Protocol server for KiCad on Mac, Windows, and Linux"
+
+__all__ = [
+    # Package metadata
+    "__version__",
+    "__author__",
+    "__description__",
+
+    # Server creation / shutdown helpers
+    "create_server",
+    "add_cleanup_handler",
+    "run_cleanup_handlers",
+    "shutdown_server",
+
+    # Lifespan / context helpers
+    "kicad_lifespan",
+    "KiCadAppContext",
+]

kicad_mcp/server.py

@@ -5,8 +5,9 @@
 import os
 import signal
 import logging
+import functools
 from typing import Callable
-from mcp.server.fastmcp import FastMCP
+from fastmcp import FastMCP
 
 # Import resource handlers
 from kicad_mcp.resources.projects import register_project_resources
@@ -127,9 +128,11 @@ def create_server() -> FastMCP:
     # Always print this now, as we rely on CLI
     logging.info(f"KiCad Python module setup removed; relying on kicad-cli for external operations.")
 
+    # Build a lifespan callable with the kwarg baked in (FastMCP 2.x dropped lifespan_kwargs)
+    lifespan_factory = functools.partial(kicad_lifespan, kicad_modules_available=kicad_modules_available)
+
     # Initialize FastMCP server
-    # Pass the availability flag (always False now) to the lifespan context
-    mcp = FastMCP("KiCad", lifespan=kicad_lifespan, lifespan_kwargs={"kicad_modules_available": kicad_modules_available})
+    mcp = FastMCP("KiCad", lifespan=lifespan_factory)
     logging.info(f"Created FastMCP server instance with lifespan management")
 
     # Register resources
@@ -186,3 +189,43 @@ def cleanup_temp_dirs():
 
     logging.info(f"Server initialization complete")
     return mcp
+
+
+def setup_signal_handlers() -> None:
+    """Setup signal handlers for graceful shutdown."""
+    # Signal handlers are set up in register_signal_handlers
+    pass
+
+
+def cleanup_handler() -> None:
+    """Handle cleanup during shutdown."""
+    run_cleanup_handlers()
+
+
+def setup_logging() -> None:
+    """Configure logging for the server."""
+    logging.basicConfig(
+        level=logging.INFO,
+        format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+    )
+
+
+def main() -> None:
+    """Start the KiCad MCP server (blocking)."""
+    setup_logging()
+    logging.info("Starting KiCad MCP server...")
+    
+    server = create_server()
+    
+    try:
+        server.run()  # FastMCP manages its own event loop
+    except KeyboardInterrupt:
+        logging.info("Server interrupted by user")
+    except Exception as e:
+        logging.error(f"Server error: {e}")
+    finally:
+        logging.info("Server shutdown complete")
+
+
+if __name__ == "__main__":
+    main()

kicad_mcp/tools/export_tools.py

@@ -20,7 +20,7 @@ def register_export_tools(mcp: FastMCP) -> None:
     """
 
     @mcp.tool()
-    async def generate_pcb_thumbnail(project_path: str, ctx: Context) -> Optional[Image]:
+    async def generate_pcb_thumbnail(project_path: str, ctx: Context):
         """Generate a thumbnail image of a KiCad PCB layout using kicad-cli.
 
         Args:
@@ -88,14 +88,14 @@ async def generate_pcb_thumbnail(project_path: str, ctx: Context) -> Optional[Im
             return None
 
     @mcp.tool()
-    async def generate_project_thumbnail(project_path: str, ctx: Context) -> Optional[Image]:
+    async def generate_project_thumbnail(project_path: str, ctx: Context):
         """Generate a thumbnail of a KiCad project's PCB layout (Alias for generate_pcb_thumbnail)."""
         # This function now just calls the main CLI-based thumbnail generator
         print(f"generate_project_thumbnail called, redirecting to generate_pcb_thumbnail for {project_path}")
         return await generate_pcb_thumbnail(project_path, ctx)
 
 # Helper functions for thumbnail generation
-async def generate_thumbnail_with_cli(pcb_file: str, ctx: Context) -> Optional[Image]:
+async def generate_thumbnail_with_cli(pcb_file: str, ctx: Context):
     """Generate PCB thumbnail using command line tools.
     This is a fallback method when the kicad Python module is not available or fails.
 

main.py

@@ -9,7 +9,7 @@
 
 # Must import config BEFORE env potentially overrides it via os.environ
 from kicad_mcp.config import KICAD_USER_DIR, ADDITIONAL_SEARCH_PATHS
-from kicad_mcp.server import create_server
+from kicad_mcp.server import main as server_main
 from kicad_mcp.utils.env import load_dotenv
 
 # --- Setup Logging --- 
@@ -70,10 +70,10 @@
         else:
             logging.info(f"No additional search paths configured") # Changed print to logging
 
-        # Create and run server
-        server = create_server()
+        # Run server
         logging.info(f"Running server with stdio transport") # Changed print to logging
-        server.run(transport='stdio')
+        import asyncio
+        asyncio.run(server_main())
     except Exception as e:
         logging.exception(f"Unhandled exception in main") # Log exception details
         raise

pyproject.toml

@@ -16,6 +16,22 @@ dependencies = [
     "mcp[cli]>=1.0.0",
     "pandas>=2.0.0",
 ]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "License :: OSI Approved :: MIT License",
+  "Operating System :: OS Independent",
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/lamaalrajih/kicad-mcp"
+"Bug Tracker" = "https://github.com/lamaalrajih/kicad-mcp/issues"
+"Documentation" = "https://github.com/lamaalrajih/kicad-mcp#readme"
 
 [project.scripts]
 kicad-mcp = "kicad_mcp.server:main"
@@ -67,3 +83,11 @@ addopts = [
 ]
 testpaths = ["tests"]
 asyncio_mode = "auto"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["kicad_mcp*"]
+exclude = ["tests*", "docs*"]
+
+[tool.setuptools.package-data]
+"kicad_mcp" = ["prompts/*.txt", "resources/**/*.json"]