arcade-mcp/toolkits/box_api/arcade_box_api/wrapper_tools/GetSharedFolderInfo.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

167 lines
7.1 KiB
JSON

{
"name": "GetSharedFolderInfo",
"fully_qualified_name": "BoxApi.GetSharedFolderInfo@0.1.0",
"description": "Retrieve folder details using a shared link.\n\nFetch detailed information about a folder using a shared link. This tool is useful when only the shared link is available, regardless of the folder's origin.",
"toolkit": {
"name": "ArcadeBoxApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "shared_link_header",
"required": true,
"description": "A string containing the shared link and optional password formatted as 'shared_link=[link]&shared_link_password=[password]'.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows:\n\n`shared_link=[link]&shared_link_password=[password]`."
},
"inferrable": true,
"http_endpoint_parameter_name": "boxapi"
},
{
"name": "include_fields",
"required": false,
"description": "A list of specific attributes to include in the response. Only these fields will be returned unless explicitly specified otherwise.",
"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": "etag_condition",
"required": false,
"description": "Provide the last observed etag to receive the item only if it has changed. Useful for caching and reducing unnecessary data transfer.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since."
},
"inferrable": true,
"http_endpoint_parameter_name": "if-none-match"
}
]
},
"output": {
"description": "Response from the API endpoint 'get_shared_items#folders'.",
"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/shared_items#folders",
"http_method": "GET",
"headers": {
"box-version": "2024.0"
},
"parameters": [
{
"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": "if-none-match",
"tool_parameter_name": "etag_condition",
"description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since."
},
"accepted_as": "header",
"required": false,
"deprecated": false,
"documentation_urls": []
},
{
"name": "boxapi",
"tool_parameter_name": "shared_link_header",
"description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows:\n\n`shared_link=[link]&shared_link_password=[password]`.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "A header containing the shared link and optional password for the\nshared link.\n\nThe format for this header is as follows:\n\n`shared_link=[link]&shared_link_password=[password]`."
},
"accepted_as": "header",
"required": true,
"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
}
]
}
}