updated docs strings and added README.md

docforge/cli/mcp_utils.py

@@ -1,3 +1,9 @@
+"""
+# Summary
+
+Utilities for working with MCP in the doc-forge CLI.
+"""
+
 from pathlib import Path
 import click
 from docforge.loaders import GriffeLoader, discover_module_paths
@@ -14,12 +20,17 @@ def generate_resources(module: str, project_name: str | None, out_dir: Path) ->
     to the specified output directory.
 
     Args:
-        module: Python module import path used as the entry point for
+        module (str):
+            Python module import path used as the entry point for
             documentation generation.
-        project_name: Optional override for the project name used in
-            generated documentation metadata.
-        out_dir: Directory where MCP resources (index.json, nav.json,
-            and module data) will be written.
+
+        project_name (Optional[str]):
+            Optional override for the project name used in generated
+            documentation metadata.
+
+        out_dir (Path):
+            Directory where MCP resources (index.json, nav.json, and module data)
+            will be written.
     """
     loader = GriffeLoader()
     discovered_paths = discover_module_paths(module)
@@ -37,14 +48,17 @@ def serve(module: str, mcp_root: Path) -> None:
     navigation structure, and module documentation through MCP endpoints.
 
     Args:
-        module: Python module import path used to identify the served
+        module (str):
+            Python module import path used to identify the served
             documentation instance.
-        mcp_root: Path to the directory containing the MCP documentation
+
+        mcp_root (Path):
+            Path to the directory containing the MCP documentation
             bundle (index.json, nav.json, and modules/).
 
     Raises:
-        click.ClickException: If the MCP documentation bundle is missing
-            required files or directories.
+        click.ClickException:
+            If the MCP documentation bundle is missing required files or directories.
     """
     if not mcp_root.exists():
         raise click.ClickException(f"mcp_docs directory not found: {mcp_root}")