Merge pull request #26 from MarcSkovMadsen/enhancement/list-projects

Add missing list_projects tool

Author: MarcSkovMadsen

src/holoviz_mcp/docs_mcp/data.py

@@ -838,6 +838,39 @@ async def get_page(self, path: str, project: str, ctx: Context | None = None) ->
             raise ValueError(f"No page found for path '{path}' in project '{project}'.")
         return pages[0]
 
+    async def list_projects(self) -> list[str]:
+        """List all available projects with documentation in the index.
+
+        Returns
+        -------
+        list[str]: A list of project names that have documentation available.
+                   Names are returned in hyphenated format (e.g., "panel-material-ui").
+        """
+        await self.ensure_indexed()
+
+        try:
+            # Get all documents from the collection to extract unique project names
+            results = self.collection.get()
+
+            if not results["metadatas"]:
+                return []
+
+            # Extract unique project names
+            projects = set()
+            for metadata in results["metadatas"]:
+                project = metadata.get("project")
+                if project:
+                    # Convert underscored names to hyphenated format for consistency
+                    project_name = str(project).replace("_", "-")
+                    projects.add(project_name)
+
+            # Return sorted list
+            return sorted(projects)
+
+        except Exception as e:
+            logger.error(f"Failed to list projects: {e}")
+            return []
+
     async def _log_summary_table(self, ctx: Context | None = None):
         """Log a summary table showing document counts by repository."""
         try:

src/holoviz_mcp/docs_mcp/server.py

@@ -111,20 +111,20 @@ async def get_reference_guide(component: str, project: str | None = None, conten
     return await indexer.search_get_reference_guide(component, project, content, ctx=ctx)
 
 
-# @mcp.tool
-# async def list_projects() -> list[str]:
-#     """List all available HoloViz projects with documentation.
-
-#     This tool discovers all projects that have documentation available in the index,
-#     including both core HoloViz libraries and any additional user-defined projects.
-
-#     Returns
-#     -------
-#         list[str]: A list of project names that have documentation available.
-#                    Names are returned in hyphenated format (e.g., "panel-material-ui").
-#     """
-#     indexer = get_indexer()
-#     return await indexer.list_projects()
+@mcp.tool
+async def list_projects() -> list[str]:
+    """List all available projects with documentation.
+
+    This tool discovers all projects that have documentation available in the index,
+    including both core HoloViz libraries and any additional user-defined projects.
+
+    Returns
+    -------
+        list[str]: A list of project names that have documentation available.
+                   Names are returned in hyphenated format (e.g., "panel-material-ui").
+    """
+    indexer = get_indexer()
+    return await indexer.list_projects()
 
 
 @mcp.tool

tests/docs_mcp/test_docs_mcp.py

@@ -29,6 +29,17 @@ async def test_update_index():
         assert result.data
 
 
+@pytest.mark.asyncio
+async def test_list_projects():
+    """Test that all projects are listed correctly."""
+    client = Client(mcp)
+    async with client:
+        result = await client.call_tool("list_projects")
+
+    assert len(result.data) > 0
+    assert "panel" in result.data
+
+
 @pytest.mark.asyncio
 async def test_pages_semantic_search():
     """Test the pages tool with semantic search queries."""