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)
375 lines
19 KiB
JSON
375 lines
19 KiB
JSON
{
|
|
"name": "RetrieveFolderItems",
|
|
"fully_qualified_name": "BoxApi.RetrieveFolderItems@0.1.0",
|
|
"description": "Retrieve items in a specified folder, including files and links.\n\nUse this tool to get a list of items such as files, folders, and web links contained within a specific folder. To obtain details about the folder itself, use a different endpoint.",
|
|
"toolkit": {
|
|
"name": "ArcadeBoxApi",
|
|
"description": null,
|
|
"version": "0.1.0"
|
|
},
|
|
"input": {
|
|
"parameters": [
|
|
{
|
|
"name": "folder_identifier",
|
|
"required": true,
|
|
"description": "Unique ID of a folder. Obtainable from the folder's URL. Root folder ID is always '0'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "folder_id"
|
|
},
|
|
{
|
|
"name": "included_attributes",
|
|
"required": false,
|
|
"description": "List of attributes to include in the response. Specify fields normally omitted in standard responses or query metadata using the format 'metadata.<scope>.<key>'.",
|
|
"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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?fields=metadata.enterprise_12345.contractTemplate`."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "fields"
|
|
},
|
|
{
|
|
"name": "pagination_start_marker",
|
|
"required": false,
|
|
"description": "Specifies the starting point for 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": "starting_item_offset",
|
|
"required": false,
|
|
"description": "Specifies the starting point for the items to be returned. Must be an integer and cannot exceed 10000, or a 400 response is returned.",
|
|
"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": "max_items_per_page",
|
|
"required": false,
|
|
"description": "The maximum number of items to return per page. Specify an integer value.",
|
|
"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": "sort_attribute",
|
|
"required": false,
|
|
"description": "Specifies the secondary attribute for sorting folder items. Options: 'id', 'name', 'date', or 'size'. Not supported for marker-based pagination on root folders.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"id",
|
|
"name",
|
|
"date",
|
|
"size"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "sort"
|
|
},
|
|
{
|
|
"name": "sort_direction",
|
|
"required": false,
|
|
"description": "The direction to sort results: alphabetical ascending (ASC) or descending (DESC).",
|
|
"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": "shared_link_credentials",
|
|
"required": false,
|
|
"description": "Provide the shared link URL and optional password to access items not explicitly shared with a user. Use 'shared_link=[link]' or 'shared_link=[link]&shared_link_password=[password]'.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item."
|
|
},
|
|
"inferrable": true,
|
|
"http_endpoint_parameter_name": "boxapi"
|
|
},
|
|
{
|
|
"name": "use_marker_based_pagination",
|
|
"required": false,
|
|
"description": "Set to true to enable marker-based pagination, which returns a marker for fetching the next page. Only one pagination method can be active at a time.",
|
|
"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_id_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/{folder_id}/items",
|
|
"http_method": "GET",
|
|
"headers": {
|
|
"box-version": "2024.0"
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "fields",
|
|
"tool_parameter_name": "included_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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?fields=metadata.enterprise_12345.contractTemplate`.",
|
|
"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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?fields=metadata.enterprise_12345.contractTemplate`."
|
|
},
|
|
"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_start_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": "offset",
|
|
"tool_parameter_name": "starting_item_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": "limit",
|
|
"tool_parameter_name": "max_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": "sort",
|
|
"tool_parameter_name": "sort_attribute",
|
|
"description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": [
|
|
"id",
|
|
"name",
|
|
"date",
|
|
"size"
|
|
],
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links."
|
|
},
|
|
"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": "folder_id",
|
|
"tool_parameter_name": "folder_identifier",
|
|
"description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`."
|
|
},
|
|
"accepted_as": "path",
|
|
"required": true,
|
|
"deprecated": false,
|
|
"documentation_urls": []
|
|
},
|
|
{
|
|
"name": "boxapi",
|
|
"tool_parameter_name": "shared_link_credentials",
|
|
"description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.",
|
|
"value_schema": {
|
|
"val_type": "string",
|
|
"inner_val_type": null,
|
|
"enum": null,
|
|
"properties": null,
|
|
"inner_properties": null,
|
|
"description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item."
|
|
},
|
|
"accepted_as": "header",
|
|
"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
|
|
}
|
|
]
|
|
}
|
|
}
|