arcade-mcp/toolkits/box_api/arcade_box_api/wrapper_tools/RetrieveTrashedItems.json
Renato Byrro 565bbe0aa5
Box.com Starter MCP Server (#584)
Starter MCP Server generated from the official Box.com OpenAPI
specifications for versions
[2025.0](https://github.com/box/box-openapi/blob/main/openapi/openapi-v2025.0.json)
and
[2024.0](https://github.com/box/box-openapi/blob/main/openapi/openapi.json)
2025-10-01 23:05:16 -03:00

309 lines
13 KiB
JSON

{
"name": "RetrieveTrashedItems",
"fully_qualified_name": "BoxApi.RetrieveTrashedItems@0.1.0",
"description": "Retrieve files and folders from the trash.\n\nUse this tool to access files and folders that have been moved to the trash. Supports retrieval of specific attributes and pagination options.",
"toolkit": {
"name": "ArcadeBoxApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "include_attributes",
"required": false,
"description": "List of attributes to include in the response, such as non-default fields. Only these and mini representation fields will be returned.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested."
},
"inferrable": true,
"http_endpoint_parameter_name": "fields"
},
{
"name": "maximum_items_per_page",
"required": false,
"description": "Specify the maximum number of items to return per page when retrieving trashed items. This value controls pagination to limit the items returned in a single request.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The maximum number of items to return per page."
},
"inferrable": true,
"http_endpoint_parameter_name": "limit"
},
{
"name": "pagination_offset",
"required": false,
"description": "The index to start retrieving items from the trash. Must be less than or equal to 10000.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response."
},
"inferrable": true,
"http_endpoint_parameter_name": "offset"
},
{
"name": "pagination_marker",
"required": false,
"description": "Defines the position marker for marker-based pagination. Requires 'use_marker_based_pagination' to be true.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`."
},
"inferrable": true,
"http_endpoint_parameter_name": "marker"
},
{
"name": "sort_direction",
"required": false,
"description": "The direction to sort results: 'ASC' for ascending or 'DESC' for descending alphabetical order.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"ASC",
"DESC"
],
"properties": null,
"inner_properties": null,
"description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order."
},
"inferrable": true,
"http_endpoint_parameter_name": "direction"
},
{
"name": "secondary_sort_attribute",
"required": false,
"description": "Defines the second attribute by which items are sorted, such as 'name', 'date', or 'size'. Unsupported with marker-based pagination.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"name",
"date",
"size"
],
"properties": null,
"inner_properties": null,
"description": "Defines the **second** attribute by which items\nare sorted.\n\nItems are always sorted by their `type` first, with\nfolders listed before files, and files listed\nbefore web links.\n\nThis parameter is not supported when using marker-based pagination."
},
"inferrable": true,
"http_endpoint_parameter_name": "sort"
},
{
"name": "use_marker_based_pagination",
"required": false,
"description": "Set to true to use marker-based pagination instead of offset-based pagination, allowing retrieval of the next page with a 'marker' field.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response."
},
"inferrable": true,
"http_endpoint_parameter_name": "usemarker"
}
]
},
"output": {
"description": "Response from the API endpoint 'get_folders_trash_items'.",
"available_modes": [
"value",
"error",
"null"
],
"value_schema": {
"val_type": "json",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": null
}
},
"requirements": {
"authorization": {
"provider_id": "arcade-box",
"provider_type": "oauth2",
"id": null,
"oauth2": null
},
"secrets": null,
"metadata": null
},
"deprecation_message": null,
"metadata": {
"object_type": "api_wrapper_tool",
"version": "1.0.0",
"description": "Tools that enable LLMs to interact directly with the box API."
},
"http_endpoint": {
"metadata": {
"object_type": "http_endpoint",
"version": "1.0.0",
"description": ""
},
"url": "https://api.box.com/2.0/folders/trash/items",
"http_method": "GET",
"headers": {
"box-version": "2024.0"
},
"parameters": [
{
"name": "fields",
"tool_parameter_name": "include_attributes",
"description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested.",
"value_schema": {
"val_type": "array",
"inner_val_type": "string",
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "limit",
"tool_parameter_name": "maximum_items_per_page",
"description": "The maximum number of items to return per page.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The maximum number of items to return per page."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "offset",
"tool_parameter_name": "pagination_offset",
"description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.",
"value_schema": {
"val_type": "integer",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "usemarker",
"tool_parameter_name": "use_marker_based_pagination",
"description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.",
"value_schema": {
"val_type": "boolean",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "marker",
"tool_parameter_name": "pagination_marker",
"description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "direction",
"tool_parameter_name": "sort_direction",
"description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"ASC",
"DESC"
],
"properties": null,
"inner_properties": null,
"description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "sort",
"tool_parameter_name": "secondary_sort_attribute",
"description": "Defines the **second** attribute by which items\nare sorted.\n\nItems are always sorted by their `type` first, with\nfolders listed before files, and files listed\nbefore web links.\n\nThis parameter is not supported when using marker-based pagination.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"name",
"date",
"size"
],
"properties": null,
"inner_properties": null,
"description": "Defines the **second** attribute by which items\nare sorted.\n\nItems are always sorted by their `type` first, with\nfolders listed before files, and files listed\nbefore web links.\n\nThis parameter is not supported when using marker-based pagination."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
}
],
"documentation_urls": [],
"secrets": [
{
"arcade_key": "auth_token",
"parameter_name": "Authorization",
"accepted_as": "header",
"formatted_value": "Bearer {authorization}",
"description": "The OAuth token to use for authentication.",
"is_auth_token": true
}
]
}
}