admin-valentin/arcade-mcp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
arcade-mcp/toolkits/box_api/arcade_box_api/wrapper_tools/GetLegalHoldPolicyAssignments.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

277 lines
10 KiB
JSON
Raw Blame History

{
"name": "GetLegalHoldPolicyAssignments",
"fully_qualified_name": "BoxApi.GetLegalHoldPolicyAssignments@0.1.0",
"description": "Retrieve items assigned to a legal hold policy.\n\nUse this tool to fetch all items that have been associated with a specific legal hold policy.",
"toolkit": {
"name": "ArcadeBoxApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "legal_hold_policy_id",
"required": true,
"description": "The unique identifier for the legal hold policy to retrieve assignments for.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the legal hold policy."
},
"inferrable": true,
"http_endpoint_parameter_name": "policy_id"
},
{
"name": "filter_by_assignment_type",
"required": false,
"description": "Specify the type of item (e.g., file, folder, user, etc.) the policy was applied to. Choices: ['file', 'file_version', 'folder', 'user', 'ownership', 'interactions'].",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"file",
"file_version",
"folder",
"user",
"ownership",
"interactions"
],
"properties": null,
"inner_properties": null,
"description": "Filters the results by the type of item the\npolicy was applied to."
},
"inferrable": true,
"http_endpoint_parameter_name": "assign_to_type"
},
{
"name": "filter_by_item_id",
"required": false,
"description": "Filters results by the ID of the item the policy was applied to.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filters the results by the ID of item the\npolicy was applied to."
},
"inferrable": true,
"http_endpoint_parameter_name": "assign_to_id"
},
{
"name": "pagination_marker",
"required": false,
"description": "Specifies the position to start retrieving results using marker-based pagination. 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`."
},
"inferrable": true,
"http_endpoint_parameter_name": "marker"
},
{
"name": "maximum_items_per_page",
"required": false,
"description": "Set the maximum number of items to retrieve per page for optimal pagination control.",
"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": "response_fields",
"required": false,
"description": "List of attributes to include in the response, overriding 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"
}
]
},
"output": {
"description": "Response from the API endpoint 'get_legal_hold_policy_assignments'.",
"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/legal_hold_policy_assignments",
"http_method": "GET",
"headers": {
"box-version": "2024.0"
},
"parameters": [
{
"name": "policy_id",
"tool_parameter_name": "legal_hold_policy_id",
"description": "The ID of the legal hold policy.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the legal hold policy."
},
"accepted_as": "query",
"required": true,
"deprecated": false,
"documentation_urls": []
},
{
"name": "assign_to_type",
"tool_parameter_name": "filter_by_assignment_type",
"description": "Filters the results by the type of item the\npolicy was applied to.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": [
"file",
"file_version",
"folder",
"user",
"ownership",
"interactions"
],
"properties": null,
"inner_properties": null,
"description": "Filters the results by the type of item the\npolicy was applied to."
},
"accepted_as": "query",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "assign_to_id",
"tool_parameter_name": "filter_by_item_id",
"description": "Filters the results by the ID of item the\npolicy was applied to.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Filters the results by the ID of item the\npolicy was applied to."
},
"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": "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": "fields",
"tool_parameter_name": "response_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": []
}
],
"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
}
]
}
}
Reference in a new issue View git blame Copy permalink