Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| GS_CLIENT_ID | Yes | Your Gausium Application Client ID | |
| GS_CLIENT_SECRET | Yes | Your Gausium Application Client Secret | |
| GS_OPEN_ACCESS_KEY | Yes | Your Gausium OpenAPI Access Key |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_robots | Fetches the list of robots from the Gausium OpenAPI. Based on: https://developer.gs-robot.com/zh_CN/Robot%20Information%20Service/List%20Robots
Args:
page: The page number to retrieve (must be > 0).
page_size: The number of items per page.
relation: Optional relation type (e.g., 'contract').
Returns:
A dictionary containing the robot list data from the API. |
| list_robot_maps | Fetches the list of maps associated with a specific robot. Based on: https://developer.gs-robot.com/zh_CN/Robot%20Map%20Service/V1%20List%20Robot%20Map
Note: This API uses POST method with robotSn in the JSON body.
Args:
robot_sn: The serial number of the target robot (e.g., 'GS008-0180-C7P-0000').
Returns:
A list of dictionaries, each containing 'mapId' and 'mapName'. |
| create_robot_command | Creates a robot command. Based on: https://developer.gs-robot.com/zh_CN/Robot%20Command%20Service/Create%20Robot%20Command
Args:
serial_number: The serial number of the target robot.
command_type: The type of command (e.g., 'START_TASK', 'PAUSE_TASK', 'STOP_TASK').
command_parameter: Optional command parameters as a dictionary.
Returns:
A dictionary containing the command creation result. |
| get_site_info | Gets site information for a specific robot. Based on: https://developer.gs-robot.com/zh_CN/Robot%20Task%20Service/Get%20Site%20Info
Args:
robot_id: The ID of the target robot.
Returns:
A dictionary containing site information including buildings, floors, and maps. |
| get_map_subareas | Gets map subareas information for precise area control. Args:
map_id: The ID of the target map.
Returns:
A dictionary containing map subareas information. |
| submit_temp_site_task | Submits a temporary task with site information for S-line robots. Args:
task_data: Task data including site, map, and area information.
Returns:
A dictionary containing the task submission result. |
| submit_temp_no_site_task | Submits a temporary task without site information for S-line robots. Args:
task_data: Task data including map and area information.
Returns:
A dictionary containing the task submission result. |
| get_robot_command | Gets the result of a specific robot command. Args:
serial_number: The serial number of the target robot.
command_id: The ID of the command to query.
Returns:
A dictionary containing the command execution result. |
| list_robot_commands | Lists historical commands sent to a robot. Args:
serial_number: The serial number of the target robot.
page: Page number (default: 1).
page_size: Number of items per page (default: 10).
Returns:
A dictionary containing the historical commands list. |
| upload_robot_map_v1 | Uploads a robot map using V1 API. Args:
map_data: Map data to upload.
Returns:
A dictionary containing the upload result with record_id. |
| get_upload_record_v1 | Checks the status of a V1 map upload. Args:
record_id: The upload record ID.
Returns:
A dictionary containing the upload status information. |
| download_robot_map_v1 | Downloads a robot map using V1 API. Args:
map_id: The ID of the map to download.
Returns:
A dictionary containing the map download information. |
| download_robot_map_v2 | Downloads a robot map using V2 API. Args:
map_id: The ID of the map to download.
Returns:
A dictionary containing the map download information. |
| generate_task_report_png | Generates a PNG map for M-line task report. Args:
serial_number: The serial number of the target robot.
report_id: The ID of the task report.
Returns:
A dictionary containing the map generation result. |
| execute_m_line_task_workflow | Executes complete M-line robot task workflow. Automated process: Status query → Task selection → Command execution
Args:
serial_number: The serial number of the target robot.
task_selection_criteria: Optional task selection criteria.
Returns:
A dictionary containing the workflow execution result. |
| execute_s_line_site_task_workflow | Executes complete S-line robot task workflow with site information. Automated process: Site info → Map selection → Subarea retrieval → Task building → Task submission
Args:
robot_id: The ID of the target robot.
task_parameters: Task parameters including map criteria and task settings.
Returns:
A dictionary containing the workflow execution result. |
| execute_s_line_no_site_task_workflow | Executes complete S-line robot task workflow without site information. Automated process: Map list → Map selection → Subarea retrieval → Task building → Task submission
Args:
robot_sn: The serial number of the target robot.
task_parameters: Task parameters including map criteria and task settings.
Returns:
A dictionary containing the workflow execution result. |
| get_robot_status_smart | 智能获取机器人状态。 自动根据机器人系列选择V1 (M-line) 或V2 (S-line) API。
Args:
serial_number: 机器人序列号
Returns:
机器人状态信息字典 |
| get_task_reports_smart | 智能获取任务报告。 自动根据机器人系列选择M-line或S-line任务报告API。
Args:
serial_number: 机器人序列号
page: 页码
page_size: 每页大小
start_time_utc_floor: 开始时间过滤
start_time_utc_upper: 结束时间过滤
Returns:
任务报告数据字典 |
| batch_get_robot_statuses_smart | 智能批量获取机器人状态。 自动根据机器人系列分组并选择正确的批量API。
支持混合查询M-line和S-line机器人。
Args:
serial_numbers: 机器人序列号列表
Returns:
批量状态查询结果字典 |
| get_robot_capabilities | 获取机器人支持的API能力。 显示该机器人支持哪些API端点和功能。
Args:
serial_number: 机器人序列号
Returns:
机器人能力信息字典 |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |