gfp-mcp 0.1.0__py3-none-any.whl → 0.2.4__py3-none-any.whl

gfp_mcp-0.2.4.dist-info/METADATA

@@ -0,0 +1,227 @@
+Metadata-Version: 2.4
+Name: gfp-mcp
+Version: 0.2.4
+Summary: Model Context Protocol (MCP) server for GDSFactory+ photonic IC design
+Author: GDSFactory+ Team
+License: MIT
+Project-URL: Homepage, https://github.com/doplaydo/gfp-mcp
+Project-URL: Repository, https://github.com/doplaydo/gfp-mcp
+Project-URL: Documentation, https://github.com/doplaydo/gfp-mcp#readme
+Project-URL: Changelog, https://github.com/doplaydo/gfp-mcp/blob/main/CHANGELOG.md
+Project-URL: Issue Tracker, https://github.com/doplaydo/gfp-mcp/issues
+Keywords: mcp,gdsfactory,photonics,ic-design,eda,model-context-protocol,photonic-ic,gds
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mcp>=1.7.1
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: typing-extensions>=4.0.0; python_version < "3.11"
+Requires-Dist: psutil>=5.9.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+Requires-Dist: bump-my-version>=0.26.0; extra == "dev"
+Requires-Dist: build>=1.4.0; extra == "dev"
+Dynamic: license-file
+
+# GDSFactory+ MCP Server
+
+[![PyPI version](https://img.shields.io/pypi/v/gfp-mcp.svg)](https://pypi.org/project/gfp-mcp/)
+[![Python versions](https://img.shields.io/pypi/pyversions/gfp-mcp.svg)](https://pypi.org/project/gfp-mcp/)
+[![Tests](https://github.com/doplaydo/gfp-mcp/actions/workflows/test.yml/badge.svg)](https://github.com/doplaydo/gfp-mcp/actions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Model Context Protocol (MCP) server for GDSFactory+ that enables AI assistants like Claude to design and build photonic integrated circuits.
+
+## What is this?
+
+This MCP server connects AI assistants to [GDSFactory+](https://gdsfactory.com), allowing you to design photonic ICs through natural language. Build components, run verification checks, and manage multiple projects directly from Claude Code or Claude Desktop.
+
+## Quick Start
+
+### 1. Install Prerequisites
+
+- Python 3.10 or higher
+- VSCode with the [GDSFactory+ extension](https://marketplace.visualstudio.com/items?itemName=gdsfactory.gdsfactoryplus) installed
+
+### 2. Install the MCP Server
+
+**With uv (recommended):**
+
+If you don't have `uv` installed, see the [uv installation guide](https://docs.astral.sh/uv/getting-started/installation/).
+
+```bash
+uv tool install gfp-mcp
+```
+
+<details>
+<summary>Ephemeral approach</summary>
+
+Run without installing:
+
+```bash
+uvx --from gfp-mcp gfp-mcp-serve
+```
+</details>
+
+<details>
+<summary><strong>Alternative: pip install</strong></summary>
+
+```bash
+pip install gfp-mcp
+```
+
+</details>
+
+### 3. Connect to Your AI Assistant
+
+<details>
+<summary><strong>Claude Code</strong></summary>
+
+Add to `.claude/settings.json`:
+
+```json
+{
+    "mcpServers": {
+        "gdsfactoryplus": {
+            "command": "gfp-mcp-serve",
+            "args": [],
+            "env": {
+                "GFP_API_URL": "http://localhost:8787"
+            }
+        }
+    }
+}
+```
+
+Or use the CLI:
+
+```bash
+claude mcp add gdsfactoryplus -- gfp-mcp-serve
+```
+
+</details>
+
+<details>
+<summary><strong>Claude Desktop</strong></summary>
+
+Add to your config file:
+
+**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
+
+**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
+
+**Linux**: `~/.config/Claude/claude_desktop_config.json`
+
+```json
+{
+    "mcpServers": {
+        "gdsfactoryplus": {
+            "command": "gfp-mcp-serve",
+            "args": []
+        }
+    }
+}
+```
+
+Restart Claude Desktop after adding the configuration.
+
+</details>
+
+<details>
+<summary><strong>Cursor</strong></summary>
+
+Coming soon. Follow the MCP integration instructions for Cursor when available.
+
+</details>
+
+### 4. Start Designing
+
+The MCP server automatically discovers running GDSFactory+ servers via the registry (`~/.gdsfactory/server-registry.json`). On startup, it will log all discovered projects.
+
+Try these commands with your AI assistant:
+
+- "List all available photonic components"
+- "Build an MZI interferometer"
+- "Show me details about the directional coupler"
+- "Build multiple components: mzi, coupler, and bend_euler"
+- "List all my GDSFactory+ projects"
+
+## Available Tools
+
+- **build_cells** - Build one or more GDS cells by name (pass a list, can be single-item)
+- **list_cells** - List all available photonic components
+- **get_cell_info** - Get detailed component metadata
+- **list_projects** - List all running GDSFactory+ server instances
+- **get_project_info** - Get detailed information about a specific project
+- **check_drc** - Run Design Rule Check verification (returns structured format with all violations including simplified location data for LLM-friendly troubleshooting)
+- **check_connectivity** - Run connectivity verification
+- **check_lvs** - Run Layout vs. Schematic verification
+
+## Multi-Project Support
+
+The MCP server automatically discovers all running GDSFactory+ projects via the server registry (`~/.gdsfactory/server-registry.json`). The registry is the source of truth for available servers. Use the `list_projects` tool to see all running projects, then specify the project name when building components:
+
+```
+User: "List all my GDSFactory+ projects"
+Claude: [Uses list_projects tool to show all running servers]
+
+User: "Build the mzi component in my_photonics_project"
+Claude: [Routes request to the correct project]
+```
+
+## Troubleshooting
+
+<details>
+<summary><strong>Server not appearing in Claude</strong></summary>
+
+1. Verify installation: `gfp-mcp-serve --help`
+2. Check Claude Code logs: `claude --debug`
+3. Restart Claude Desktop/Code
+4. Ensure the GDSFactory+ VSCode extension is active and a project is open
+
+</details>
+
+<details>
+<summary><strong>Connection refused errors</strong></summary>
+
+The MCP server uses the registry (`~/.gdsfactory/server-registry.json`) to discover running servers.
+
+1. Use the `list_projects` tool in Claude to check available servers
+2. If no servers are found, ensure the GDSFactory+ VSCode extension is running with an active project:
+   - Open VSCode with the GDSFactory+ extension installed
+   - Open a GDSFactory+ project folder
+   - The extension automatically starts the server and registers it
+3. Check the MCP startup logs for discovered servers
+4. Verify the registry is accessible at `~/.gdsfactory/server-registry.json`
+5. For backward compatibility, you can set a specific server URL:
+
+```bash
+export GFP_API_URL="http://localhost:YOUR_PORT"
+```
+
+</details>
+
+<details>
+<summary><strong>Tool execution timeout</strong></summary>
+
+Increase the timeout for long-running operations:
+
+```bash
+export GFP_MCP_TIMEOUT=600  # 10 minutes
+```
+
+</details>

gfp_mcp-0.2.4.dist-info/RECORD

@@ -0,0 +1,14 @@
+gfp_mcp-0.2.4.dist-info/licenses/LICENSE,sha256=ixSuHdKKXzNJw_eTgAxHzaCNIds8k48hytA_eJgA8gQ,225
+mcp_standalone/__init__.py,sha256=1-BT202aWn5Uwt-5bDHyGtBw3ObSKhK9ATzQlIXiJdw,1069
+mcp_standalone/client.py,sha256=LWO1emsiUa4Dg9yXH0FO7-LHV2ngxOov_acwH7JnVFo,9902
+mcp_standalone/config.py,sha256=bxJXYioVhx5FnS_dzvIEyVjaQbC91s6Pkl0tCRms3Ig,1225
+mcp_standalone/mappings.py,sha256=LFjo8Q5olO3LQM4Jy4h6xa4CD3bMWlyG_RtfDJGvQx4,15928
+mcp_standalone/registry.py,sha256=ozDrMPksWoyKAkNd9MH2g8FRoN0XEQKWnLwZsgDxWLc,6127
+mcp_standalone/resources.py,sha256=upY93XVemc5ezx1p_YML57O6HYVahCs2RsYXn4Dw_X0,3517
+mcp_standalone/server.py,sha256=FSjGSjwpe_D2idMrRrAMTq9pnwBToK2vZ1VtzPIMyeg,8788
+mcp_standalone/tools.py,sha256=qQAI6-Xb0sWUTJyYz5a47830cerbjwO5euIRhDmBRUk,16468
+gfp_mcp-0.2.4.dist-info/METADATA,sha256=v99aAe-JU0aQ7pmzICvHhoGLaKv4GoG4F9fNkxJHbyw,7369
+gfp_mcp-0.2.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+gfp_mcp-0.2.4.dist-info/entry_points.txt,sha256=mgyus9dsB_8mjgnztuHNPqzPi-7HcPg1iYzfM5NMIjk,61
+gfp_mcp-0.2.4.dist-info/top_level.txt,sha256=g2hRJHoDDPNtrNdXR70T7FR9Ev6DTRJiGW7ZvlvnXMc,15
+gfp_mcp-0.2.4.dist-info/RECORD,,

{gfp_mcp-0.1.0.dist-info → gfp_mcp-0.2.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.10.1)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

gfp_mcp-0.2.4.dist-info/licenses/LICENSE

@@ -0,0 +1,4 @@
+PROPRIETARY AND CONFIDENTIAL
+THIS SOFTWARE IS THE SOLE PROPERTY AND COPYRIGHT (c) 2025 OF DOPLAYDO INC.
+USE OR REPRODUCTION IN PART OR AS A WHOLE WITHOUT THE WRITTEN AGREEMENT OF DOPLAYDO IS PROHIBITED.
+NOTICE VERSION: 0.0.2

mcp_standalone/__init__.py

@@ -23,6 +23,7 @@ from __future__ import annotations
 
 from .client import FastAPIClient
 from .config import MCPConfig
+from .resources import get_all_resources, get_resource_content
 from .server import create_server, main, run_server
 from .tools import get_all_tools, get_tool_by_name
 
@@ -34,6 +35,8 @@ __all__ = [
     "run_server",
     "get_all_tools",
     "get_tool_by_name",
+    "get_all_resources",
+    "get_resource_content",
 ]
 
-__version__ = "0.1.0"
+__version__ = "0.2.4"

mcp_standalone/client.py

@@ -43,6 +43,21 @@ class FastAPIClient:
         self._client: httpx.AsyncClient | None = None
         self._registry = ServerRegistry()
 
+    def _has_available_servers(self) -> bool:
+        """Check if any servers are available in the registry."""
+        return len(self._registry.list_servers()) > 0
+
+    def _get_default_server_url(self) -> str | None:
+        """Get the first available server URL from registry if no base_url configured."""
+        if self.base_url:
+            return self.base_url
+
+        servers = self._registry.list_servers()
+        if servers:
+            return f"http://localhost:{servers[0].port}"
+
+        return None
+
     async def __aenter__(self) -> Self:
         """Enter async context."""
         await self.start()
@@ -55,12 +70,17 @@ class FastAPIClient:
     async def start(self) -> None:
         """Start the HTTP client with connection pooling."""
         if self._client is None:
+            base_url = self.base_url or "http://localhost"
+
             self._client = httpx.AsyncClient(
-                base_url=self.base_url,
+                base_url=base_url,
                 timeout=httpx.Timeout(self.timeout),
                 limits=httpx.Limits(max_keepalive_connections=5, max_connections=10),
             )
-            logger.debug("HTTP client started with base URL: %s", self.base_url)
+            logger.debug(
+                "HTTP client started with base URL: %s (resolved per-request if needed)",
+                self.base_url or "from registry",
+            )
 
     async def close(self) -> None:
         """Close the HTTP client."""
@@ -79,22 +99,46 @@ class FastAPIClient:
             Base URL for the request
 
         Raises:
-            ValueError: If project not found in registry
+            ValueError: If base URL cannot be resolved
         """
-        # If no project specified, use default base_url
-        if project is None:
+        if project is not None:
+            server_info = self._registry.get_server_by_project(project)
+            if server_info is None:
+                available = self._registry.list_servers()
+                if available:
+                    project_list = ", ".join([s.project_name for s in available[:3]])
+                    if len(available) > 3:
+                        project_list += f", ... and {len(available) - 3} more"
+                    msg = (
+                        f"Project '{project}' not found in registry. "
+                        f"Available projects: {project_list}. "
+                        "Use list_projects tool to see all running servers."
+                    )
+                else:
+                    msg = (
+                        f"Project '{project}' not found. No GDSFactory+ servers are running. "
+                        "Please open a GDSFactory+ project in VSCode with the extension installed."
+                    )
+                raise ValueError(msg)
+
+            return f"http://localhost:{server_info.port}"
+
+        if self.base_url:
             return self.base_url
 
-        # Look up project in registry
-        server_info = self._registry.get_server_by_project(project)
-        if server_info is None:
-            msg = (
-                f"Project '{project}' not found in registry. "
-                "Make sure the server is running for this project."
+        default_url = self._get_default_server_url()
+        if default_url:
+            logger.info(
+                "No project specified, using first available server: %s", default_url
             )
-            raise ValueError(msg)
+            return default_url
 
-        return f"http://localhost:{server_info.port}"
+        msg = (
+            "No project specified and no GDSFactory+ servers are running. "
+            "Either: (1) Start a server by opening a GDSFactory+ project in VSCode, "
+            "(2) Specify a project parameter, or (3) Set GFP_API_URL environment variable."
+        )
+        raise ValueError(msg)
 
     async def request(
         self,
@@ -125,7 +169,6 @@ class FastAPIClient:
         if self._client is None:
             await self.start()
 
-        # Resolve the base URL for this request
         base_url = self._resolve_base_url(project)
 
         last_error = None
@@ -143,7 +186,6 @@ class FastAPIClient:
                     base_url,
                 )
 
-                # Build full URL with the resolved base URL
                 full_url = f"{base_url}{path}"
 
                 response = await self._client.request(  # type: ignore[union-attr]
@@ -155,7 +197,6 @@ class FastAPIClient:
                 )
                 response.raise_for_status()
 
-                # Try to parse JSON, fall back to text
                 try:
                     return response.json()
                 except (ValueError, TypeError):
@@ -165,19 +206,16 @@ class FastAPIClient:
                 last_error = e
                 logger.warning("Request failed (attempt %d): %s", attempt + 1, e)
 
-                # Don't retry on client errors (4xx)
                 if (
                     isinstance(e, httpx.HTTPStatusError)
                     and 400 <= e.response.status_code < 500
                 ):
                     raise
 
-                # Exponential backoff for retries
                 if attempt < MCPConfig.MAX_RETRIES - 1:
                     await asyncio.sleep(backoff)
                     backoff *= 2
 
-        # All retries failed
         logger.error("All %d attempts failed", MCPConfig.MAX_RETRIES)
         raise last_error  # type: ignore[misc]
 
@@ -218,6 +256,10 @@ class FastAPIClient:
     async def health_check(self, project: str | None = None) -> bool:
         """Check if the FastAPI server is reachable.
 
+        .. deprecated::
+            This method is deprecated and no longer called during MCP startup.
+            Use list_projects() for server discovery instead.
+
         Args:
             project: Optional project name to check specific server
 

mcp_standalone/config.py

@@ -15,32 +15,28 @@ class MCPConfig:
     that proxies requests to the FastAPI backend.
     """
 
-    # FastAPI base URL (default: http://localhost:8787)
-    API_URL: Final[str] = os.getenv("GFP_API_URL", "http://localhost:8787")
+    API_URL: Final[str | None] = os.getenv("GFP_API_URL")
 
-    # Timeout for tool calls in seconds (default: 300 = 5 minutes)
     TIMEOUT: Final[int] = int(os.getenv("GFP_MCP_TIMEOUT", "300"))
 
-    # Enable debug logging
     DEBUG: Final[bool] = os.getenv("GFP_MCP_DEBUG", "false").lower() in (
         "true",
         "1",
         "yes",
     )
 
-    # Retry configuration
     MAX_RETRIES: Final[int] = 3
     RETRY_BACKOFF: Final[float] = 0.5  # Initial backoff in seconds
 
     @classmethod
-    def get_api_url(cls, override: str | None = None) -> str:
+    def get_api_url(cls, override: str | None = None) -> str | None:
         """Get the FastAPI base URL.
 
         Args:
             override: Optional URL to override the environment variable
 
         Returns:
-            The API base URL
+            The API base URL or None if not configured
         """
         return override or cls.API_URL