MCP User Guide

UnDatasIO API Guide for MCP

 

💫Welcome to the UnDatasIO Guide for MCP Users

Official Website: https://undatas.io/

This document provides a complete guide for interacting with the powerful, cloud-based UnDatasIO file parsing services through the Multi-Channel Platform (MCP). The MCP provides a user-friendly interface to programmatically manage workspaces, tasks, and files, allowing you to build powerful data processing workflows without writing code.

Video Tutorial

---

For a visual walkthrough of the process, please watch our step-by-step video guide:

Getting Started

---

🤖 Before you begin, please ensure you have the following:

• MCP Access: You should have access to the MCP interface.
• UnDatasIO API Key: You must have a valid API key from the UnDatasIO platform. This key is required for authentication in all API calls.

Authentication

All API endpoints require an api_key to be passed as a parameter. This authenticates your request and ensures you have the correct permissions to access and modify resources.

Example Workflow

---

🥇 A typical workflow follows a logical hierarchy: Workspace -> Task -> File. Here is a complete example of the process from start to finish using MCP commands:

1. List Workspaces: Use UnDatasIO_get_workspaces to see all available workspaces and retrieve a work_id.
2. List Tasks: Using the work_id from the previous step, call UnDatasIO_get_tasks to list all tasks within that workspace and get a task_id.
3. Upload a File: Select a task_id and upload your document using the UnDatasIO_upload command.
4. List Files: Call UnDatasIO_get_files to confirm the upload and retrieve the file_id of your new document.
5. Parse the File: Trigger the parsing engine by calling UnDatasIO_parse with the correct task_id and file_ids.
6. Check Result Status: Periodically call UnDatasIO_get_parse_result to check the status of the parsing job for a specific file.
7. Download the Result: Once parsing is complete, use UnDatasIO_get_download_url to get a link to the processed data archive.

API Endpoint Reference

---

🔥 The following commands are available in the MCP for interacting with the UnDatasIO API. Parameters marked with an asterisk (*) are required.

• UnDatasIO_get_workspaces

  • 🏢 Retrieve the list of workspaces.
  • Parameters:

    Parameter	Required	Description
    api_key	Yes	The API key for authentication.

• UnDatasIO_get_tasks

  • 📋 Retrieve the task list under the specified workspace.
  • Parameters:

    Parameter	Required	Description
    work_id*	Yes	The unique identifier for the workspace.
    api_key	Yes	The API key for authentication.

• UnDatasIO_get_files

  • 📂 Retrieve the file list under the specified task.
  • Parameters:

    Parameter	Required	Description
    task_id*	Yes	The unique identifier for the task.
    api_key	Yes	The API key for authentication.

• UnDatasIO_upload

  • 📤 Upload files to the designated task.
  • Parameters:

    Parameter	Required	Description
    task_id*	Yes	The ID of the task to upload the file to.
    file*	Yes	The file to be uploaded.
    api_key	Yes	The API key for authentication.

• UnDatasIO_parse

  • 🌟 Parse files in the specified task.
  • Parameters:

    Parameter	Required	Description
    task_id*	Yes	The unique identifier for the task containing the files.
    file_ids*	Yes	A list of file IDs to be parsed.
    api_key	Yes	The API key for authentication.
    ds_id	No	The ID of the dataset to be used for parsing.
    lang	No	Language hint for the parser (e.g., ‘en’, ‘ch’).
    parse_mode	No	The mode for parsing (e.g., ‘fast’, ‘accurate’).

• UnDatasIO_get_parse_result

  • 📄 Obtain the parsing result of a single file.
  • Parameters:

    Parameter	Required	Description
    task_id*	Yes	The unique identifier for the task.
    file_id*	Yes	The unique identifier for the file.
    api_key	Yes	The API key for authentication.

• UnDatasIO_get_download_url

  • 🔗 Get a downloadable link for the parsing results.
  • Parameters:

    Parameter	Required	Description
    task_id*	Yes	The unique identifier for the task.
    file_ids*	Yes	A list of file IDs to include in the download link.
    api_key	Yes	The API key for authentication.

• read_root__get

  • ✅ A simple health check to verify API connectivity.
  • Parameters: This command does not require any parameters.

Responses and Error Handling

---

📚 Understanding API responses is key to building reliable workflows.

• Successful Response: A 200 OK status code indicates that your request was successful. The response body will contain the requested data in application/json format.
• Error Response: Any status code other than 200 indicates an error. The response body will contain a detail message explaining the cause of the failure (e.g., missing API key, invalid ID). Always check the response details to debug issues.

Contact Us

---

If you have any questions or need support, please visit our official website or contact us through our support channels.