Merge pull request #35 from NREL-Distribution-Suites/mcp_server_implementation

MCP server improvement

Author: AadilLatif

.github/workflows/main_test.yaml

@@ -24,7 +24,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install ".[dev]"
+          python -m pip install ".[dev,mcp]"
       - name: Run pytest
         run: |
           python -m pytest -v --disable-warnings tests
@@ -35,5 +35,5 @@ jobs:
       - uses: davidslusser/actions_python_ruff@v1.0.1
         with:
           src: "check src"
-          pip_install_command: "pip install -e .[dev]"
+          pip_install_command: "pip install -e .[dev,mcp]"
           python_version: "3.11"

.github/workflows/publish.yml

@@ -0,0 +1,94 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      environment:
+        description: 'Environment to publish to'
+        required: true
+        type: choice
+        options:
+          - testpypi
+          - pypi
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+    
+    - name: Install build dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+    
+    - name: Build package
+      run: python -m build
+    
+    - name: Check distribution
+      run: twine check dist/*
+    
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    if: github.event_name == 'workflow_dispatch' && github.event.inputs.environment == 'testpypi'
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/nrel-shift
+    
+    permissions:
+      id-token: write
+    
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    
+    - name: Publish distribution to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.environment == 'pypi')
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    
+    environment:
+      name: pypi
+      url: https://pypi.org/p/nrel-shift
+    
+    permissions:
+      id-token: write
+    
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/pull_request_tests.yml

@@ -29,5 +29,5 @@ jobs:
       - uses: davidslusser/actions_python_ruff@v1.0.1
         with:
           src: "check src"
-          pip_install_command: "pip install -e .[dev]"
+          pip_install_command: "pip install -e .[dev,mcp]"
           python_version: "3.11"

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.2.1
+    rev: v0.14.14
     hooks:
       # Run the linter.
       - id: ruff

.vscode/mcp.json

@@ -0,0 +1,10 @@
+{
+  "servers": {
+    "shift": {
+      "type": "stdio",
+      "command": "/opt/homebrew/Caskroom/miniconda/base/bin/shift-mcp-server",
+      "env": {}
+    }
+  }
+}
+

CHANGELOG.md

@@ -132,53 +132,51 @@ We follow PEP 8 with some modifications enforced by Ruff:
 
 ### Docstring Format
 
-Use Google-style docstrings:
+Use NumPy-style docstrings:
 
 ```python
 def function_name(param1: str, param2: int) -> bool:
-    """Brief description of function.
-    
+    """Brief one-line description of the function.
+
     Longer description if needed, explaining the purpose
     and behavior of the function.
-    
+
     Parameters
     ----------
     param1 : str
         Description of param1.
     param2 : int
         Description of param2.
-        
+
     Returns
     -------
     bool
         Description of return value.
-        
+
     Raises
     ------
     ValueError
         When invalid input is provided.
-        
+
     Examples
     --------
     >>> function_name("test", 5)
     True
     """
-    pass
 ```
 
 ### Type Hints
 
 Use type hints throughout:
 
 ```python
-from typing import List, Dict, Optional
+from typing import Optional
 
 def process_data(
-    data: List[float],
-    config: Optional[Dict[str, str]] = None
-) -> Dict[str, float]:
+    data: list[float],
+    config: Optional[dict[str, str]] = None,
+) -> dict[str, float]:
     """Process data with optional configuration."""
-    pass
 ```
 
 ## Testing Guidelines
@@ -192,7 +190,7 @@ def process_data(
 
 ### Test Coverage
 
-- Aim for >80% code coverage
+- Aim for > 80% code coverage on new code
 - Test both success and failure cases
 - Test edge cases and boundary conditions
 - Use parametrized tests for multiple scenarios
@@ -201,12 +199,14 @@ Example:
 
 ```python
 import pytest
+from shift import DistributionGraph, NodeModel
+from infrasys import Location
 
 @pytest.fixture
 def sample_graph():
-    """Fixture providing a sample graph for testing."""
+    """Fixture providing a graph with one node."""
     graph = DistributionGraph()
-    # Setup graph
+    graph.add_node(NodeModel(name="n1", location=Location(x=-97.3, y=32.7)))
     return graph
 
 @pytest.mark.parametrize("input,expected", [
@@ -278,8 +278,8 @@ Include:
 
 ## Questions and Support
 
-- **Issues**: Use GitHub Issues for bugs and features
-- **Discussions**: Use GitHub Discussions for questions
+- **Issues**: Use [GitHub Issues](https://github.com/NREL-Distribution-Suites/shift/issues) for bugs and feature requests
+- **Discussions**: Use [GitHub Discussions](https://github.com/NREL-Distribution-Suites/shift/discussions) for questions
 - **Email**: Contact maintainers for sensitive issues
 
 ## License