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

135 lines
5 KiB
JSON

{
"name": "RetrieveGroupInfo",
"fully_qualified_name": "BoxApi.RetrieveGroupInfo@0.1.0",
"description": "Retrieve detailed information about a specified group.\n\nThis tool fetches information about a group from Box. It's intended for use by group members or users with admin-level permissions.",
"toolkit": {
"name": "ArcadeBoxApi",
"description": null,
"version": "0.1.0"
},
"input": {
"parameters": [
{
"name": "group_id",
"required": true,
"description": "The unique identifier of the group to retrieve information for. Ensure the user has the necessary permissions.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the group."
},
"inferrable": true,
"http_endpoint_parameter_name": "group_id"
},
{
"name": "include_additional_fields",
"required": false,
"description": "A list of attributes to include in the response. Only specified fields will be returned alongside default mini representation fields.",
"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_groups_id'.",
"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/groups/{group_id}",
"http_method": "GET",
"headers": {
"box-version": "2024.0"
},
"parameters": [
{
"name": "fields",
"tool_parameter_name": "include_additional_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": "group_id",
"tool_parameter_name": "group_id",
"description": "The ID of the group.",
"value_schema": {
"val_type": "string",
"inner_val_type": null,
"enum": null,
"properties": null,
"inner_properties": null,
"description": "The ID of the group."
},
"accepted_as": "path",
"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
}
]
}
}