Skip to main content
Glama

Upload Template

upload_template

Upload a template file to the Carbone platform for reuse in document generation. Supports versioning and multiple formats like DOCX, XLSX, and PDF.

Instructions

Upload and store a reusable Carbone template. Once uploaded, use render_document with the returned Template ID to generate documents from it. Supports versioning: multiple versions can live under a single stable Template ID, with deployedAt controlling which version is active. Accepted formats: DOCX, XLSX, PPTX, ODT, ODS, ODP, ODG, HTML, XHTML, IDML, XML, Markdown, PDF, and more.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoExisting Template ID (64-bit format) to add this upload to its version history. If omitted, a new Template ID is generated. Providing a Version ID (SHA-256) is not allowed and will cause an error.
nameYesDisplay name for the template (e.g. "Invoice Template", "NDA Contract").
tagsNoTags for searchability and filtering (e.g. ["sales", "billing", "v2"]).
sampleNoSample input data attached to the template for testing in Carbone Studio. Each item must include data, complement, translations, and enum objects.
commentNoFree-text comment to describe the template version or its purpose.
categoryNoGroup templates into folders/categories (e.g. "invoices", "legal", "hr").
expireAtNoUTC Unix timestamp (seconds) at which this template will be automatically deleted. Use 42000000000 to delete immediately (special "NOW" sentinel value).
templateYesThe template file. Accepts a local file path (e.g. /home/user/invoice.docx), a URL (https://example.com/template.docx), or a base64-encoded string. Supported formats: DOCX, XLSX, PPTX, ODT, ODS, ODP, ODG, HTML, XHTML, IDML, XML, Markdown (MD), PDF, and more. Full list: https://carbone.io/documentation/developer/http-api/generate-reports.md
deployedAtNoUTC Unix timestamp (seconds) to set as the deployment time for this version. Carbone uses the version with the most recent deployedAt when rendering via Template ID. Use 42000000000 to deploy immediately (special "NOW" sentinel value).
versioningNoEnable template versioning (default: true). When true, a stable Template ID is generated and multiple versions can be managed under it. When false, behaves as legacy mode and returns only a templateId (SHA-256 hash).

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoStable Template ID (when versioning is enabled).
nameYesTemplate display name.
sizeNoTemplate size in bytes.
typeNoDetected template file type.
versionIdNoVersion ID (SHA-256) of this uploaded version.
templateIdNoTemplate ID returned in legacy/non-versioned mode.
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations set readOnlyHint=false and destructiveHint=false, and the description adds value by explaining the storage, versioning, and usage lifecycle. It mentions that providing a Version ID causes an error. While it doesn't cover authentication or rate limits, it provides useful 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.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is three sentences long, front-loads the primary purpose, and adds detail on workflow and formatting. Every sentence is informative and necessary, with no redundancy or filler.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool has 10 parameters, 2 required, and an output schema. The description covers the core workflow, versioning, and format support. It does not detail error handling or prerequisites, but given the complexity and presence of an output schema, it is sufficiently complete for an agent to use correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

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 briefly mentions accepted formats and versioning, but does not add parameter-specific meaning beyond what the schema already provides. It is adequate but not improved over the schema documentation.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool uploads and stores a reusable Carbone template. It specifies the subsequent use with render_document, distinguishes from siblings by mentioning versioning and deployedAt, and lists supported formats. The purpose is unambiguous and well-scoped.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description explains when to use the tool (to upload templates for later rendering) and highlights versioning and deployment behavior. It does not explicitly exclude alternative tools, but the context of siblings like update_template_metadata and list_templates provides implicit differentiation. The guidance is clear and actionable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/carboneio/carbone-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server