Checks
Tools for checks and check categories used in Productivity Management workflows.
This page covers 7 tools, all of them available on request rather than in the default tool list, and 1 destructive.
- Status — In the default tool list means the tool is one of the ~200 Aprimo advertises to every agent out of the box, so the agent discovers and calls it on its own. Available on request means the tool is registered and fully callable, but sits outside that default list — call it by name, or ask Aprimo to extend the list your tenant is served.
- Both statuses work identically when called. Status affects discovery, not capability or authorization.
- Visibility is not authorization. Every tool call executes as the authenticated user, and any tool can return an authorization error if that user lacks rights to the record, task, or file. See the MCP Tool Permission Map.
- Destructive tools are labelled as such. They delete or irreversibly overwrite data, and will not act unless the call sets both
confirmedandconfirmedDestructivetotrue. - Activity and Project labels vary by tenant. Where this page says Activity or Project, your tenant's own configured terminology is substituted at runtime.
Aprimo's MCP Server exposes far more tools than most MCP clients handle well — many degrade or truncate their tool list well below the full catalogue. Rather than let a client truncate arbitrarily, Aprimo advertises a curated set of roughly 200 tools covering the tasks customers most commonly automate. Everything outside that set remains fully supported and callable by name; it simply isn't offered up front. If your integration leans on a tool that is available on request, talk to your Aprimo Customer Success Manager about extending the advertised list for your tenant.
Tools at a Glance
| Tool | Status | What it does |
|---|---|---|
create_check | On request | Creates a new Aprimo check. |
delete_check | On request | Destructive. Permanently deletes an Aprimo check by id or by name. |
get_check | On request | Gets one Aprimo check's detail (action type, check category, labels, creation date) by id or by name. |
get_check_category | On request | Gets one Aprimo check category's detail (id, name) by id or by name. |
list_check_categories | On request | Lists the check categories configured in Aprimo — named groupings used to organize check definitions for display/filtering (e.g. "Security", "Image Quality"). |
list_checks | On request | Lists the automated checks configured in Aprimo — a check (of a given action type, e.g. a virus scan or an image validation, organized under a check category) that can run against file versions and record a pass/fail result. |
update_check | On request | Edits an existing Aprimo check by id or by name. |
create_check
Available on request
Creates a new Aprimo check. This modifies data. Always confirm the name, action type, and check category with the user before calling this tool. Use list_action_types/get_action_type and list_check_categories/get_check_category to find valid actionTypeId/checkCategoryId values.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | The name for the new check, exactly as the user stated it. |
actionTypeId | string | Yes | The action type id (GUID) this check performs, from list_action_types/get_action_type. |
checkCategoryId | string | Yes | The check category id (GUID) this check belongs to, from list_check_categories/get_check_category. |
isActive | boolean | No | Whether the check is active. Omit to use DAM's default (true). |
isDeletable | boolean | No | Whether the check can be deleted later. Omit to use DAM's default (true). |
labels | object (map of string) | No | Multi-language labels for this check: a map of languageId (GUID) to label value. Omit for no labels. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
delete_check
Available on request · Destructive
Permanently deletes an Aprimo check by id or by name. This cannot be undone. Requires both confirmed=true and confirmedDestructive=true, after explicitly confirming the exact check with the user.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
checkId | string | No | The check id (GUID) to delete. Provide this or name, not both. |
name | string | No | The check's name (case-insensitive, exact match). Provide this or checkId, not both. |
confirmed | boolean | No | Must be true to proceed. Set to false (or omit) to get a confirmation gate error, then call again with confirmed=true after the user has explicitly confirmed the exact check. |
confirmedDestructive | boolean | No | Must also be true (in addition to confirmed) — deleting a check is permanent and cannot be undone. Set only after stating the exact check to the user and getting explicit go-ahead. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) | |
deleted | boolean |
This tool deletes or irreversibly overwrites data in the live tenant; the change cannot be rolled back through the API. It will not act unless the call sets both confirmed and confirmedDestructive to true.
get_check
Available on request
Gets one Aprimo check's detail (action type, check category, labels, creation date) by id or by name. Use after list_checks, or pass name directly when the user names the check. Not its category (use get_check_category for that).
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
checkId | string | No | The check id (GUID), from list_checks. Provide this or name, not both. |
name | string | No | The check's name (case-insensitive, exact match). Provide this or checkId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string | |
actionTypeId | string (optional) | |
checkCategoryId | string (optional) | |
checkCategoryName | string (optional) | |
labels | array of CheckLabelPayload | |
labels[].value | string (optional) | |
labels[].languageId | string (optional) | |
createdOn | string (optional) |
get_check_category
Available on request
Gets one Aprimo check category's detail (id, name) by id or by name. Use after list_check_categories.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
checkCategoryId | string | No | The check category id (GUID), from list_check_categories. Provide this or name, not both. |
name | string | No | The check category's name (case-insensitive, exact match), e.g. "Security". Provide this or checkCategoryId, not both. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string |
list_check_categories
Available on request
Lists the check categories configured in Aprimo — named groupings used to organize check definitions for display/filtering (e.g. "Security", "Image Quality"). Use when the user asks what check categories exist, or to look up a check category's id/exact name before calling get_check_category by name, or before calling create_check/update_check with a checkCategoryId.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "Name=Security". Omit to list every check category. |
sort | string | No | Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of CheckCategoryPayload | |
items[].id | string | |
items[].name | string |
list_checks
Available on request
Lists the automated checks configured in Aprimo — a check (of a given action type, e.g. a virus scan or an image validation, organized under a check category) that can run against file versions and record a pass/fail result. Use when the user asks what checks exist, or to look up a check's id/exact name before calling get_check, update_check, or delete_check by name.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
filter | string | No | Optional filter expression (DAM query syntax), e.g. "ModifiedOn in today". Omit to list every check. |
sort | string | No | Optional sort expression, e.g. "createdOn". Omit for the endpoint's default order. |
skip | integer | No | Number of items to skip, for paging. Defaults to 0. |
take | integer | No | Maximum number of items to return. Omit for the endpoint's default page size. |
Returns:
| Field | Type | Description |
|---|---|---|
count | integer | |
items | array of CheckPayload | |
items[].id | string | |
items[].name | string | |
items[].actionTypeId | string (optional) | |
items[].checkCategoryId | string (optional) | |
items[].checkCategoryName | string (optional) | |
items[].labels | array of CheckLabelPayload | |
items[].labels[].value | string (optional) | |
items[].labels[].languageId | string (optional) | |
items[].createdOn | string (optional) |
update_check
Available on request
Edits an existing Aprimo check by id or by name. Only the fields provided are changed — omitted fields keep their current value. This modifies data. Always confirm the exact check and the new values with the user before calling this tool.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
checkId | string | No | The check id (GUID) to edit. Provide this or name, not both. |
name | string | No | The check's current name (case-insensitive, exact match), used to look it up. Provide this or checkId, not both. |
newName | string | No | New name for the check. Omit to leave the name unchanged. |
actionTypeId | string | No | New action type id (GUID). Omit to leave it unchanged. |
checkCategoryId | string | No | New check category id (GUID). Omit to leave it unchanged. |
isActive | boolean | No | New active flag. Omit to leave it unchanged. |
labels | object (map of string) | No | Label values to set: a map of languageId (GUID) to label value. Omit to leave labels unchanged. |
Returns:
| Field | Type | Description |
|---|---|---|
id | string | |
name | string (optional) |
Related
- Aprimo MCP Server — configuration, connection details, and authentication
- MCP Tool Permission Map — the Aprimo permissions that make each tool visible to your agent
- REST API vs. MCP — choosing the right integration approach for your agent