565bbe0aa5
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)
269 lines
9.9 KiB
JSON
269 lines
9.9 KiB
JSON
{
|
|
"name": "GetEnterpriseRetentionPolicies",
|
|
"fully_qualified_name": "BoxApi.GetEnterpriseRetentionPolicies@0.1.0",
|
|
"description": "Retrieve all retention policies for an enterprise.\n\nThis tool retrieves all retention policies associated with an enterprise. Use it to get a comprehensive list of retention policies.",
|
|
"toolkit": {
|
|
"name": "ArcadeBoxApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "filter_by_policy_name_prefix",
|
|
"required": false,
|
|
"description": "Filter results using a case-sensitive prefix for retention policy names.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filters results by a case sensitive prefix of the name of\nretention policies."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "policy_name"
|
|
},
|
|
{
|
|
"name": "filter_by_retention_policy_type",
|
|
"required": false,
|
|
"description": "Filter retention policies by type: 'finite' or 'indefinite'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"finite",
|
|
"indefinite"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filters results by the type of retention policy."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "policy_type"
|
|
},
|
|
{
|
|
"name": "filter_by_creator_user_id",
|
|
"required": false,
|
|
"description": "Filters the retention policies by the ID of the user who created them. Provide the user ID for specific filtering.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filters results by the ID of the user who created policy."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "created_by_user_id"
|
|
},
|
|
{
|
|
"name": "include_fields",
|
|
"required": false,
|
|
"description": "A list of attributes to include in the response, replacing standard fields unless specified.",
|
|
"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": "The maximum number of retention policies 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."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "limit"
|
|
},
|
|
{
|
|
"name": "pagination_start_marker",
|
|
"required": false,
|
|
"description": "Defines the position marker to begin returning results for marker-based pagination.",
|
|
"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."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "marker"
|
|
}
|
|
]
|
|
},
|
|
"output": {
|
|
"description": "Response from the API endpoint 'get_retention_policies'.",
|
|
"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/retention_policies",
|
|
"http_method": "GET",
|
|
"headers": {
|
|
"box-version": "2024.0"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "policy_name",
|
|
"tool_parameter_name": "filter_by_policy_name_prefix",
|
|
"description": "Filters results by a case sensitive prefix of the name of\nretention policies.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filters results by a case sensitive prefix of the name of\nretention policies."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "policy_type",
|
|
"tool_parameter_name": "filter_by_retention_policy_type",
|
|
"description": "Filters results by the type of retention policy.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"finite",
|
|
"indefinite"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filters results by the type of retention policy."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "created_by_user_id",
|
|
"tool_parameter_name": "filter_by_creator_user_id",
|
|
"description": "Filters results by the ID of the user who created policy.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Filters results by the ID of the user who created policy."
|
|
},
|
|
"accepted_as": "query",
|
|
"required": false,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "fields",
|
|
"tool_parameter_name": "include_fields",
|
|
"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": "marker",
|
|
"tool_parameter_name": "pagination_start_marker",
|
|
"description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.",
|
|
"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."
|
|
},
|
|
"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
|
|
}
|
|
]
|
|
}
|
|
}
|