Quarkdown

Quarkdown MCP Server provides a dedicated bridge to process Quarkdown documents through a Model Context Protocol interface. It lets you compile, validate, preview, and batch-convert Quarkdown content with flexible templates and multi-format outputs, making it easy to integrate rich documentation workflows into your tooling and pipelines.

How to use

Install and run the MCP server locally, then connect your MCP client to the local server to access all Quarkdown tools. You can compile documents into HTML, PDF, LaTeX, Markdown, or DOCX; create new projects from templates; run strict syntax checks; start a live preview server for real-time feedback; and process multiple documents in parallel. Most workflows start by launching the server in your development environment, then invoking the available tools from your client.

How to install

Prerequisites you need before installation include Python 3.8 or higher (Python 3.11+ recommended) and Java 11 or higher for the Quarkdown runtime.

Step 1: Clone the project and enter the source directory.

Step 2: Create and activate a virtual environment.

Step 3: Install core dependencies and install in development mode.

Step 4: If you plan to contribute, install development dependencies and optional tools.

Step 5: Run the MCP server module to start the service.

Configuration and runtime notes

Set the required environment and paths for the Quarkdown JAR, and configure MCP client settings to point to the local server. The server runs as a Python module and can be started from the source directory.

Examples you can run right away

{
  "mcpServers": {
    "quarkdown_mcp": {
      "command": "python",
      "args": ["-m", "quarkdown_mcp.server"],
      "cwd": "/path/to/quarkdown-mcp/src",
      "env": {
        "QUARKDOWN_JAR_PATH": "/path/to/quarkdown-mcp/quarkdown/build/libs/quarkdown.jar"
      }
    }
  }
}

Troubleshooting and tips

If you encounter startup or runtime issues, verify that the Quarkdown JAR path is correct, the Java runtime is accessible, and the Python environment is activated. Enable debug logs to get detailed information for diagnosing problems.

Available tools

compile_document

Compile Quarkdown source into HTML, PDF, LaTeX, Markdown, or DOCX formats using a selected template.

create_project

Create a new Quarkdown project with a chosen template and optional examples and Git initialization.

validate_markdown

Validate Quarkdown syntax with optional strict mode and checks for functions, variables, and links.

preview_server

Launch a local live preview server with automatic reload and theme options.

convert_batch

Process multiple documents in parallel, producing a chosen output format and optional index.