LogoMergeway
    • browseComponents
      • Specification component
      • CLI
      • Diff
      • Python SDK
      • MCP
      • LSP
      • VS Code
    • rocket_launchTutorials
      • Build your first Mergeway repository
      • Review your first semantic change
      • Inspect a repository with an AI client
    • lightbulbHow-to guides
      • Install Mergeway tools
        • Reuse a JSON Schema
        • Load records with JSONPath
        • Model inheritance and reference unions
        • Derive identifiers and fields from paths
        • Load Open Knowledge Format documents
        • Create, inspect, update, and delete records
        • Validate configuration or a repository
        • Split schemas and records across files
        • Validate a repository in GitHub Actions
        • Enforce canonical formatting with pre-commit
        • Export repository data
        • Generate an entity-relationship diagram
        • Format safely in CI
        • Troubleshoot the CLI
        • Compare the working tree with HEAD
        • Compare two Git revisions
        • Publish a semantic change summary
        • Consume JSON diff output in automation
        • Troubleshoot semantic diff
        • Connect Codex over stdio
        • Restrict MCP to selected entities
        • Serve MCP over HTTP
        • Troubleshoot MCP connections and stdout
        • Configure Neovim
        • Configure a generic LSP client
        • Capture LSP debug logs
        • Troubleshoot diagnostics and navigation
      • Python SDK guides
        • Install the Python SDK
        • Get started with mergeway-python
    • developer_guideReference
        • Overview
        • Terminology
        • Conformance and requirement language
        • Repository and configuration
        • Entity definitions
        • Field definitions and types
        • Records and data sources
        • Identifiers and references
        • Validation and error model
        • JSON Schema interoperability
        • Path-derived data
        • Open Knowledge Format mapping
        • Changelog and migration notes
        • mergeway-cli init
        • mergeway-cli validate
        • mergeway-cli version
        • mergeway-cli entity list
        • mergeway-cli entity show
        • mergeway-cli fmt
        • mergeway-cli config lint
        • mergeway-cli config export
        • mergeway-cli gen-erd
        • mergeway-cli list
        • mergeway-cli files
        • mergeway-cli get
        • mergeway-cli create
        • mergeway-cli update
        • mergeway-cli delete
        • mergeway-cli export
          • MCP transports
          • MCP tools
        • mergeway-lsp reference
        • owlExplanation
          • Why metadata as code?
          • The Mergeway repository model
          • The validation model
          • Semantic diff versus file diff
          • MCP access and security
          • Editor architecture
          • Schema design choices
          • Component architecture
        • assignmentProject
          • Documentation authoring
          • GitHub
          • Releases
          • Contributing
          • MIT License
        Python SDK guides

        Python SDK guides

        Use these guides to add the mergeway package to a Python environment and operate on an existing Mergeway repository.

        • Install the Python SDK with uv or pip and verify its CLI dependency.
        • Get started with mergeway-python to generate models and perform common repository operations.

        Read the Python SDK component overview for its role, boundaries, and compatibility model.

        Calendar October 20, 2026
        Backward Troubleshoot diagnostics and navigation Install the Python SDK Forward