MCP server for ClicheFactory — structured data extraction from documents
Project description
clichefactory-mcp
MCP (Model Context Protocol) server for ClicheFactory — structured data extraction from documents.
This server exposes ClicheFactory's extraction and document conversion capabilities as MCP tools, allowing AI assistants in Cursor, Claude Desktop, OpenClaw, and other MCP-compatible clients to extract structured data from PDFs, images, DOCX, XLSX, CSV, EML, and more.
Quick start (recommended — service mode)
Service mode uses the ClicheFactory cloud for the best extraction quality. You only need one API key.
-
Sign up at clichefactory.com — free pages included, no credit card required.
-
Create an API key in Settings → API Keys (format:
cliche-...). -
Install the MCP server:
pip install clichefactory-mcp
-
Configure — either paste the key into your MCP client (see below) or run once in a terminal:
pip install clichefactory # if you don't have the CLI yet clichefactory configure
The interactive wizard saves credentials to
~/.clichefactory/config.toml, which the MCP server reads automatically.
That's it — one env var (CLICHEFACTORY_API_KEY) or a config file, and you're on hosted extraction.
Tools
| Tool | Description |
|---|---|
extract |
Extract structured JSON from a document using a schema |
to_markdown |
Convert a document to markdown text |
doctor |
Check configuration, dependencies, and system binaries |
extract
The main tool. Pass a document file and a JSON schema — get structured data back.
Supports all extraction modes:
| Mode | Description | Requires |
|---|---|---|
| (default) | OCR + LLM extraction | Service API key (recommended) |
fast |
Fastest pipeline | Service API key |
trained |
Trained pipeline artifact | Service + artifact_id |
robust |
Two-stage extract + verify | Service only |
robust-trained |
Trained extract + verification | Service + artifact_id |
The schema can be provided as:
- File path: absolute path to a
.jsonschema file - Inline dict: the LLM constructs a JSON schema from the conversation (e.g., the user says "extract the invoice number and total" and the LLM builds
{"type": "object", "properties": {"invoice_number": {"type": "string"}, "total": {"type": "number"}}})
to_markdown
Converts any supported document to markdown. Useful for inspecting document contents or feeding them to the LLM for analysis before deciding on an extraction schema.
doctor
Runs diagnostics on the ClicheFactory setup — config file, API keys, Python dependencies, system binaries. Call this when things aren't working.
Execution Modes
The server defaults to service mode (ClicheFactory cloud). Local mode is available for BYOK / air-gapped use.
-
service(recommended) — Uses the ClicheFactory cloud service. Requires a ClicheFactory API key. Supports all extraction modes including trained pipelines and robust verification. Best extraction quality out of the box. -
local(advanced) — Runs extraction on your machine. You bring your own LLM key (BYOK). Requirespip install "clichefactory-mcp[local]"(~2 GB of parsing/OCR dependencies) plus system binaries (tesseract, LibreOffice). Quality depends on your local setup.
Installation
Prerequisites
- Python ≥ 3.12
- uv (recommended) or pip
From PyPI
pip install clichefactory-mcp
For local-mode extraction (BYOK, runs on your machine), install with the local extras:
pip install "clichefactory-mcp[local]"
Configuration
Environment Variables
Set these in your MCP client configuration (see below) or in ~/.clichefactory/config.toml via clichefactory configure.
| Variable | Required | Description |
|---|---|---|
CLICHEFACTORY_API_KEY |
Yes (service mode) | ClicheFactory API key from Settings → API Keys (cliche-...) |
CLICHEFACTORY_API_URL |
No | Override the default service URL (https://api.clichefactory.com); useful for local development against a self-hosted ClicheFactory backend |
LLM_MODEL_NAME |
Local mode only | Model name, e.g. gemini/gemini-3-flash-preview |
LLM_API_KEY |
Local mode only | API key for the LLM provider |
OCR_MODEL_NAME |
No | Separate OCR/VLM model (defaults to main model) |
OCR_API_KEY |
No | API key for OCR model (defaults to main key) |
Environment variables take precedence over the config file at ~/.clichefactory/config.toml.
Cursor
Add to .cursor/mcp.json in your project (or global Cursor settings):
{
"mcpServers": {
"clichefactory": {
"command": "uvx",
"args": ["clichefactory-mcp"],
"env": {
"CLICHEFACTORY_API_KEY": "cliche-your-key-here"
}
}
}
}
For local development from a git checkout, replace uvx with:
"command": "uv",
"args": ["--directory", "/absolute/path/to/cliche-mcp", "run", "clichefactory-mcp"]
Claude Desktop
Add to ~/Library/Application Support/Claude/claude_desktop_config.json (macOS) or %APPDATA%\Claude\claude_desktop_config.json (Windows):
{
"mcpServers": {
"clichefactory": {
"command": "uvx",
"args": ["clichefactory-mcp"],
"env": {
"CLICHEFACTORY_API_KEY": "cliche-your-key-here"
}
}
}
}
OpenClaw
Register the MCP server with your OpenClaw agent:
openclaw mcp set clichefactory '{"command":"uvx","args":["clichefactory-mcp"],"env":{"CLICHEFACTORY_API_KEY":"cliche-your-key-here"}}'
Verify with openclaw mcp list. The agent can now use extract, to_markdown, and doctor tools in any conversation.
An OpenClaw skill with agent instructions is also available in integrations/openclaw/. To install it into your workspace:
cp -r /path/to/cliche-mcp/integrations/openclaw ~/.openclaw/skills/clichefactory
Or, once published to ClawHub:
openclaw skills install clichefactory
Local mode (advanced)
If you prefer BYOK extraction on your machine, install the local extras and set LLM credentials:
{
"mcpServers": {
"clichefactory": {
"command": "uvx",
"args": ["clichefactory-mcp"],
"env": {
"LLM_MODEL_NAME": "gemini/gemini-3-flash-preview",
"LLM_API_KEY": "your-gemini-api-key"
}
}
}
}
Pass mode="local" explicitly in tool calls, or run clichefactory configure --local to set local as the default in ~/.clichefactory/config.toml.
Supported File Types
PDF, PNG, JPG, JPEG, WebP, GIF, BMP, DOCX, DOC, ODT, XLSX, CSV, EML, TXT, MD.
Differences from the CLI
This MCP server covers the core extraction and conversion workflows. The following CLI features are not included in v1:
| Feature | Reason |
|---|---|
Batch operations (extract-batch, to-markdown-batch) |
MCP tools are typically called one-at-a-time by the LLM. For multiple documents, the LLM calls extract in sequence. Batch support may be added in a future version. |
configure |
Interactive prompts don't work in MCP. Use env vars or run clichefactory configure in a terminal. |
--output / -o flag |
MCP tools return results directly to the LLM rather than writing to files. |
allow_partial |
Not exposed as a tool parameter in v1. |
| OCR engine selection | Uses the SDK defaults (RapidOCR). Configure via ~/.clichefactory/config.toml or pass parsing options through the SDK if needed. |
Development
# Install in development mode
uv sync
# Run the server directly (stdio transport, for testing with MCP clients)
uv run clichefactory-mcp
# Inspect available tools (requires mcp CLI)
uv run mcp dev cliche_mcp/server.py
License
MIT — Copyright (c) 2026 Urban Susnik s.p.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file clichefactory_mcp-0.1.9.tar.gz.
File metadata
- Download URL: clichefactory_mcp-0.1.9.tar.gz
- Upload date:
- Size: 16.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
09d9f174b284e52a9382e29b0b8d5e6cafd7e789396fbe644dd07189225c8197
|
|
| MD5 |
e59f3f43c0b80858dcf20f4363cac75e
|
|
| BLAKE2b-256 |
cf5e1c360fa196216ae83a9622cadb6731c278fe1d3ced0aee87184f02c0fcd4
|
File details
Details for the file clichefactory_mcp-0.1.9-py3-none-any.whl.
File metadata
- Download URL: clichefactory_mcp-0.1.9-py3-none-any.whl
- Upload date:
- Size: 11.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.9.13 {"installer":{"name":"uv","version":"0.9.13"},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
35209a90012ffa4ae4984966c8547aded7fbd4e415d58493d4d2bb0c84e54b5b
|
|
| MD5 |
493f198777767dfe42209f052d2bf433
|
|
| BLAKE2b-256 |
929dab90f6e6242bbe3ae95a0e8dd94203f3282d8fdf3c027b6015523eb16005
|