Loqu8

MCP Server

Drive Copyworks from AI assistants via Model Context Protocol.

Copyworks includes a built-in MCP server that lets AI assistants drive the full worksheet workflow. The app window becomes a live preview while the AI handles content selection, configuration, and export.

What is MCP?

MCP (Model Context Protocol) is an open protocol that lets AI assistants interact with external tools. Copyworks exposes its entire functionality as MCP tools, so you can say things like:

The AI assistant handles the details — loading content, configuring the worksheet, and exporting the result.

Setup

The MCP server starts automatically on desktop (Windows, macOS, Linux) at http://localhost:7420/mcp.

Claude Code

claude mcp add --transport http copyworks http://localhost:7420/mcp --scope user

Or add to ~/.claude.json:

{
  "mcpServers": {
    "copyworks": {
      "type": "http",
      "url": "http://localhost:7420/mcp"
    }
  }
}

Cursor

Add to ~/.cursor/mcp.json:

{
  "mcpServers": {
    "copyworks": {
      "url": "http://localhost:7420/mcp"
    }
  }
}

VS Code (Copilot)

Add to .vscode/mcp.json:

{
  "mcp": {
    "servers": {
      "copyworks": {
        "type": "http",
        "url": "http://localhost:7420/mcp"
      }
    }
  }
}

Windsurf

Add to ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "copyworks": {
      "url": "http://localhost:7420/mcp"
    }
  }
}

Other Clients

Any MCP client that supports HTTP transport can connect to http://localhost:7420/mcp. The server uses the Streamable HTTP transport (MCP spec 2025-03-26).

Available Tools

ToolPurposeRead-only?
app_stateGet current text, characters, config, tier, versionYes
set_textSet Chinese text for the worksheetNo
set_configChange grid, annotations, paper size, tab, titleNo
list_lessonsBrowse the content library treeYes
load_lessonLoad a lesson onto the worksheetNo
select_charactersInclude/exclude specific charactersNo
export_pdfGenerate a printable PDFNo
screenshotCapture the live app window as PNGNo

Quick Start

1. app_state          → see what's on screen
2. set_text / load_lesson → set content
3. set_config         → adjust format
4. export_pdf         → generate PDF
5. screenshot         → capture preview

Config Reference

All fields in set_config are optional — pass only what you want to change.

FieldValuesDefault
gridTypemiZiGe, tianZiGe, huiGongGe, nonemiZiGe
columns3–2012
rowsPerBlock1–101
showPinyintrue/falsetrue
showBopomofotrue/falsefalse
showDefinitiontrue/falsetrue
characterModesolid, outline, toneColorsolid
characterVariantasEntered, simplified, traditionalasEntered
isLeftHandedtrue/falsefalse
titleany string“”
tabcopysheets, flashTiles, slidescopysheets
paperSizeletter, a4, legalletter
flashCols2–94

Entitlement Gating

The MCP server respects the same tier gates as the UI. Free tier users can use all tools, but gated features return a structured upgrade message that the AI assistant can relay naturally, including what the user was trying to do, what the Family plan unlocks, and a checkout link.

Example Workflow

User says: “I need practice worksheets for my daughter learning HSK Level 1.”

Agent does:

  1. list_lessons → finds HSK: Level 1 with 19 lessons
  2. load_lesson(category: "HSK: Level 1", number: "1") → loads first lesson (8 chars)
  3. set_config(showPinyin: true, showDefinition: true, rowsPerBlock: 2) → adds practice rows
  4. screenshot → shows the user what it looks like
  5. export_pdf → generates the printable PDF
  6. Repeats for lessons 2–19

The entire HSK Level 1 curriculum as printable worksheets, generated in seconds.

File Locations

WhatPath
Screenshots~/Pictures/Copyworks/screenshots/
PDF exports (via MCP)~/Documents/Copyworks/
App data~/.loqu8/data/
Saved worksheetsUser-chosen via file picker