Skip to content

Development

For a source checkout:

uv sync --extra dev --extra docs
uv run klayout-mcp

If an MCP client needs to launch the checkout directly:

command: uv
args:    --directory /abs/path/to/klayout-mcp run klayout-mcp

Documentation Site

Build the docs locally:

uv run --extra docs mkdocs build --strict

Serve the docs locally:

uv run --extra docs mkdocs serve

The repository is configured for Read the Docs with .readthedocs.yaml and mkdocs.yml. Import the GitHub repository into Read the Docs, and it can build directly from the default branch.

Project Workflow