Import an XLSForm
kobo_import_xlsformUpload 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.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"file_path": "<file_path>"
},
"name": "kobo_import_xlsform"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| uid | No | Asset uid to overwrite with this file. Omit to create a new form. | |
| name | No | Name for the imported form (default: the file name) | |
| deploy | No | Deploy once the import finishes | |
| file_path | Yes | Path to the XLSForm .xlsx file on disk |