Kition SDK developer docs

The Kition SDK puts real editors for docx, xlsx, pptx, PDF, PSD and more in your product: embed them, script them, run them headless, or hand them to an AI agent.

Guides

Quick start

Install @kition/embed, put the kit package (static files: the editor and its WebAssembly engine) on your own CDN, mount the editor on an element and save through your own storage: a working document editor in four steps.

Embed: in your page

Mount a kit’s editor with KitionEmbed.mount over your storage and your users (the editor and its WebAssembly engine load from your CDN), check the document, and review an agent’s draft or let your agent work in the open editor.

Embed: by link

Run @kition/embed-server, mint a signed iframe URL on your server for one person and one file, and answer the HMAC-signed callbacks that read and save the file in your storage. Single-user, free, no key.

Script

Read and edit a document as typed objects with @kition/script: the same script runs in a page, in Node, against a headless kit, or in a co-edited room.

Headless

Run a kit’s native engine with no window to open, edit, render and save files on servers, in batch jobs and in tests, from code or from an agent. Free, no key.

Agents (MCP)

kition-kits-mcp gives Claude, Cursor or any MCP client each kit’s tools on a workspace: inspect, run, query, batch and check, with drafts a person reviews and merges.

Co-editing

Add real-time co-editing to embedded kit editors: the sync server URL, short-lived sync tokens from your server, and running Kition Server on your own machines.

Distribution

What the versioned SDK bundle holds (npm packages, kit packages, executables, docs), how to make and verify it, and how to install from it or publish it to your private registry.

Version 0.2.0 (sdk.json; changes in CHANGELOG.md).

The platform documentation describes the SDK contracts.

The Kition SDK delivers published Kition kits to products and AI agents. The published kits are Note, for Markdown documents, and Table, for .ktable tables. A kit is one engine behind four delivery forms, so a person in your web app and your agent work on the same file with the same engine:

FormUse it toPackage or executableGuidePlatform
Embedput a kit's editor in your web page, over your storage and your users@kition/embedEmbed: in your pageKitEmbed 1.8 (@kition/embed serves KitEmbed 1.3, with EM25's opening and EM28–EM31); Kit UI protocol (UI-H1–H7, UI-K1–K7); kit editors
Scriptread and edit documents from code, in a page or in Node@kition/scriptScriptKitObjectModel 1.0; exchange in KitModel 1.1
Headlessrun a kit without a page, from any language: servers, desktop apps, batch jobs, testskition-kits serve, kition-<kit> executablesHeadless, hosts.mdengine contract; KitAgent 1.4 (A1–A4, headless Kit Process Protocol)
Agentgive an AI agent a kit's tools, including checking its own outputkition-kits-mcp (MCP over stdio; @kition/kits-mcp on npm), agent skillAgents (MCP)KitAgent 1.4 (A1–A23, D1)

Co-editing: Co-editing (Kition Cloud for your tenant: sync tokens from your server, or Kition Server on your own machines). Training and evaluation: env.md (any kit as an environment: generated editing tasks, rewards, verified traces; kit-env). Delivery: Distribution (the release: a bundle per platform with every executable, a manifest and SHA-256 sums; verifying and pinning it). Licence: every form is free and needs no key; only collaboration does (see licence).

The path a customer takes

  1. Embed Note in the web app with its own StorageProvider (files on its server).
  2. Agent: the customer's agent edits the same files with kition-kits-mcp --workspace <folder> (note_run, note_query, note_batch) and calls note_check.
  3. The person sees the agent's edits as new versions of the files; the agent reads the person's.

Versions

  • The SDK has one version (sdk.json version); a bundle records it in manifest.json and in each package's kitionSdk field.
  • Each npm package keeps its own semver inside the SDK; each kit package is the version Kition pins (kits/kits.lock.json) when the bundle is made, with its source commit.
  • The contracts have their own versions: KHP 1.0, the Kition kit platform (edition 2026.11), the kit engine contract (kition_kit::CONTRACT_VERSION), the Kit UI protocol (1.x), the Kit Process Protocol. The SDK's minor version moves when one of them gains a feature, its major version when one breaks.

Licence

Every form is free, open source (Apache-2.0), and needs no licence key, in development and in production: editors embedded in a web page (@kition/embed) and single-user URL embedding, @kition/script scripts, the headless executables on any machine (your servers included), and kition-kits-mcp. Nothing shows a mark or prints a warning.

Only collaboration is paid: running Kition Server yourself (free for companies of up to 8 people; Business and Enterprise plans are paid) or co-editing on Kition Cloud (hosted by Kition, billed by usage). See Co-editing.

Kition Server's licence (format, claims, verification): licence format.

From kition-sdk docs/sdk/README.md, where the snippets are tested.Source on GitHub