Extract Folder
extract_folderExtract structured data from all supported files in a local folder using Suparse. Returns task IDs for later download or direct JSON results.
Instructions
Process all supported files in an immediate local folder through Suparse. Defaults to result_mode defer, which uploads and polls only, then returns compact task_id/document_ids for later download_results. Use result_mode return_json only when you need full JSON extractions in the MCP response. cleanup is only valid with return_json.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| split | No | Enable auto-splitting of multi-page documents with mixed document types. | |
| api_url | No | Optional API base URL. Defaults to SUPARSE_API_URL or Suparse production API. | |
| cleanup | No | Only valid with result_mode return_json. Deletes processed Suparse documents after JSON results are returned, so later exports cannot be fetched from those document IDs. | |
| folder_path | Yes | Local folder containing supported document files. | |
| result_mode | No | Controls whether extraction results in json format are returned directly. Use return_json only when you need the full JSON extraction in the MCP response. In all other cases you can retrieve the results in format of choice using download_results | defer |
| template_id | No | Optional extraction template ID. Use only a non-system team template ID from list_templates. Do not pass system template IDs directly; ask the user to add the matching system template to their templates first. Omit to let Suparse auto-detect. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| total | Yes | ||
| failed | Yes | ||
| succeeded | Yes | ||
| result_mode | Yes |