Kami · Developers Home GitHub

Developers

Use the local MCP server, nine content schemas, and CLI checks to render and review documents.

01 · Surface

There is no hosted Kami API

Kami installs into an AI agent and runs in that environment. There is no hosted Kami API, account, or API key. Update checks and remote resources may use the network; see the privacy page for details.

The integration surface is therefore local: an MCP server for tool calls, JSON content schemas for structure, and CLI checks for verification. The static files listed at the bottom of this page are the machine-readable index of all of it, and they are generated from the same registry the templates use, with generation checks to catch drift.

02 · Install

Get the skill

The skill auto-triggers on document requests. No slash command is needed once it is installed.

# Claude Code, Codex, Cursor, and other agents
npx skills add tw93/kami -a claude-code codex cursor -g -y

# Claude Code plugin (v2.1.142+)
/plugin marketplace add tw93/kami
/plugin install kami@kami

# Codex plugin
codex plugin marketplace add tw93/kami
codex plugin add kami@kami

# MCP client, from a checkout
claude mcp add kami -- python3 <checkout>/skills/kami/scripts/mcp_server.py

Claude Desktop: download the release asset kami.zip, not GitHub's Source code ZIP, then upload it under Customize > Skills.

03 · MCP

Tools over stdio

Judgment stays in the skill prompt; execution lives in the server. An agent that already knows what it wants can render and verify without loading SKILL.md.

The server speaks newline-delimited JSON-RPC 2.0 on stdin and stdout and has no third-party dependency for the protocol itself. Tools that need WeasyPrint, pypdf, or PyMuPDF surface the install hint as a tool error instead of crashing. Its card, including the protocol version and the tool list, is published at /.well-known/mcp/server-card.json.

04 · Contracts

Content schemas

Each document type has a JSON schema that states its structure and its quality bar. Fill the schema first, lay out second.

Nine schemas live under references/schemas/: changelog, equity-report, landing-page, letter, long-doc, one-pager, portfolio, resume, slides. A new content.json also carries a brief with audience, job, output contract, target, preserve boundary, evidence, and acceptance checks; older IR files remain valid. Validate the content object before layout, then check how much of it actually reached the page:

python3 scripts/build.py --check-content content.json
python3 scripts/build.py --check-content content.json filled.html

The second form reports coverage: fields that exist in the content object but never made it into the document are the most common failure in agent-generated layouts, and can be easy to miss in a quick review.

05 · Verification

Document checks

Run python3 scripts/build.py --help for the authoritative list. Repository-wide checks, python3 scripts/build.py --check, cover template lint, design-token sync, and public-site fact drift.

06 · Catalog

Machine-readable files

These public files describe Kami for agents and search engines. Discovery files and catalog feeds are generated from the source; prose pages are maintained alongside them.