@cyanheads/docgen-mcp-server
Render HTML/markdown to PDF, export rows to xlsx, and fill AcroForm PDFs via MCP. STDIO or Streamable HTTP.
4 Tools โข 1 Resource
Overview
Document rendering built on a bundled stack โ pdf-lib for PDF and AcroForm fill, exceljs for spreadsheets, marked for markdown. Render HTML, markdown, or template data to PDF, export tabular rows to xlsx, and fill AcroForm PDF forms from any MCP client. Runs as a stdio process or a local Streamable HTTP server.
| Tool | Description |
|---|
docgen_render_pdf | Render HTML, markdown, or a {{key}} template + data object to a downloadable PDF |
docgen_export_spreadsheet | Render one or more named worksheets of row objects to a downloadable .xlsx workbook |
docgen_fill_form | Fill the AcroForm fields of a supplied PDF (base64 or https URL) and optionally flatten it |
docgen_get_document | Re-fetch a previously rendered document by the id a render/export/fill tool returned |
Resources
| Resource | Description |
|---|
docgen://document/{documentId} | A rendered document by id โ raw bytes as a blob plus a JSON metadata block |
All document data is also reachable via the tool surface โ docgen_get_document is the tool-only twin of this resource.
Capability reference
- Provide exactly one
source: { html } (raw HTML, recommended), { markdown } (converted to HTML), or { template, data } (a {{key}} template filled from a data object)
pageOptions sets size (A4 / Letter / Legal / A3 / A5, default Letter), orientation (default portrait), per-side margin as CSS lengths ("10mm", "0.5in", "72pt"), header/footer text supporting {{page}} / {{total}} / {{date}} tokens, and pageNumbers
- The lightweight engine renders structured layout (headings, paragraphs, lists, tables) but not arbitrary CSS, images, or scripts โ sets
degraded: true in the enrichment when unsupported styling is dropped
- Returns a
DocumentEnvelope with pageCount
- Typed failures:
invalid_source, template_render_failed, document_too_large, render_timeout
- Each entry in
sheets[] is a worksheet name (1โ31 chars, unique case-insensitively, no * ? : \ / [ ], no leading/trailing apostrophe) plus a rows[] array of property โ scalar objects
- Optional
columns[] sets header label, value type (string / number / date / boolean), width, and an Excel number/date format string; omitted columns derive from the first row's keys
- An empty
rows[] yields a header-only sheet; an empty sheets[] is rejected as empty_workbook
- Returns a
DocumentEnvelope with sheetCount
- Typed failures:
empty_workbook, invalid_sheet_name, document_too_large, render_timeout
- Provide the source PDF as exactly one of
{ base64 } (whitespace and an optional data:application/pdf;base64, prefix tolerated) or { url } โ an https URL fetched behind an SSRF guard that resolves DNS, blocks private/loopback/link-local destinations, re-validates every redirect hop, and requires application/pdf
fields is an AcroForm field name โ value map; names are case-sensitive and must match the PDF's internal field names exactly
- Names with no AcroForm counterpart come back in
unmatchedFields[] instead of failing the call
flatten: true bakes the values in so the result is no longer editable (default false)
- AcroForm only โ a flat or XFA-based PDF returns
not_a_form
- Returns a
DocumentEnvelope with pageCount, plus unmatchedFields[]
documentId must match doc_ followed by 24 url-safe characters โ the format returned by docgen_render_pdf, docgen_export_spreadsheet, or docgen_fill_form; not guessable or constructible
- Pure read โ re-fetches the same
DocumentEnvelope, useful when an earlier response omitted inlineBase64 (over the inline threshold)
- An expired or unknown id returns
document_expired; ids are single-render and not reusable
docgen://document/{documentId} resource
documentId format: doc_ followed by 24 url-safe characters, obtained from a docgen render/export/fill tool result
- Returns two content items: the raw bytes as a
blob (real mime type โ PDF or xlsx) plus a JSON metadata block (documentId, byteSize, pageCount/sheetCount when applicable, createdAt, ttlSecondsRemaining)
- Reads the same tenant-scoped store as
docgen_get_document and never re-renders
- An expired or unknown id returns
document_expired
Features
Built on @cyanheads/mcp-ts-core: stdio and Streamable HTTP transports, pluggable auth (none / jwt / oauth), swappable storage (in-memory, filesystem, Supabase, Cloudflare KV/R2/D1), structured logging with optional OpenTelemetry tracing.
docgen-specific:
- No external API โ a bundled rendering stack (
pdf-lib, exceljs, marked), so renders are local and deterministic with no upstream to fail
- One shared
DocumentEnvelope across all four tools โ the three writers and the reader are interchangeable to the agent, and the resource-URI vs. inline-base64 delivery decision lives in one place
- Bounded renders โ a per-document byte ceiling (
DOCGEN_MAX_DOCUMENT_BYTES) and a wall-clock timeout (DOCGEN_RENDER_TIMEOUT_MS) turn a runaway render into a typed, recoverable error instead of a hang
- Tenant-scoped, TTL-bounded storage โ a document id minted for one tenant resolves only for that tenant; outputs are downloads, not records, so they expire rather than accumulate
- SSRF-guarded form fetch โ
docgen_fill_form with a URL source resolves DNS and checks the destination IP before fetching, blocking private/loopback/link-local ranges
Agent-friendly output:
- Dual-surface delivery โ every envelope field lands in both
structuredContent and the format() markdown twin, so tool-only and resource-only clients both see the documentId, resource URI, inline-availability status, size, and TTL
- Inline-vs-resource by size โ
inlineBase64 is populated only at or under DOCGEN_INLINE_MAX_BYTES, so a large workbook isn't base64-inlined into a tool result; above the threshold, delivery is via the resource URI
- Partial-fill reporting โ
docgen_fill_form returns unmatchedFields[] so the agent learns which field names didn't land and can correct and re-render rather than assuming a clean fill
- Typed error contract with recovery hints โ each tool declares its failure surface (
invalid_source, template_render_failed, document_too_large, render_timeout, not_a_form, source_unfetchable, document_expired, โฆ) with actionable next-step text
Getting started
Add the following to your MCP client configuration file. No API keys are required.
{
"mcpServers": {
"docgen-mcp-server": {
"type": "stdio",
"command": "bunx",
"args": ["@cyanheads/docgen-mcp-server@latest"],
"env": {
"MCP_TRANSPORT_TYPE": "stdio",
"MCP_LOG_LEVEL": "info"
}
}
}
}
Or with npx (no Bun required):
{
"mcpServers": {
"docgen-mcp-server": {
"type": "stdio",
"command": "npx",
"args": ["-y", "@cyanheads/docgen-mcp-server@latest"],
"env": {
"MCP_TRANSPORT_TYPE": "stdio",
"MCP_LOG_LEVEL": "info"
}
}
}
}
Or with Docker:
{
"mcpServers": {
"docgen-mcp-server": {
"type": "stdio",
"command": "docker",
"args": [
"run", "-i", "--rm",
"-e", "MCP_TRANSPORT_TYPE=stdio",
"ghcr.io/cyanheads/docgen-mcp-server:latest"
]
}
}
}
For Streamable HTTP, set the transport and start the server:
MCP_TRANSPORT_TYPE=http MCP_HTTP_PORT=3010 bun run start:http
Documents are delivered by the docgen://document/{id} resource (and inline base64 when small enough) over every transport. The envelope's downloadUrl field is reserved for a future HTTP download route and is not emitted in this version.
Prerequisites
Installation
- Clone the repository:
git clone https://github.com/cyanheads/docgen-mcp-server.git
- Navigate into the directory:
- Install dependencies:
- Configure environment:
Configuration
All configuration is optional โ docgen runs with no required environment variables.
| Variable | Description | Default |
|---|
DOCGEN_DOCUMENT_TTL_SECONDS | How long a rendered document is retrievable before it expires, in seconds. | 900 |
DOCGEN_MAX_DOCUMENT_BYTES | Hard ceiling on a single rendered artifact in bytes; exceeding it aborts the render. | 26214400 |
DOCGEN_RENDER_TIMEOUT_MS | Per-render wall-clock budget in milliseconds; exceeding it aborts the render. | 30000 |
DOCGEN_INLINE_MAX_BYTES | Artifacts at or under this byte size are returned inline as base64; larger ones omit it. | 5242880 |
DOCGEN_PDF_ENGINE | PDF rendering engine. Only lightweight is implemented; chromium is reserved and rejected at startup. | lightweight |
MCP_TRANSPORT_TYPE | Transport: stdio or http. | stdio |
MCP_HTTP_PORT | Port for the HTTP server. | 3010 |
MCP_SESSION_MODE | HTTP session posture: auto, stateful, or stateless. docgen declares stateless in code, since no tool asks for input mid-handler and documents live in tenant-scoped storage rather than the session store. The env var overrides it when set; the framework's auto default resolves to stateful. | stateless |
MCP_AUTH_MODE | Auth mode: none, jwt, or oauth. | none |
MCP_PUBLIC_URL | Public origin behind a TLS proxy. (The downloadUrl envelope field is reserved for a future HTTP download route and is not emitted in this version.) | โ |
MCP_LOG_LEVEL | Log level (RFC 5424). | info |
STORAGE_PROVIDER_TYPE | Storage backend for document bytes + metadata. | in-memory |
OTEL_ENABLED | Enable OpenTelemetry instrumentation (spans, metrics, completion logs). | false |
See .env.example for the full list of optional overrides.
Documents are stored in ctx.state, which the in-memory provider keeps in process memory โ a restart drops every stored document, and an id minted before the restart returns document_expired. This is intended (outputs are downloads, not records); for durable retention across restarts, point STORAGE_PROVIDER_TYPE at a persistent backend.
Running the server
Local development
-
Build and run:
bun run rebuild
bun run start:stdio
bun run start:http
-
Run checks and tests:
bun run devcheck
bun run test
bun run lint:mcp
Docker
docker build -t docgen-mcp-server .
docker run --rm -e MCP_TRANSPORT_TYPE=http -p 3010:3010 docgen-mcp-server
The Dockerfile defaults to HTTP transport, stateless session mode, and logs to /var/log/docgen-mcp-server. OpenTelemetry peer dependencies are installed by default โ build with --build-arg OTEL_ENABLED=false to omit them.
Project structure
| Directory | Purpose |
|---|
src/index.ts | createApp() entry point โ registers the tools/resource and inits the render + storage services. |
src/config | Server-specific environment variable parsing and validation with Zod. |
src/mcp-server/tools | Tool definitions (*.tool.ts). |
src/mcp-server/resources | Resource definitions (*.resource.ts). |
src/services/document | The rendering stack (RenderService) and artifact store (DocumentStore), shared types, and the SSRF fetch guard. |
tests/ | Unit and integration tests mirroring src/. |
Development guide
See CLAUDE.md/AGENTS.md for development guidelines and architectural rules. The short version:
- Handlers throw, framework catches โ no
try/catch in tool logic
- Use
ctx.log for request-scoped logging, ctx.state for tenant-scoped storage
- Register new tools and resources in
src/index.ts's createApp() arrays
- One shared
DocumentEnvelope across all delivery tools โ keep the writers and reader interchangeable
Contributing
Issues are welcome. Run checks and tests before submitting:
bun run devcheck
bun run test
License
Apache-2.0 โ see LICENSE for details.