renderform-mcp 0.1.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 SimpleLocalize
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,98 @@
+# MCP Server for RenderForm
+
+[RenderForm](https://renderform.io) is an API for automatically generating images, PDFs, screenshots and videos from templates.
+
+This is a [Model Context Protocol (MCP)](https://modelcontextprotocol.io/introduction) server that provides tools for interacting with the [RenderForm API](https://api.renderform.io/openapi/docs).
+
+## Features (Tools)
+
+- Render an image/PDF/video from a template
+- Create a screenshot of a web page
+- Convert a web page to PDF
+- List render results
+- Get render result details
+- Delete a render result
+- List templates
+- Get template details
+- Delete a template
+- Get organization usage (credits, uploads, plan)
+- List available fonts
+
+Feel free to add more tools by making a pull request or creating a feature request.
+
+## Installation
+
+To use the MCP server, you'll need an API key. You can create and manage API keys in **RenderForm > Settings > API Keys**.
+
+To run the server in a client like Claude Desktop, Cursor or Windsurf, add the following to your MCP config:
+
+```json
+{
+  "servers": {
+    "renderform": {
+      "type": "stdio",
+      "command": "npx",
+      "args": ["-y", "renderform-mcp", "--api-key=RENDERFORM_API_KEY"]
+    }
+  }
+}
+```
+
+Replace `RENDERFORM_API_KEY` with your API key.
+
+For detailed setup guides, see:
+
+- [Cursor AI](https://docs.cursor.com/context/model-context-protocol)
+- [Visual Studio Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers)
+- [GitHub Copilot](https://github.blog/changelog/2025-05-19-agent-mode-and-mcp-support-for-copilot-in-jetbrains-eclipse-and-xcode-now-in-public-preview/)
+- [Claude Desktop](https://modelcontextprotocol.io/quickstart/user)
+- [Windsurf](https://docs.codeium.com/windsurf/mcp)
+
+## Development
+
+1. Install dependencies:
+
+   ```bash
+   npm install
+   ```
+
+2. Build the server:
+
+   ```bash
+   npm run build
+   ```
+
+3. Update client to use the local build:
+   ```json
+   {
+     "servers": {
+       "renderform": {
+         "command": "node",
+         "args": ["path/to/renderform-mcp/build/index.js"],
+         "env": {
+           "RENDERFORM_API_KEY": "your_api_key"
+         }
+       }
+     }
+   }
+   ```
+
+## Debugging
+
+To debug the MCP server, you can use the MCP Inspector tool:
+
+1. Run the server with the inspector:
+
+   ```bash
+   npm run inspector
+   ```
+
+2. Open the provided URL in your browser to view and debug the MCP requests and responses.
+
+3. Include the `--api-key` argument.
+
+## Learn more
+
+- [RenderForm developer docs](https://renderform.io/docs)
+- [RenderForm API reference](https://api.renderform.io/openapi/docs)
+- [Sign up for RenderForm](https://renderform.io)

package/build/api.js

@@ -0,0 +1,37 @@
+import { createPdf, createScreenshot, deleteRenderResult, deleteTemplate, getFonts, getRenderResult, getRenderResults, getTemplate, getTemplates, getUsage, renderImage, } from "./functions.js";
+class RenderFormAPI {
+    apiKey;
+    constructor(apiKey) {
+        this.apiKey = apiKey;
+    }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    async run(method, arg) {
+        switch (method) {
+            case "render_image":
+                return JSON.stringify(await renderImage(this.apiKey, arg));
+            case "create_screenshot":
+                return JSON.stringify(await createScreenshot(this.apiKey, arg));
+            case "create_pdf":
+                return JSON.stringify(await createPdf(this.apiKey, arg));
+            case "get_render_results":
+                return JSON.stringify(await getRenderResults(this.apiKey, arg));
+            case "get_render_result":
+                return JSON.stringify(await getRenderResult(this.apiKey, arg));
+            case "delete_render_result":
+                return JSON.stringify(await deleteRenderResult(this.apiKey, arg));
+            case "get_templates":
+                return JSON.stringify(await getTemplates(this.apiKey, arg));
+            case "get_template":
+                return JSON.stringify(await getTemplate(this.apiKey, arg));
+            case "delete_template":
+                return JSON.stringify(await deleteTemplate(this.apiKey, arg));
+            case "get_usage":
+                return JSON.stringify(await getUsage(this.apiKey));
+            case "get_fonts":
+                return JSON.stringify(await getFonts(this.apiKey));
+            default:
+                throw new Error("Invalid method " + method);
+        }
+    }
+}
+export default RenderFormAPI;

package/build/functions.js

@@ -0,0 +1,162 @@
+import axios from "axios";
+const BASE_URL = "https://api.renderform.io";
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+const handleError = (error) => {
+    if (axios.isAxiosError(error)) {
+        return error.response?.data ?? { msg: error.message, status: error.response?.status ?? 0 };
+    }
+    throw error;
+};
+export const renderImage = async (apiKey, params) => {
+    try {
+        const { output, ...body } = params;
+        const response = await axios.post(`${BASE_URL}/api/v2/render`, body, {
+            headers: {
+                "x-api-key": apiKey,
+            },
+            params: output ? { output } : undefined,
+        });
+        return response?.data;
+    }
+    catch (error) {
+        return handleError(error);
+    }
+};
+export const createScreenshot = async (apiKey, params) => {
+    try {
+        const response = await axios.post(`${BASE_URL}/api/v1/screenshots`, params, {
+            headers: {
+                "x-api-key": apiKey,
+            },
+        });
+        return response?.data;
+    }
+    catch (error) {
+        return handleError(error);
+    }
+};
+export const createPdf = async (apiKey, params) => {
+    try {
+        const response = await axios.post(`${BASE_URL}/api/v1/pdf`, params, {
+            headers: {
+                "x-api-key": apiKey,
+            },
+        });
+        return response?.data;
+    }
+    catch (error) {
+        return handleError(error);
+    }
+};
+export const getRenderResults = async (apiKey, params) => {
+    try {
+        const { template, batch, page = 0, size = 20 } = params;
+        const response = await axios.get(`${BASE_URL}/api/v2/results`, {
+            headers: {
+                "x-api-key": apiKey,
+            },
+            params: { template, batch, page, size },
+        });
+        return response?.data;
+    }
+    catch (error) {
+        return handleError(error);
+    }
+};
+export const getRenderResult = async (apiKey, params) => {
+    try {
+        const { identifier } = params;
+        const response = await axios.get(`${BASE_URL}/api/v2/results/${encodeURIComponent(identifier)}`, {
+            headers: {
+                "x-api-key": apiKey,
+            },
+        });
+        return response?.data;
+    }
+    catch (error) {
+        return handleError(error);
+    }
+};
+export const deleteRenderResult = async (apiKey, params) => {
+    try {
+        const { identifier } = params;
+        const response = await axios.delete(`${BASE_URL}/api/v2/results/${encodeURIComponent(identifier)}`, {
+            headers: {
+                "x-api-key": apiKey,
+            },
+        });
+        return response?.data;
+    }
+    catch (error) {
+        return handleError(error);
+    }
+};
+export const getTemplates = async (apiKey, params) => {
+    try {
+        const { name, tags, sourceTemplateId, page = 0, size = 20 } = params;
+        const response = await axios.get(`${BASE_URL}/api/v2/my-templates`, {
+            headers: {
+                "x-api-key": apiKey,
+            },
+            params: { name, tags, sourceTemplateId, page, size },
+        });
+        return response?.data;
+    }
+    catch (error) {
+        return handleError(error);
+    }
+};
+export const getTemplate = async (apiKey, params) => {
+    try {
+        const { templateId } = params;
+        const response = await axios.get(`${BASE_URL}/api/v2/my-templates/${encodeURIComponent(templateId)}`, {
+            headers: {
+                "x-api-key": apiKey,
+            },
+        });
+        return response?.data;
+    }
+    catch (error) {
+        return handleError(error);
+    }
+};
+export const deleteTemplate = async (apiKey, params) => {
+    try {
+        const { templateId } = params;
+        const response = await axios.delete(`${BASE_URL}/api/v2/my-templates/${encodeURIComponent(templateId)}`, {
+            headers: {
+                "x-api-key": apiKey,
+            },
+        });
+        return response?.data;
+    }
+    catch (error) {
+        return handleError(error);
+    }
+};
+export const getUsage = async (apiKey) => {
+    try {
+        const response = await axios.get(`${BASE_URL}/api/v1/usage`, {
+            headers: {
+                "x-api-key": apiKey,
+            },
+        });
+        return response?.data;
+    }
+    catch (error) {
+        return handleError(error);
+    }
+};
+export const getFonts = async (apiKey) => {
+    try {
+        const response = await axios.get(`${BASE_URL}/api/v1/fonts`, {
+            headers: {
+                "x-api-key": apiKey,
+            },
+        });
+        return response?.data;
+    }
+    catch (error) {
+        return handleError(error);
+    }
+};

package/build/index.js

@@ -0,0 +1,38 @@
+#!/usr/bin/env node
+import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
+import RenderFormMCPServer from "./toolkit.js";
+const ACCEPTED_ARGS = ["api-key"];
+function parseArgs(args) {
+    const options = {
+        apiKey: ""
+    };
+    args.forEach((arg) => {
+        if (arg.startsWith("--")) {
+            const [key, value] = arg.slice(2).split("=");
+            if (key == "api-key") {
+                options.apiKey = value;
+            }
+            else {
+                throw new Error(`Invalid argument: ${key}. Accepted arguments are: ${ACCEPTED_ARGS.join(", ")}`);
+            }
+        }
+    });
+    const apiKey = options.apiKey || process.env.RENDERFORM_API_KEY;
+    if (!apiKey) {
+        throw new Error("RenderForm API key not provided. Please pass it as an argument --api-key=$KEY or set the RENDERFORM_API_KEY environment variable.");
+    }
+    options.apiKey = apiKey;
+    return options;
+}
+async function main() {
+    const options = parseArgs(process.argv.slice(2));
+    const server = new RenderFormMCPServer({
+        apiKey: options.apiKey
+    });
+    const transport = new StdioServerTransport();
+    await server.connect(transport);
+}
+main().catch((error) => {
+    console.error("Fatal error in main():", error);
+    process.exit(1);
+});

package/build/parameters.js

@@ -0,0 +1,81 @@
+import { z } from "zod";
+export const renderImageParameters = z.object({
+    template: z.string().min(1).describe("Template ID to render, e.g. template_1234."),
+    data: z
+        .record(z.any())
+        .optional()
+        .describe("Data to be merged into the template. Keys follow the 'componentId.property' convention, e.g. { 'my-text.text': 'John' }."),
+    fileName: z.string().optional().describe("Name of the file to be returned (without extension)."),
+    webhookUrl: z.string().optional().describe("Webhook URL to be called when the render is done."),
+    version: z
+        .string()
+        .optional()
+        .describe("Cache key used for caching the rendered output. Reusing the same version returns the cached file."),
+    metadata: z.record(z.any()).optional().describe("Additional metadata to be passed to the webhook."),
+    batchName: z.string().optional().describe("Batch name used for grouping renders together."),
+    waitTime: z.number().min(0).max(5000).optional().describe("Wait time in milliseconds before rendering (max 5000)."),
+    output: z
+        .enum(["image", "json"])
+        .optional()
+        .describe("Output format. 'json' (default) returns a JSON object with the href of the rendered file, which is recommended here. 'image' returns raw image bytes and is not suitable for text responses."),
+});
+export const createScreenshotParameters = z.object({
+    url: z.string().min(1).describe("URL of the page to capture."),
+    width: z.number().min(32).max(5000).describe("Width of the screenshot in pixels (32-5000)."),
+    height: z.number().min(32).max(5000).describe("Height of the screenshot in pixels (32-5000)."),
+    waitTime: z
+        .number()
+        .min(0)
+        .max(5000)
+        .optional()
+        .describe("Wait time in milliseconds before capturing the screenshot (0-5000)."),
+});
+export const createPdfParameters = z.object({
+    url: z.string().min(1).describe("URL of the page to capture as a PDF."),
+    format: z
+        .enum(["A5", "A4", "A3", "LETTER", "LEGAL"])
+        .optional()
+        .describe("Output page format of the PDF. Defaults to A4."),
+    waitTime: z
+        .number()
+        .min(0)
+        .max(5000)
+        .optional()
+        .describe("Wait time in milliseconds before capturing the PDF (0-5000)."),
+    expires: z
+        .number()
+        .min(1)
+        .max(604800)
+        .optional()
+        .describe("Automatically delete the generated PDF after this many seconds (1-604800)."),
+});
+export const getRenderResultsParameters = z.object({
+    template: z.string().optional().describe("Filter results by template identifier."),
+    batch: z.string().optional().describe("Filter results by batch identifier."),
+    page: z.number().min(0).optional().describe("Page number for pagination (default 0)."),
+    size: z.number().min(1).max(50).optional().describe("Page size for pagination (default 20, max 50)."),
+});
+export const getRenderResultParameters = z.object({
+    identifier: z.string().min(1).describe("Identifier (requestId) of the render result, e.g. req-xxxx."),
+});
+export const deleteRenderResultParameters = z.object({
+    identifier: z.string().min(1).describe("Identifier (requestId) of the render result to delete."),
+});
+export const getTemplatesParameters = z.object({
+    name: z.string().optional().describe("Filter templates by name."),
+    tags: z.array(z.string()).optional().describe("Filter templates by tags."),
+    sourceTemplateId: z
+        .string()
+        .optional()
+        .describe("Filter by the identifier of the source template used to create a template."),
+    page: z.number().min(0).optional().describe("Page number for pagination (default 0)."),
+    size: z.number().min(1).max(50).optional().describe("Page size for pagination (default 20, max 50)."),
+});
+export const getTemplateParameters = z.object({
+    templateId: z.string().min(1).describe("Identifier of the template to fetch."),
+});
+export const deleteTemplateParameters = z.object({
+    templateId: z.string().min(1).describe("Identifier of the template to delete."),
+});
+export const getUsageParameters = z.object({}).describe("No parameters required.");
+export const getFontsParameters = z.object({}).describe("No parameters required.");

package/build/prompts.js

@@ -0,0 +1,59 @@
+export const renderImagePrompt = `
+This tool renders an image, PDF or video from a RenderForm template.
+- Provide 'template' (required): the template ID, e.g. template_1234.
+- Provide 'data' to merge dynamic content into the template. Keys follow the 'componentId.property' convention (e.g. { "my-text.text": "Hello World!", "my-image.src": "https://example.com/image.jpg" }).
+- Component IDs and editable properties can be discovered with the 'get_template' tool (see the 'properties' field of the template).
+- Optionally provide 'fileName', 'webhookUrl' (called when the render finishes), 'version' (cache key - reusing it returns a cached result instead of re-rendering), 'metadata' (passed through to the webhook), 'batchName' (to group renders together) and 'waitTime' (delay before rendering, max 5000ms).
+- Use 'output: json' (default) to get back a JSON object with the href of the rendered file. Avoid 'output: image' here since it returns raw binary bytes.
+`;
+export const createScreenshotPrompt = `
+This tool captures a screenshot of a web page using RenderForm.
+- Provide 'url' (required), 'width' and 'height' (required, 32-5000px).
+- Optionally provide 'waitTime' (ms, 0-5000) to wait before capturing, useful for pages with animations or async content.
+`;
+export const createPdfPrompt = `
+This tool converts a web page into a PDF using RenderForm.
+- Provide 'url' (required).
+- Optionally provide 'format' (A5, A4, A3, LETTER or LEGAL - defaults to A4), 'waitTime' (ms, 0-5000) before capturing, and 'expires' (seconds, 1-604800) to auto-delete the generated PDF.
+`;
+export const getRenderResultsPrompt = `
+This tool lists past render results (images, PDFs, screenshots) in your RenderForm account.
+- Optionally filter by 'template' or 'batch' identifier.
+- Supports pagination with 'page' (default 0) and 'size' (default 20, max 50).
+`;
+export const getRenderResultPrompt = `
+This tool retrieves details of a single render result by its identifier (requestId).
+- Provide 'identifier' (required), returned as 'requestId' from the render/screenshot/pdf tools.
+- Returns status, dimensions, href, template info and timestamps.
+`;
+export const deleteRenderResultPrompt = `
+This tool permanently deletes a render result (and its file) from your RenderForm account.
+- Provide 'identifier' (required), the requestId of the result to delete.
+- This action is destructive and cannot be undone.
+`;
+export const getTemplatesPrompt = `
+This tool lists templates available in your RenderForm account.
+- Optionally filter by 'name', 'tags' or 'sourceTemplateId'.
+- Supports pagination with 'page' (default 0) and 'size' (default 20, max 50).
+- Use this to find a template identifier before rendering or fetching template details.
+`;
+export const getTemplatePrompt = `
+This tool retrieves the full details of a single template, including its editable 'properties' (component IDs, property names and default values), fonts and tags.
+- Provide 'templateId' (required).
+- Use the returned 'properties' to build the 'data' object for the 'render_image' tool.
+`;
+export const deleteTemplatePrompt = `
+This tool permanently deletes a template from your RenderForm account.
+- Provide 'templateId' (required).
+- This action is destructive and cannot be undone.
+`;
+export const getUsagePrompt = `
+This tool returns the organization's usage summary: render credits (used/total/renewal), file storage uploads (used/total bytes) and plan/billing status.
+- No parameters required.
+- Use this to check remaining credits before running large render batches.
+`;
+export const getFontsPrompt = `
+This tool lists fonts available in your RenderForm account, including Google fonts and any custom uploaded fonts.
+- No parameters required.
+- Use this to find a valid font family name to use in a template.
+`;

package/build/toolkit.js

@@ -0,0 +1,27 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
+import RenderFormAPI from "./api.js";
+import tools from "./tools.js";
+class RenderFormMCPServer extends McpServer {
+    _renderForm;
+    constructor({ apiKey }) {
+        super({
+            name: "renderform",
+            version: "0.1.0",
+        });
+        this._renderForm = new RenderFormAPI(apiKey);
+        tools.forEach((tool) => {
+            this.tool(tool.method, tool.description, tool.parameters.shape, tool.annotations, async (arg, _extra) => {
+                const result = await this._renderForm.run(tool.method, arg);
+                return {
+                    content: [
+                        {
+                            type: "text",
+                            text: String(result),
+                        },
+                    ],
+                };
+            });
+        });
+    }
+}
+export default RenderFormMCPServer;

package/build/tools.js

@@ -0,0 +1,100 @@
+import { createPdfParameters, createScreenshotParameters, deleteRenderResultParameters, deleteTemplateParameters, getFontsParameters, getRenderResultParameters, getRenderResultsParameters, getTemplateParameters, getTemplatesParameters, getUsageParameters, renderImageParameters, } from "./parameters.js";
+import { createPdfPrompt, createScreenshotPrompt, deleteRenderResultPrompt, deleteTemplatePrompt, getFontsPrompt, getRenderResultPrompt, getRenderResultsPrompt, getTemplatePrompt, getTemplatesPrompt, getUsagePrompt, renderImagePrompt, } from "./prompts.js";
+const readOnly = {
+    readOnlyHint: true,
+    destructiveHint: false,
+    idempotentHint: true,
+    openWorldHint: true,
+};
+const createOrUpdate = {
+    readOnlyHint: false,
+    destructiveHint: false,
+    idempotentHint: false,
+    openWorldHint: true,
+};
+const destructive = {
+    readOnlyHint: false,
+    destructiveHint: true,
+    idempotentHint: false,
+    openWorldHint: true,
+};
+const tools = [
+    {
+        method: "render_image",
+        name: "Render Image",
+        description: renderImagePrompt,
+        parameters: renderImageParameters,
+        annotations: createOrUpdate,
+    },
+    {
+        method: "create_screenshot",
+        name: "Create Screenshot",
+        description: createScreenshotPrompt,
+        parameters: createScreenshotParameters,
+        annotations: createOrUpdate,
+    },
+    {
+        method: "create_pdf",
+        name: "Create PDF",
+        description: createPdfPrompt,
+        parameters: createPdfParameters,
+        annotations: createOrUpdate,
+    },
+    {
+        method: "get_render_results",
+        name: "Get Render Results",
+        description: getRenderResultsPrompt,
+        parameters: getRenderResultsParameters,
+        annotations: readOnly,
+    },
+    {
+        method: "get_render_result",
+        name: "Get Render Result",
+        description: getRenderResultPrompt,
+        parameters: getRenderResultParameters,
+        annotations: readOnly,
+    },
+    {
+        method: "delete_render_result",
+        name: "Delete Render Result",
+        description: deleteRenderResultPrompt,
+        parameters: deleteRenderResultParameters,
+        annotations: destructive,
+    },
+    {
+        method: "get_templates",
+        name: "Get Templates",
+        description: getTemplatesPrompt,
+        parameters: getTemplatesParameters,
+        annotations: readOnly,
+    },
+    {
+        method: "get_template",
+        name: "Get Template",
+        description: getTemplatePrompt,
+        parameters: getTemplateParameters,
+        annotations: readOnly,
+    },
+    {
+        method: "delete_template",
+        name: "Delete Template",
+        description: deleteTemplatePrompt,
+        parameters: deleteTemplateParameters,
+        annotations: destructive,
+    },
+    {
+        method: "get_usage",
+        name: "Get Usage",
+        description: getUsagePrompt,
+        parameters: getUsageParameters,
+        annotations: readOnly,
+    },
+    {
+        method: "get_fonts",
+        name: "Get Fonts",
+        description: getFontsPrompt,
+        parameters: getFontsParameters,
+        annotations: readOnly,
+    },
+];
+export default tools;

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "renderform-mcp",
+  "version": "0.1.0",
+  "description": "MCP Server for RenderForm.io",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/renderform/renderform-mcp-server.git"
+  },
+  "main": "build/index.js",
+  "type": "module",
+  "bin": {
+    "renderform": "build/index.js"
+  },
+  "scripts": {
+    "build": "tsc && node -e \"require('fs').chmodSync('build/index.js', '755')\"",
+    "dev": "tsc --watch",
+    "inspector": "npx @modelcontextprotocol/inspector build/index.js",
+    "lint": "eslint src",
+    "lint:fix": "eslint src --fix",
+    "format": "prettier --write src"
+  },
+  "files": [
+    "build"
+  ],
+  "keywords": [
+    "mcp",
+    "modelcontextprotocol",
+    "renderform",
+    "image-generation",
+    "pdf"
+  ],
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.7.0",
+    "typescript": "^5.8.2",
+    "zod": "^3.24.2",
+    "axios": "^1.6.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.23.0",
+    "@types/node": "^22.13.12",
+    "eslint": "^9.23.0",
+    "globals": "^16.0.0",
+    "prettier": "^3.5.3",
+    "typescript-eslint": "^8.27.0"
+  }
+}