Tool Reference
Overview: The Palm Platform MCP provides palm registration, 1:1 comparison, 1:N retrieval, and deletion capabilities.
RegisterRgbPalm — Register RGB Palm
Function: Bind an uploaded RGB palm image to a specified user and generate a corresponding palm ID. When the user already has a registered palm, use IsForce to decide whether to force overwrite.
Parameters:
| Field | Type | Required | Description |
|---|---|---|---|
RgbImage | object | ✅ | RGB palm image object |
RgbImage.Data | string | ✅ | [Image Path field] The object Path corresponding to the image |
RgbImage.ImageType | integer | ✅ | Image type, fixed value 1 (RGB). |
UserId | string | ✅ | User ID, the palm will be associated with this user |
IsForce | boolean | ❌ | Whether to force overwrite when the user already has a palm, default false |
When using a User Token, the data scope is limited to your own palm. When registering a palm, you need to use the userID registered on the official website.
Response:
| Field | Type | Description |
|---|---|---|
PalmId | string | Palm ID |
CompareRgbPalm — RGB Palm 1:1 Comparison
Function: Compare an RGB palm image with the registered palm of a specified user in a one-to-one comparison, returning whether it matches, the match score, algorithm version, and palm direction.
Parameters:
| Field | Type | Required | Description |
|---|---|---|---|
RgbImage | object | ✅ | RGB palm image object to compare |
RgbImage.Data | string | ✅ | [Image Path field] The object Path corresponding to the image |
RgbImage.ImageType | integer | ❌ | Image type, fixed value 1 (RGB). |
CompareUserId | string | ✅ | Target user ID, i.e., the user to compare against |
Response:
| Field | Type | Description |
|---|---|---|
IsMatch | boolean | Whether it matches |
Score | integer | Match score, range 0-100 |
AlgorithmVersion | string | Algorithm version |
PalmDirection | integer | Palm direction. 1=LEFT_PALM, 2=RIGHT_PALM |
SearchRgbPalm — RGB Palm 1:N Retrieval
Function: Search for the most similar user in the palm database based on the input image, returning the matched user ID, match score, algorithm version, and palm direction. Commonly used in identity verification scenarios.
Parameters:
| Field | Type | Required | Description |
|---|---|---|---|
RgbImage | object | ✅ | RGB palm image object to search |
RgbImage.Data | string | ✅ | [Image Path field] The object Path corresponding to the image |
RgbImage.ImageType | integer | ❌ | Image type, fixed value 1 (RGB). |
Response:
| Field | Type | Description |
|---|---|---|
UserId | string | Matched user ID |
Score | integer | Match score, range 0-100 |
AlgorithmVersion | string | Algorithm version |
PalmDirection | integer | Palm direction. 1=LEFT_PALM, 2=RIGHT_PALM |
DeletePalm — Delete Palm
Function: Delete the palm data of a specified user. Fine-grained deletion by palm direction is supported. When PalmDirectionList is an empty array, it means deleting all palms of the user regardless of direction.
Parameters:
| Field | Type | Required | Description |
|---|---|---|---|
UserId | string | ✅ | User ID, the user whose palm data is to be deleted |
PalmDirectionList | array<integer> | ✅ | List of palm directions to delete. Element enum: 1=LEFT_PALM, 2=RIGHT_PALM; pass empty array [] to delete all directions |
Response: No business fields (success indicates deletion is complete).