reportflow-mcp
An MCP (Model Context Protocol) server that turns your ReportFlow templates into PDF reports — invoices, contracts, statements, anything you've designed —…
Что умеет
- Get Design Parameters: デザインテンプレートのパラメータ構造を取得します。帳票生成に必要なパラメータの型・構造を確認できます。
- List Templates: ワークスペース内のデザイン一覧を取得します。各デザインのID・名称・最新バージョン・サムネイルURLを返します。取得したidをdesignIdとしてPDF生成ツールやget_design_parametersに使用します。
- Generate Pdf Sync: デザインIDとパラメータを指定してPDFを生成します。応答にダウンロード URL が含まれるため、本ツール 1 回の呼び出しで結果提示が完結します (別途ダウンロード用ツールを呼ぶ必要はありません)。 - stdio モード (Claude Desktop / Code): ローカルに保存し絶対パスも返します。outputDir で保存先を指定できます (未指
Какие данные видит
Нужен ли аккаунт
Не нужен: сервер работает без входа
An MCP (Model Context Protocol) server that turns your ReportFlow templates into PDF reports — invoices, contracts, statements, anything you've designed — straight from Claude or any other MCP-compatible AI agent.
What it does Generate PDFs from natural-language requests like "create an invoice for Acme Corp totalling $300"
Expose your ReportFlow designs and their parameter schemas directly to the AI as MCP Resources
Bulk-generate many PDFs and download them as a single ZIP
Save outputs to whichever workspace folder the user is currently in (Claude Desktop / Claude Code / Cursor / VS Code all supported)
Setup Claude Desktop / Claude Code / Cursor Add the following to your config file (.mcp.json, claude_desktop_config.json, ~/.cursor/mcp.json, etc.):
{ "mcpServers": { "reportflow": { "command": "npx", "args": ["-y", "reportflow-mcp"] } } }
That's the whole setup. No env vars, no API keys, no secrets to manage.
VS Code (MCP-enabled builds) Same JSON in .vscode/mcp.json.
Requirements Node.js 18+ (auto-fetched by npx)
A local environment with a browser (only required during the first login)
A ReportFlow account
Usage
- First-run authentication After reloading the MCP client, ask the AI:
Authenticate with ReportFlow
A browser window opens. Sign in → pick a workspace → consent, and you're done. Tokens are stored in your OS keychain (macOS Keychain / Windows Credential Manager / Linux libsecret) and refreshed automatically.
- Generate a PDF Natural language (easiest) Using the invoice template, create a PDF for Acme Corp totalling $330.
The AI will look up the template via list_templates, fetch its parameter schema with get_design_parameters, fill in the values, and call generate_pdf_sync — returning a local file path.
Slash commands Command
Purpose
/generate_pdf
Step-by-step recipe for a single PDF
/generate_pdfs
Recipe for batch PDF generation
/reportflow_help
Quick feature tour
- Where files are saved Output location is resolved in this order:
Explicit instruction from the user (e.g. "save to my Desktop")
The currently-open workspace root (Claude Code / Cursor / VS Code)
The OS temp directory as fallback
Reference Tools (called by the AI) Tool
Purpose
authenticate
First-time / re-authentication
list_templates
List available designs
get_design_parameters
Fetch the parameter schema for a design
generate_pdf_sync / _async
Generate one PDF (sync returns path; async returns request ID)
generate_pdfs_sync / _async
Generate many PDFs (returns a ZIP)
download_file / download_zip
Download artifacts produced by async tools
suggest_params
Translate a natural-language brief into a params JSON via MCP Sampling (requires a Sampling-capable client)
Resources (attachable as AI context) URI
Contents
reportflow://designs
List of available designs
reportflow://designs/{designId}/parameters
Parameter schema for one design
reportflow://errors
Catalog of error messages from the Content Service
reportflow://server-info
Server feature overview
Prompts (slash-command recipe cards) /generate_pdf, /generate_pdfs, /reportflow_help — pass arguments and the AI follows the prepared workflow.
Troubleshooting Symptom
Fix
Error containing re-authentication required
Ask the AI: "re-authenticate with ReportFlow"
npx cannot find the package
npm cache clean --force then retry
No keychain available on Linux
Falls back automatically to a chmod-0600 file under $XDG_STATE_HOME/reportflow-mcp/
Browser cannot open over SSH / remote shell
Authenticate once on a local machine; afterwards the cached token works on remote hosts
License MIT — see LICENSE.
Links ReportFlow: https://re-port-flow.com
npm: https://www.npmjs.com/package/reportflow-mcp
Issues: https://github.com/re-port-flow/reportflow-mcp/issues
Список инструментов сервера (5)
Технические названия из tools/list. Нужны только разработчикам.
| get_design_parameters | デザインテンプレートのパラメータ構造を取得します。帳票生成に必要なパラメータの型・構造を確認できます。 |
| list_templates | ワークスペース内のデザイン一覧を取得します。各デザインのID・名称・最新バージョン・サムネイルURLを返します。取得したidをdesignIdとしてPDF生成ツールやget_design_parametersに使用します。 |
| generate_pdf_sync | デザインIDとパラメータを指定してPDFを生成します。応答にダウンロード URL が含まれるため、本ツール 1 回の呼び出しで結果提示が完結します (別途ダウンロード用ツールを呼ぶ必要はありません)。 - stdio モード (Claude Desktop / Code): ローカルに保存し絶対パスも返します。outputDir で保存先を指定できます (未指定時はクライアントのワークスペース Roots または OS 一時ディレクトリ)。 - HTTP モード (claude.ai / n8n 等): サーバー側には保存しません。includePreview=true を指定すると inline preview 用のバイナリも併せて返します (claude.ai が PDF preview をサポートしていない現状ではデフォルト false 推奨)。 【重要】呼び出し前に必ず get_design_parameters でデザインの必要パラメータ構造を確認し、ユーザーから必要な値を聞き出すこと。プレースホルダー値・架空の値を勝手に生成しないこと。 |
| generate_pdfs_async | 複数のパラメータセットでPDFを一括非同期生成します。即座にrequestIdとfiles情報を返します。ZIPダウンロードはdownload_zipツールを使用してください。 【重要】呼び出し前に必ず get_design_parameters でデザインの必要パラメータ構造を確認し、ユーザーから必要な値を聞き出すこと。ユーザーが指定していないパラメータがある場合は、本ツールを呼ぶ前にユーザーに必ず確認すること。プレースホルダー値・架空の値を勝手に生成しないこと。パラメータが一切提供されていない場合も、まずユーザーに値を尋ねること。 |
| suggest_params | 自然文の要件と designId からクライアント AI(Sampling)を使って generate_pdf_sync の params JSON を組み立てます。サーバー側 API キー不要。Sampling 未対応クライアントでは利用不可です。生成された params は内容確認のうえユーザーの承認を得てから generate_pdf_sync に渡してください。 |