Re:portFlow
OfficialRe:port Flow MCP
Nombre oficial para mostrar: Re:port Flow MCP. Identificador de paquete e implementación: reportflow-mcp. Alias de búsqueda heredados: ReportFlow MCP Server y ReportFlow.
Visión general
Un servidor MCP (Model Context Protocol) que convierte tus plantillas de Re:port Flow en informes PDF (facturas, contratos, extractos, lo que hayas diseñado) directamente desde Claude o cualquier otro agente de IA compatible con MCP.
Related MCP server: PDF Tools AI MCP
Características
Genera PDFs a partir de solicitudes en lenguaje natural como "crea una factura para Acme Corp por un total de 300 $"
Expone tus diseños de Re:port Flow y sus esquemas de parámetros directamente a la IA como Resources de MCP.
Genera muchos PDFs por lotes y descárgalos como un único ZIP.
Guarda los resultados en la carpeta del espacio de trabajo en la que se encuentre el usuario (compatible con Claude Desktop / Claude Code / Cursor / VS Code).
Configuración
Re:port Flow MCP funciona de dos maneras: elige la que se adapte a tu cliente.
Servidor remoto (claude.ai / clientes web) — Streamable HTTP
Añade Re:port Flow como conector personalizado que apunte al endpoint alojado:
https://mcp.re-port-flow.com/mcpEn Claude (claude.ai) ve a Configuración → Conectores → Añadir conector personalizado y pega la URL anterior. La autenticación se gestiona en la aplicación mediante OAuth (consulta Autenticación): no hay que instalar nada localmente.
Servidor local (Claude Desktop / Claude Code / Cursor) — stdio mediante npx
Añade lo siguiente a tu archivo de configuración (.mcp.json, claude_desktop_config.json, ~/.cursor/mcp.json, etc.):
{
"mcpServers": {
"reportflow": {
"command": "npx",
"args": ["-y", "reportflow-mcp"]
}
}
}Eso es todo el proceso. No hay variables de entorno, claves de API ni secretos que gestionar.
VS Code (versiones con MCP habilitado)
El mismo JSON en .vscode/mcp.json.
Requisitos
Remoto: un cliente MCP que admita conectores HTTP personalizados (p. ej., claude.ai). Sin instalación local.
Local (stdio): Node.js 22+ (descargado automáticamente por
npx) y un navegador disponible durante el primer inicio de sesión.Una cuenta de Re:port Flow (en cualquiera de los dos casos).
Revisiones de protocolo compatibles
Ambos transportes (stdio / Streamable HTTP) sirven dos generaciones del protocolo MCP desde un único endpoint:
2026-07-28(actual): protocolo sin estado por solicitud. Los clientes modernos lo descubren medianteserver/discover; no hay cabecera de sesión, las solicitudes llevan su versión de protocolo en_meta.Revisiones de la era 2025 (
2025-11-25,2025-06-18,2025-03-26,2024-11-05,2024-10-07): handshake clásicoinitialize, conservado por compatibilidad con clientes existentes (Claude Desktop, conectores personalizados de claude.ai, Cursor, ChatGPT, n8n, …).
La selección de versión es automática en ambos transportes: los clientes modernos sondean con server/discover, los clientes heredados siguen enviando initialize; no se requiere configuración en ninguno de los dos lados, y las conexiones existentes siguen funcionando sin cambios.
Autenticación
Remoto (claude.ai)
Cuando añades el conector, Claude ejecuta el flujo OAuth por ti: Iniciar sesión → elegir un espacio de trabajo → consentir. Los tokens los conserva el cliente: no hay que gestionar ningún llavero local ni paso de navegador.
Local (stdio)
Después de recargar el cliente MCP, pídele a la IA:
Autentícate con Re:port Flow
Se abre una ventana del navegador. Inicia sesión → elige un espacio de trabajo → acepta, y listo. Los tokens se almacenan en el llavero del sistema operativo (Llavero de macOS / Administrador de credenciales de Windows / libsecret de Linux), con un respaldo de archivo con chmod-0600, y se renuevan automáticamente.
Ejemplos de uso
Cada ejemplo siguiente es un prompt que puedes pegar tal cual; la IA elige las herramientas adecuadas.
1. Generar un único PDF (lista → esquema → generar)
Usando la plantilla de factura, crea un PDF para Acme Corp por un total de $330.
La IA lista los diseños con list_templates, obtiene el esquema de parámetros con get_design_parameters, rellena los valores y llama a generate_pdf_sync.
Remoto: devuelve una URL de descarga (
fileUrl).Local: además guarda el archivo y devuelve su ruta absoluta.
2. Generar muchos PDFs por lotes
A partir de la plantilla de extracto, genera un PDF por cliente (Acme $100, Globex $250, Initech $80) y entrégamelos juntos.
Local (stdio):
generate_pdfs_syncescribe un único ZIP en tu espacio de trabajo.Remoto:
generate_pdfs_asyncejecuta el lote y devuelve un id de solicitud más una URL de descarga.
3. Generación asíncrona y descarga posterior (local)
Pon en marcha el PDF del contrato en segundo plano y descárgalo cuando esté listo.
La IA llama a generate_pdf_async (devuelve un requestId inmediatamente) y después a download_file para guardar el PDF terminado. El equivalente por lotes es generate_pdfs_async → download_zip. Estas herramientas de descarga son solo para stdio; en el servidor remoto, las herramientas síncronas/asíncronas ya devuelven un fileUrl.
Consejo — parámetros en lenguaje natural: en un cliente compatible con Sampling puedes pedir "redacta los parámetros para una factura de $1,000 a A社" y la IA llamará a
suggest_paramspara convertir el resumen en un objetoparamsválido antes de generar.
4. Empezar sin plantillas (galería → copiar → generar)
Aún no tengo ninguna plantilla: crea un PDF de factura para Acme Corp.
Cuando list_templates está vacía, la IA busca en la galería pública de plantillas con search_gallery_templates, te muestra los candidatos, copia tu elección en tu espacio de trabajo con copy_gallery_template y luego continúa con el flujo normal (get_design_parameters → generate_pdf_sync). La copia siempre va al espacio de trabajo que seleccionaste en la pantalla de consentimiento de OAuth: la IA no puede apuntar a ningún otro espacio de trabajo.
Comandos de barra
Comando | Propósito |
| Receta paso a paso para un único PDF |
| Receta para la generación de PDFs por lotes |
| Visita rápida por las funciones |
Dónde se guardan los archivos (modo local)
La ubicación de salida se resuelve en este orden:
Instrucción explícita del usuario (p. ej., "guárdalo en mi escritorio")
La raíz del espacio de trabajo actualmente abierto (Claude Code / Cursor / VS Code)
El directorio temporal del sistema operativo como respaldo
Referencia
Herramientas (llamadas por la IA)
Herramienta | Propósito |
| Autenticación inicial / reautenticación |
| Lista los diseños disponibles |
| Obtiene el esquema de parámetros de un diseño |
| Genera un PDF (sync devuelve la ruta; async devuelve el ID de solicitud) |
| Genera varios PDF (devuelve un ZIP) |
| Descarga los artefactos generados por las herramientas async |
| Traduce un resumen en lenguaje natural a un JSON |
| Herramientas de convención del conector ChatGPT (argumento de una sola cadena), mundo cerrado ( |
| Busca en la galería pública de plantillas (sin necesidad de autenticación) por palabra clave/categoría. Devuelve plantillas candidatas que aún no están en tu espacio de trabajo; su |
| Obtiene los detalles completos de una plantilla pública de la galería por |
| Herramienta de escritura. Copia una plantilla de la galería al espacio de trabajo que autorizaste (el espacio de trabajo de destino lo fija tu token de acceso y no se puede pasar como argumento). Devuelve |
Recursos (adjuntables como contexto de IA)
URI | Contenido |
| Lista de diseños disponibles |
| Esquema de parámetros de un diseño |
| Catálogo de mensajes de error del Content Service |
| Visión general de las funciones del servidor |
Prompts (tarjetas de recetas de comandos slash)
/generate_pdf, /generate_pdfs, /reportflow_help — pasa los argumentos y la IA sigue el flujo de trabajo preparado.
Solución de problemas
Síntoma | Solución |
Error que contiene | Pídele a la IA: "vuelve a autenticarte con Re:port Flow" |
| Ejecuta |
No hay llavero disponible en Linux | Recurre automáticamente a un archivo chmod-0600 en |
El navegador no puede abrirse a través de SSH / shell remoto | Autentícate una vez en una máquina local; después, el token en caché funciona en hosts remotos |
Privacidad
Re:port Flow MCP es un cliente ligero: reenvía tus solicitudes a tu propia
cuenta de Re:port Flow y devuelve los PDF generados. No vende ni comparte
tus datos con terceros. Los tokens de autenticación se almacenan localmente (llavero
del sistema operativo, o un archivo de respaldo chmod-0600) y se envían solo a los servicios propios de Re:port Flow —
durante el inicio de sesión OAuth y como credencial Bearer en cada
llamada API autenticada (listado de plantillas, generación o descarga de PDFs).
Nunca se comparten con terceros.
Para conocer la política de privacidad completa — qué se recopila, durante cuánto tiempo se conserva y cómo se gestiona — consulta: lp.re-port-flow.com
Seguridad
El endpoint alojado valida la cabecera Host (protección contra el rebinding de DNS) y
rechaza las cabeceras Origin estructuralmente inválidas con 403 Forbidden, según los
requisitos de seguridad de la especificación MCP Streamable HTTP. La autenticación es
solo mediante token Bearer — sin cookies, y CORS nunca permite credenciales. La política
completa y su modelo de amenazas están documentados en
docs/security.md (japonés).
Soporte
¿Necesitas ayuda, has encontrado un error o tienes alguna pregunta sobre la revisión de directorios?
Re:port Flow (privacidad y soporte): https://lp.re-port-flow.com
GitHub Issues: https://github.com/re-port-flow/reportflow-mcp/issues
Licencia
MIT — consulta LICENSE.
Enlaces
Re:port Flow: https://re-port-flow.com
Privacidad y soporte: https://lp.re-port-flow.com
Issues: https://github.com/re-port-flow/reportflow-mcp/issues
Available Tools
10 toolsauthenticateAInspect
ReportFlow への OAuth2 認証を行います。ブラウザが起動し、ログイン・ワークスペース選択・consent を経てトークンを keychain (または XDG file) に保存します。他のツールが認証エラーを返したら、まずこのツールを呼んでください。force=true で既存トークンを破棄して再認証します。
| Name | Required | Description | Default |
|---|---|---|---|
| force | No | 既存トークンを破棄して再認証する場合 true |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Describes the full authentication flow (browser launch, login, workspace selection, consent, token storage) and aligns with annotations (destructiveHint=false, openWorldHint=true). Adds valuable behavioral context beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences front-loading the main action, with no wasted words. Efficiently structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple one-parameter tool with no output schema, the description fully covers the authentication process, usage context, and parameter behavior. Complete and sufficient.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the description's mention of force parameter essentially paraphrases the schema's description. Minimal additional value beyond what schema provides.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the tool performs OAuth2 authentication to ReportFlow, including browser launch, token storage, and distinct action from siblings which handle downloads and PDF generation.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly instructs to call this tool first when other tools return authentication errors, and explains when to use force=true for re-authentication. Provides clear context for usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
download_fileAIdempotentInspect
generate_pdf_asyncで生成した単一PDFファイルをダウンロードします。requestIdとfileIdを指定し、ローカルファイルパスを返します。outputDir を指定するとそのディレクトリに、未指定の場合は現在の作業ディレクトリに保存します。
| Name | Required | Description | Default |
|---|---|---|---|
| requestId | Yes | generate_pdf_asyncで返されたrequestId(UUID) | |
| fileId | Yes | generate_pdf_asyncのfiles[].fileId | |
| fileName | No | 保存ファイル名(省略時はfileId.pdf) | |
| outputDir | No | 出力先ディレクトリ (相対/絶対)。未指定時はクライアントのワークスペース (Roots) または現在の作業ディレクトリに保存。ユーザーが場所を指定した場合のみセットすること。 |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description discloses that files are saved locally, returns the file path, and handles directory selection. Annotations already indicate idempotency, and the description adds context about default behavior. No contradictions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the action, no extraneous information. Efficient and complete.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the prerequisite, parameters, output, and directory behavior. No output schema needed; the return value is explained. Complete given the tool's complexity.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds value by explaining the default directory behavior (current working directory) not present in schema. All 4 parameters are well-covered.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool downloads a single PDF file generated by generate_pdf_async, specifying the required parameters and return value. It distinguishes from the sibling download_zip.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explains that this tool is used after generate_pdf_async and describes the optional outputDir. It does not explicitly exclude cases where download_zip might be preferred, but provides clear context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
download_zipAIdempotentInspect
generate_pdfs_asyncで生成したZIPファイルをダウンロードします。requestIdを指定し、ローカルのZIPファイルパスを返します。outputDir を指定するとそのディレクトリに、未指定の場合は現在の作業ディレクトリに保存します。
| Name | Required | Description | Default |
|---|---|---|---|
| requestId | Yes | generate_pdfs_asyncで返されたrequestId(UUID) | |
| fileName | No | 保存ファイル名(省略時はrequestId.zip) | |
| outputDir | No | 出力先ディレクトリ (相対/絶対)。未指定時はクライアントのワークスペース (Roots) または現在の作業ディレクトリに保存。ユーザーが場所を指定した場合のみセットすること。 |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide idempotentHint=true and non-destructive nature. The description adds that it saves to a directory and returns a local path, which is useful but not extensive. No contradictions.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the action, no unnecessary words. Every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple download tool, the description covers how to use it, what to specify, and what it returns. No output schema, but the return is implied. Could mention that it overwrites existing files, but not essential.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds context beyond schema: it explains the behavior of outputDir (saves to current directory if unspecified). This adds value, though fileName is not mentioned.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool downloads a ZIP file generated by generate_pdfs_async, specifies requestId, and returns a local path. This distinguishes it from siblings like download_file.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description ties the tool to a specific prior tool (generate_pdfs_async), giving clear context. However, it does not explicitly mention when not to use or list alternatives beyond that association.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_pdf_asyncAInspect
デザインIDとパラメータを指定してPDFを非同期生成します。即座にrequestIdとfiles情報を返します。ファイルのダウンロードはdownload_fileツールを使用してください。
【重要】呼び出し前に必ず get_design_parameters でデザインの必要パラメータ構造を確認し、ユーザーから必要な値を聞き出すこと。ユーザーが指定していないパラメータがある場合は、本ツールを呼ぶ前にユーザーに必ず確認すること。プレースホルダー値・架空の値を勝手に生成しないこと。パラメータが一切提供されていない場合も、まずユーザーに値を尋ねること。
| Name | Required | Description | Default |
|---|---|---|---|
| designId | Yes | デザインID(UUID形式) | |
| version | Yes | デザインバージョン番号 | |
| content | Yes | PDF生成コンテンツ |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations are minimal (readOnlyHint false, etc.). Description adds that it's async and returns immediately, but lacks details on side effects, idempotency, or error behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two efficient paragraphs: first states purpose, second gives critical usage guidelines. No redundancy, front-loaded with key info.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Returns requestId and files info are mentioned but not detailed. No output schema, so description could elaborate further on response format or error handling. Links to download_file and get_design_parameters partially compensates.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers all parameters with detailed descriptions. Description adds crucial guidance to check parameter structure with get_design_parameters, adding value beyond schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the tool asynchronously generates PDF with design ID and parameters, returns requestId and files info, and distinguishes from sibling tools like download_file and synchronous variants.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Provides explicit pre-conditions: must call get_design_parameters, ask user for missing values, avoid placeholder values. Does not mention alternative generation tools (synchronous, batch) that could be compared.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_pdfs_asyncAInspect
複数のパラメータセットでPDFを一括非同期生成します。即座にrequestIdとfiles情報を返します。ZIPダウンロードはdownload_zipツールを使用してください。
【重要】呼び出し前に必ず get_design_parameters でデザインの必要パラメータ構造を確認し、ユーザーから必要な値を聞き出すこと。ユーザーが指定していないパラメータがある場合は、本ツールを呼ぶ前にユーザーに必ず確認すること。プレースホルダー値・架空の値を勝手に生成しないこと。パラメータが一切提供されていない場合も、まずユーザーに値を尋ねること。
| Name | Required | Description | Default |
|---|---|---|---|
| designId | Yes | デザインID(UUID形式) | |
| version | Yes | デザインバージョン番号 | |
| contents | Yes | PDF生成コンテンツの配列(複数ファイル) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already indicate readOnlyHint=false (write operation) and destructiveHint=false. The description adds behavioral context: 'Immediately returns requestId and files information,' clarifying the async nature and immediate response. It does not contradict annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is concise, front-loaded with the primary function, and contains no unnecessary words. The important warning section is separate and clearly marked. Every sentence adds value.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given the tool's complexity (multiple PDFs async), the description covers key aspects: async behavior, immediate return, prerequisite steps, and referral to another tool for ZIP. It lacks detail on the response structure beyond 'requestId and files information,' but this is adequate given no output schema. Annotations and schema fill remaining gaps.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, so baseline is 3. The description adds value beyond the schema by explaining that the 'params' field should be structured based on get_design_parameters, and it highlights the required 'fileName' and 'params' fields. This guidance is crucial for correct parameter usage.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose: 'Generates multiple PDFs asynchronously with multiple parameter sets.' It specifies the verb 'generate', the resource 'multiple PDFs', and the asynchronous mode. It also distinguishes from siblings by explicitly mentioning the download_zip tool for ZIP downloads and implying sync versions exist.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides explicit usage guidelines: before calling, use get_design_parameters to check required parameters, ask the user for missing values, and never generate placeholders. It also directs the user to download_zip for ZIP downloads, offering clear when-to-use versus alternative tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_pdfs_syncAInspect
複数のパラメータセットでPDFを一括同期生成し、ZIPファイルとして返します。生成完了後にZIPファイルのローカルパスを返します。outputDir を指定するとそのディレクトリに、未指定の場合はクライアントのワークスペース (Roots) または OS 一時ディレクトリに保存します。zipFileName で出力 ZIP のファイル名を指定可能 (デフォルト download.zip)。
【重要】呼び出し前に必ず get_design_parameters でデザインの必要パラメータ構造を確認し、ユーザーから必要な値を聞き出すこと。ユーザーが指定していないパラメータがある場合は、本ツールを呼ぶ前にユーザーに必ず確認すること。プレースホルダー値・架空の値を勝手に生成しないこと。パラメータが一切提供されていない場合も、まずユーザーに値を尋ねること。
| Name | Required | Description | Default |
|---|---|---|---|
| designId | Yes | デザインID(UUID形式) | |
| version | Yes | デザインバージョン番号 | |
| contents | Yes | PDF生成コンテンツの配列(複数ファイル) | |
| outputDir | No | 出力先ディレクトリ (相対/絶対)。未指定時はクライアントのワークスペース (Roots) または現在の作業ディレクトリに保存。ユーザーが場所を指定した場合のみセットすること。 | |
| zipFileName | No | 出力 ZIP のファイル名 (省略時は download.zip) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond annotations (readOnlyHint=false, destructiveHint=false), the description details synchronous generation, local path return, output directory logic, and shareType mapping. It also warns about not fabricating parameter values, adding behavioral context.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two paragraphs: first explains functionality and output, second is an important usage note. Every sentence adds value, no redundancy, key information is front-loaded.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers the tool's core purpose, requirements, output, and configuration options. It could mention potential limitations like file size or error handling, but for its complexity it is sufficiently complete.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but the description adds value by explaining shareType codes and their response mapping, default output directory behavior, and that 'params' should be obtained via get_design_parameters. This goes beyond the raw schema definitions.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description explicitly states the tool generates multiple PDFs synchronously from parameter sets and returns a ZIP file. It distinguishes from siblings like generate_pdf_sync (single) and generate_pdfs_async (async) by specifying '一括同期生成' (batch sync generation).
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear prerequisites: always call get_design_parameters first and ask the user for missing values. It warns against using placeholder values. However, it does not explicitly contrast with async tools or state when NOT to use this tool.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
generate_pdf_syncAInspect
デザイン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 でデザインの必要パラメータ構造を確認し、ユーザーから必要な値を聞き出すこと。プレースホルダー値・架空の値を勝手に生成しないこと。
| Name | Required | Description | Default |
|---|---|---|---|
| designId | Yes | デザインID(UUID形式) | |
| version | Yes | デザインバージョン番号 | |
| content | Yes | PDF生成コンテンツ | |
| outputDir | No | 出力先ディレクトリ (相対/絶対)。未指定時はクライアントのワークスペース (Roots) または現在の作業ディレクトリに保存。ユーザーが場所を指定した場合のみセットすること。 | |
| includePreview | No | true 指定時のみ EmbeddedResource (application/pdf, base64 blob) を応答に含める。claude.ai は現状 PDF resource を inline 表示しないため、通常は省略 (false) で fileUrl のみを利用するのが効率的。 |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Description adds significant behavioral context beyond annotations: synchronous generation, download URL in response, local save for stdio, no server save for HTTP, optional inline preview. No contradictions with annotations (readOnlyHint=false, destructiveHint=false).
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Well-structured with bullet points for modes and warnings. Front-loaded key info. Slightly verbose but each part adds value. Could be marginally shorter but still effective.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Covers all aspects: pre-condition (check parameters), post-condition (download URL, local save), mode-specific details, parameter constraints. No output schema, but response description is sufficient. Comprehensive for a complex tool with nested object.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, but description adds critical context: outputDir default behavior, includePreview only when needed, params must come from get_design_parameters, shareType codes mapping. Enhances understanding beyond schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool generates a PDF synchronously with a download URL. It distinguishes from async siblings and download tools, and explains mode-specific behavior (stdio vs HTTP). The purpose is unambiguous.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Explicitly instructs to call get_design_parameters first, ask user for values, and avoid placeholder/fake data. Also provides when to use includePreview and outputDir. Differentiates from async tools and download tools.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
get_design_parametersARead-onlyIdempotentInspect
デザインテンプレートのパラメータ構造を取得します。帳票生成に必要なパラメータの型・構造を確認できます。
| Name | Required | Description | Default |
|---|---|---|---|
| designId | Yes | デザインID(UUID形式) | |
| version | No | バージョン番号(省略時は最新版) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already provide readOnlyHint and idempotentHint, so the description adds context about what specific information is retrieved (types/structures). No additional behavioral traits beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two concise sentences with front-loaded key information. No extraneous words.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a simple read-only tool with two parameters and comprehensive annotations, the description fully covers necessary context. No output schema needed as return is straightforward.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100% with clear descriptions for both parameters. Description does not add meaning beyond what the schema provides, so baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the tool retrieves parameter structure of design templates. It specifically uses verb 'get' and resource 'design template parameters', distinguishing it from sibling tools like generate_pdf_* or list_templates.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Implies usage for inspecting parameter structure before form generation, but does not explicitly state when to use or alternatives. No exclusions or when-not-to-use guidance.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
list_templatesARead-onlyIdempotentInspect
ワークスペース内のデザイン一覧を取得します。各デザインのID・名称・最新バージョン・サムネイルURLを返します。取得したidをdesignIdとしてPDF生成ツールやget_design_parametersに使用します。
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint and idempotentHint true, indicating safe, idempotent behavior. The description adds value by specifying the exact return fields (ID, name, version, thumbnail URL) and the purpose of the output, which is not covered by annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Description is extremely concise: two sentences, no filler. First sentence states the core function and output, second sentence provides usage guidance. Perfectly front-loaded and efficient.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no parameters and no output schema, the description fully covers what the tool does, what it returns, and how to use the result. No missing information for an agent to correctly invoke and utilize the tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Tool has zero parameters, so schema coverage is 100%. Baseline score of 4 applies as the description does not need to add parameter information.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
Description clearly states the tool retrieves a list of designs in the workspace and specifies the returned fields (ID, name, version, thumbnail URL). It also explains how to use the IDs with downstream tools, differentiating its purpose from siblings.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
Description explains that the obtained ID should be used as designId for PDF generation and get_design_parameters. It provides clear context for when to use the tool, though it does not explicitly list when not to use it or mention alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
suggest_paramsARead-onlyInspect
自然文の要件と designId からクライアント AI(Sampling)を使って generate_pdf_sync の params JSON を組み立てます。サーバー側 API キー不要。Sampling 未対応クライアントでは利用不可です。生成された params は内容確認のうえユーザーの承認を得てから generate_pdf_sync に渡してください。
| Name | Required | Description | Default |
|---|---|---|---|
| designId | Yes | デザインID(UUID形式) | |
| version | No | バージョン番号(省略時は最新版) | |
| description | Yes | 帳票の内容を自然文で記述(例: "請求書、宛先A社、合計1万円") |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations declare readOnlyHint=true. The description adds context about client-side AI (Sampling), no server API key needed, and the need for user approval, enhancing transparency beyond annotations.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single paragraph that conveys essential information efficiently, though it could be slightly more structured for easier parsing.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given no output schema, the description explains the output purpose. It covers prerequisites (Sampling), workflow (user approval), and usage context, making it fairly complete for a utility tool.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema covers all parameters with descriptions. The description does not add significant new semantics beyond implying description is natural language, so baseline score applies.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool assembles params JSON for generate_pdf_sync using natural language and designId via Sampling. It distinguishes from sibling tools like generate_pdf_sync and is specific about its role.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description explicitly states it is not usable on clients without Sampling support and instructs to get user approval before passing to generate_pdf_sync, providing clear usage context.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
10 tool updates
v0.1.0- First observed
authenticate - First observed
download_file - First observed
download_zip - First observed
generate_pdf_async - First observed
generate_pdf_sync - First observed
generate_pdfs_async - First observed
generate_pdfs_sync - First observed
get_design_parameters - First observed
list_templates - First observed
suggest_params
TDQS
Scored across 10 tools
Each tool has a clear, distinct purpose. Authentication is separate, sync vs async generators are clearly labeled, download tools are paired with async generators, and the helper tools (list_templates, get_design_parameters, suggest_params) are unique. No overlap.
All tool names follow a consistent verb_noun pattern in snake_case. Variations like generate_pdf_async vs generate_pdf_sync are systematic and predictable, making it easy to understand the tool's function from its name.
10 tools is an ideal size for this domain. It covers authentication, template exploration, parameter retrieval, PDF generation (sync/async, single/batch), downloading results, and smart param suggestion—all essential without unnecessary bloat.
The tool set provides a complete workflow for generating PDFs from templates: authenticate, list templates, get parameters, generate (sync or async, single or batch), and download. The inclusion of suggest_params adds convenience. No obvious gaps for the stated purpose.
Maintenance
Related MCP Connectors
Generate PDFs from templates via AI chat. Works with Claude, ChatGPT, Cursor, and any MCP client.
DocBase MCP server for AI agents
LLM Orchestration MCP Agent
Hosted MCP server: convert PDFs to clean, LLM-ready Markdown with tables, formulas and OCR.
Related MCP Servers
- AlicenseBqualityCmaintenanceMCP server that converts Markdown to high-quality PDF documents using LaTeX, enabling AI agents like Claude to generate professional PDFs without requiring sign-ups or credit cards.144 npm11MIT
- AlicenseNot gradedqualityBmaintenancePDF Tools AI - MCP server providing AI-powered tools and automation by MEOK AI Labs7 npmMIT
- AlicenseAqualityFmaintenanceMCP server for BulkRender — generate bulk DOCX and PDF documents from Claude, Cursor, Windsurf, and any MCP-compatible AI assistant1551 npm1MIT
- AlicenseAqualityCmaintenanceMCP server for generating professional PDFs from structured JSON in AI agents like Claude or Cursor, using pure Node.js with embedded fonts and precision text layout.621 npmMIT