Vishesh 'ironeagle' Bangotra
582b6809a0
- fix GSDFC spec contradictions in __init__ docstring (parenthesized types, fenced-block rule) and sync generated README - rewrite docstrings across loaders, models, nav, servers, renderers, cli; sync .pyi stubs - add pydoclint (google style) gate to dev extras and pyproject config - fix mcp nav resources doc:// -> docs:// - refresh docs/lib and docs/mcp, drop stale docforge/ duplicate group - update wiki pages and add GSDFC + MCP guides under 05_development
93 lines
2.6 KiB
Python
93 lines
2.6 KiB
Python
"""
|
|
# Summary
|
|
|
|
Utilities for working with MCP in the doc-forge CLI.
|
|
|
|
---
|
|
|
|
Notes:
|
|
- `generate_resources` produces the bundle consumed by `MCPServer`:
|
|
`index.json`, `nav.json`, and per-module resources under `modules/`.
|
|
- Resource URIs use the `docs://` scheme: `docs://index`, `docs://nav`,
|
|
and `docs://modules/{module}`.
|
|
|
|
---
|
|
"""
|
|
|
|
from pathlib import Path
|
|
|
|
import click
|
|
|
|
from docforge.loaders import GriffeLoader, discover_module_paths
|
|
from docforge.renderers import MCPRenderer
|
|
from docforge.servers import MCPServer
|
|
|
|
|
|
def generate_resources(module: str, project_name: str | None, out_dir: Path) -> None:
|
|
"""
|
|
Generate MCP documentation resources from a Python module.
|
|
|
|
The function performs project introspection, builds the internal
|
|
documentation model, and renders MCP-compatible JSON resources
|
|
to the specified output directory.
|
|
|
|
Args:
|
|
module (str):
|
|
Python module import path used as the entry point for
|
|
documentation generation.
|
|
|
|
project_name (str | None):
|
|
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)
|
|
project = loader.load_project(discovered_paths, project_name)
|
|
|
|
renderer = MCPRenderer()
|
|
renderer.generate_sources(project, out_dir)
|
|
|
|
|
|
def serve(module: str, mcp_root: Path) -> None:
|
|
"""
|
|
Start an MCP server for a pre-generated documentation bundle.
|
|
|
|
The server exposes documentation resources such as project metadata,
|
|
navigation structure, and module documentation through MCP endpoints.
|
|
|
|
Args:
|
|
module (str):
|
|
Python module import path used to identify the served
|
|
documentation instance.
|
|
|
|
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.
|
|
"""
|
|
if not mcp_root.exists():
|
|
raise click.ClickException(f"MCP docs directory not found: {mcp_root}")
|
|
|
|
required = [
|
|
mcp_root / "index.json",
|
|
mcp_root / "nav.json",
|
|
mcp_root / "modules",
|
|
]
|
|
|
|
for path in required:
|
|
if not path.exists():
|
|
raise click.ClickException(f"Invalid MCP bundle, missing: {path.name}")
|
|
|
|
server = MCPServer(
|
|
mcp_root=mcp_root,
|
|
name=f"{module}-mcp",
|
|
)
|
|
server.run()
|