JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 667
  • Score
    100M100P100Q99913F
  • License UNLICENSED

Round-trip Diagram Editor MCP server for Zuiku

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (zuiku-mcp) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    zuiku-mcp

    zuiku-mcp is the primary MCP server package for Zuiku.

    npx -y zuiku-mcp is the shared entrypoint that CLI clients, IDE MCP settings, and optional IDE extensions call behind the scenes. It is usually configured once and then launched automatically by the client.

    What it exposes

    • zuiku.version: report the running package/server version and update hints
    • zuiku.open: open a markdown file, canonical Zuiku Markdown, or Mermaid-only content as a localhost editor session
    • zuiku.read: read current Markdown and hash before updating
    • zuiku.apply: write Mermaid-only or canonical Markdown back as normalized Zuiku Markdown with hash-based conflict protection
    • zuiku.export: export Markdown, PNG, or SVG
    • zuiku.ddl_to_er: turn an upstream-acquired DDL string into ER diagram payloads

    Entry command

    npx -y zuiku-mcp

    Version and update

    Check the currently installed package version:

    npx -y zuiku-mcp --version

    Check the latest published npm version:

    npm view zuiku-mcp version

    Run the latest package one-shot:

    npx -y zuiku-mcp@latest

    Update a global install:

    npm install -g zuiku-mcp@latest

    Typical usage

    • Codex CLI / Claude Code / Gemini CLI: register it as an MCP server command
    • VS Code / Cursor: point MCP settings at npx -y zuiku-mcp
    • IDE extensions: optional helper path that still launches the same MCP server

    Common environment variables

    • ZUIKU_MCP_ALLOWED_ROOTS: allowed file roots (: separated)
    • ZUIKU_MCP_ENABLE_EDITOR_HOST: 1 to enable the localhost editor host (default: 1)
    • ZUIKU_MCP_OPEN_BROWSER: 1 to open the browser on zuiku.open
    • ZUIKU_MCP_EDITOR_HOST / ZUIKU_MCP_EDITOR_PORT: host bind settings
    • ZUIKU_EDITOR_URL: editor URL (default: http://localhost:5173/editor)

    Notes

    • Requires Node.js 20+
    • zuiku.version can be called from MCP clients to confirm the running build and show update hints
    • For chat clients, ZUIKU_MCP_OPEN_BROWSER=0 is usually the better default
    • zuiku.apply(openAfterApply=true) can request opening or reusing the local editor session after save
    • Discovery guides are exposed over MCP resources/prompts so AI clients can avoid external lookup
    • After updating, restart the MCP client or IDE session so the new package is launched
    • During preview, CLI and manual MCP setup are the source of truth; optional IDE extension listings can be added on top later
    • Install guide: https://zuiku.dev/install
    • Docs: https://zuiku.dev/docs