Skip to main content
Glama

Import an XLSForm

kobo_import_xlsform
Destructive

Upload an XLSForm .xlsx questionnaire to Kobo, creating a new form or overwriting an existing one, with optional deployment after import.

Instructions

Upload an XLSForm .xlsx workbook to Kobo, either as a new form or to overwrite an existing one.

Use it when a questionnaire already exists as a spreadsheet, or to round-trip a form edited in Excel.

Args:

  • file_path (string): path to the .xlsx on disk

  • name (string, optional): name for the imported form

  • uid (string, optional): asset uid to overwrite; omit to create a new form

  • deploy (boolean, default false): deploy once the import finishes

Returns: the resulting form uid and import status.

Error Handling:

  • Kobo validates the workbook server-side; a malformed XLSForm comes back with the specific row/column it rejected.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
uidNoAsset uid to overwrite with this file. Omit to create a new form.
nameNoName for the imported form (default: the file name)
deployNoDeploy once the import finishes
file_pathYesPath to the XLSForm .xlsx file on disk

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already mark this as destructive and non-read-only. The description adds value by clarifying the overwrite behavior, the deploy option, and server-side XLSForm validation with row/column error reporting. No contradiction with 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 well-structured with a clear intro, usage guidance, args, returns, and error handling. Every section contributes useful information and the key purpose is front-loaded.

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?

With no output schema, the description compensates by stating the return value (form uid and import status) and error behavior. It is sufficient for invoking the tool, though the exact shape of 'import status' and any deploy side effects are not detailed.

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 description coverage is 100%, so the schema already documents all parameters. The description's Args section largely restates the schema rather than adding extra examples, types, or edge-case details, so it adds minimal value beyond the structured definition.

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 states a specific verb and resource: 'Upload an XLSForm .xlsx workbook to Kobo'. It also distinguishes two clear modes (new form vs overwrite existing), which separates it from siblings like export_xlsform, create_form, and deploy_form.

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?

It gives clear usage context: use when a questionnaire already exists as a spreadsheet or to round-trip a form edited in Excel. However, it does not explicitly name alternatives or state when not to use this tool versus the other form-creation siblings.

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