AWS quick documentation change
Summary
Complete rewrite of Box integration documentation, changing from a general MCP server integration to a specific 'Box Agent' connector with detailed setup instructions, authentication methods (Default OAuth app and Custom OAuth app), available actions, and troubleshooting guidance.
Security assessment
The change adds detailed documentation about two authentication methods (Default OAuth app and Custom OAuth app), which are security features. It explains that Custom OAuth app gives organizations full control over OAuth configuration, which is a security consideration. However, there is no evidence this change addresses a specific security vulnerability, weakness, or incident - it appears to be a routine documentation update for a new feature.
Diff
diff --git a/quick/latest/userguide/box-integration.md b/quick/latest/userguide/box-integration.md index a27649dc7..efab4210e 100644 --- a//quick/latest/userguide/box-integration.md +++ b//quick/latest/userguide/box-integration.md @@ -7 +7 @@ -What you can doAvailable toolsSetup requirementsCompatibility +Before you beginSetting up the connector in Amazon QuickAvailable actionsManaging and troubleshooting @@ -9 +9 @@ What you can doAvailable toolsSetup requirementsCompatibility -# Box integration +# Box Agent integration @@ -11 +11 @@ What you can doAvailable toolsSetup requirementsCompatibility -With Box integration in Amazon Quick, you can manage files, folders, and collaborate on documents directly from your Amazon Quick environment through Model Context Protocol (MCP) server connectivity. +With the Box Agent connector, you can access Box AI features, manage files and folders, and organize content in hubs directly in Amazon Quick through natural language. @@ -13 +13 @@ With Box integration in Amazon Quick, you can manage files, folders, and collabo -## What you can do +Amazon Quick supports the following authentication methods for Box Agent. @@ -15 +15 @@ With Box integration in Amazon Quick, you can manage files, folders, and collabo -The Box integration provides action capabilities through MCP server connectivity, enabling you to: + * **Default OAuth app** – Uses an AWS-managed OAuth application. No additional credentials are needed. You authenticate directly with your Box account. @@ -17 +17 @@ The Box integration provides action capabilities through MCP server connectivity - * Upload and download files + * **Custom OAuth app** – Uses a customer-managed OAuth 2.0 application registered in the Box Developer Console. This option gives your organization full control over the OAuth configuration. @@ -19 +18,0 @@ The Box integration provides action capabilities through MCP server connectivity - * Create and manage folders @@ -21 +19,0 @@ The Box integration provides action capabilities through MCP server connectivity - * Share files and folders @@ -23 +20,0 @@ The Box integration provides action capabilities through MCP server connectivity - * Search for content @@ -25 +22 @@ The Box integration provides action capabilities through MCP server connectivity - * Manage file permissions +For more information about the authentication methods that Amazon Quick supports, see [Authentication methods](./quick-action-auth.html). @@ -27 +24 @@ The Box integration provides action capabilities through MCP server connectivity - * Use AI-powered tools to ask questions, extract insights, and analyze content across files and hubs. +## Before you begin @@ -28,0 +26 @@ The Box integration provides action capabilities through MCP server connectivity +Make sure that you have the following before you set up the integration. @@ -29,0 +28 @@ The Box integration provides action capabilities through MCP server connectivity + * A Box account with access to files and folders. @@ -30,0 +30 @@ The Box integration provides action capabilities through MCP server connectivity + * For **Custom OAuth app** : Access to the Box Developer Console to create a custom app. For more information, see [OAuth 2.0 setup](https://developer.box.com/guides/authentication/oauth2/oauth2-setup) in the Box documentation. @@ -32 +32 @@ The Box integration provides action capabilities through MCP server connectivity -## Available tools + * For Amazon Quick subscription requirements, see [Set up integrations in the console](./integration-console-setup-process.html). @@ -34 +33,0 @@ The Box integration provides action capabilities through MCP server connectivity -The Box MCP server typically provides the following tools: @@ -36 +34,0 @@ The Box MCP server typically provides the following tools: - * `who_am_i` \- Returns detailed information about the currently authenticated Box user. @@ -38 +35,0 @@ The Box MCP server typically provides the following tools: - * `get_file_content` \- Returns the content of a file stored in Box. @@ -40 +37 @@ The Box MCP server typically provides the following tools: - * `get_file_details` \- Gets comprehensive file information from Box including metadata, permissions, and version details. +## Setting up the connector in Amazon Quick @@ -42 +39 @@ The Box MCP server typically provides the following tools: - * `update_file_properties` \- Updates file properties, including name, description, tags, and collections. +### Connect from the Available tab @@ -44 +41 @@ The Box MCP server typically provides the following tools: - * `upload_file` \- Uploads a new file to Box. +If you want to use Default OAuth app authentication, you can connect directly from the **Available** tab without additional configuration. @@ -46 +43 @@ The Box MCP server typically provides the following tools: - * `upload_file_version` \- Uploads a new file version by providing the entire file contents to update an existing file in Box. + 1. In the Amazon Quick console, choose **Connectors**. @@ -48 +45 @@ The Box MCP server typically provides the following tools: - * `create_folder` \- Creates a new folder in Box. + 2. On the **Available** tab, find **Box Agent** and choose **Connect**. @@ -50 +47 @@ The Box MCP server typically provides the following tools: - * `get_folder_details` \- Retrieves comprehensive folder information including metadata, permissions, and collaboration settings. + 3. Complete the Box sign-in flow and grant the requested permissions. @@ -52 +48,0 @@ The Box MCP server typically provides the following tools: - * `list_folder_content_by_folder_id` \- Lists files, folders, and web links in a folder. @@ -54 +49,0 @@ The Box MCP server typically provides the following tools: - * `update_folder_properties` \- Updates folder properties, including name, description, tags, and collections. @@ -56 +50,0 @@ The Box MCP server typically provides the following tools: - * `search_files_keyword` \- Searches for files using keywords. Supports metadata filters, file extension filtering, and field selection. @@ -58 +52 @@ The Box MCP server typically provides the following tools: - * `search_folders_by_name` \- Searches for folders within Box by name using keyword matching. +To configure a connector with Custom OAuth app instead, use the **Create for your team** tab as described below. @@ -60 +54 @@ The Box MCP server typically provides the following tools: - * `ai_qa_hub` \- Asks a question to a Box Hub using Box AI. +### Create from the Create for your team tab @@ -62 +56 @@ The Box MCP server typically provides the following tools: - * `ai_qa_single_file` \- Asks a question to a single file using Box AI. +If you use Custom OAuth app authentication, create a custom app in the Box Developer Console before configuring Amazon Quick. For setup instructions, see [OAuth 2.0 setup](https://developer.box.com/guides/authentication/oauth2/oauth2-setup) in the Box documentation. @@ -64 +58 @@ The Box MCP server typically provides the following tools: - * `ai_qa_multi_file` \- Asks a question to multiple files using Box AI. + 1. In the Amazon Quick console, choose **Connectors**. @@ -66 +60 @@ The Box MCP server typically provides the following tools: - * `ai_extract_freeform` \- Extracts metadata from files using Box AI in freeform format without requiring predefined template structures. + 2. Choose the **Create for your team** tab. @@ -68 +62 @@ The Box MCP server typically provides the following tools: - * `ai_extract_structured` \- Extracts structured metadata from files using Box AI based on either custom fields definition or an existing metadata template. + 3. Find and choose **Box Agent**. @@ -70 +64 @@ The Box MCP server typically provides the following tools: - * `create_file_comment` \- Creates a new comment on a specific file. +###### Note @@ -72 +66 @@ The Box MCP server typically provides the following tools: - * `list_file_comments` \- Lists all comments on a specific file. +If a Box Agent connector already exists, a dialog appears with your existing connectors. To use an existing connector, choose it. To create a new one, choose **No, create new**. @@ -74 +68 @@ The Box MCP server typically provides the following tools: - * `list_tasks` \- Lists all tasks associated with a specific file, including status, message, and due dates. + 4. Enter a **Name** for your connector. Optionally, choose **\+ Add Description** to add a description. @@ -76 +70 @@ The Box MCP server typically provides the following tools: - * `add_items_to_hub` \- Adds files, folders, or web links to a specific hub. + 5. For **Connection type** , choose **Public network**. @@ -78 +72 @@ The Box MCP server typically provides the following tools: - * `create_hub` \- Creates a new hub. + 6. For **OAuth Configuration** , choose one of the following: @@ -80 +74 @@ The Box MCP server typically provides the following tools: - * `get_hub_details` \- Retrieves detailed information about a specific hub. + 1. For **Default OAuth app** : @@ -82 +76 @@ The Box MCP server typically provides the following tools: - * `get_hub_items` \- Gets items (files and folders) associated with a specific hub. +No additional credentials are needed. Choose **Next** to continue. @@ -84 +78 @@ The Box MCP server typically provides the following tools: - * `list_hubs` \- Lists all hubs accessible to the authenticated user. + 2. For **Custom OAuth app** , configure the following fields: @@ -86 +80 @@ The Box MCP server typically provides the following tools: - * `update_hub` \- Updates the title and description of a specific hub. + * **Base URL** (Optional) – The Box API base URL. Example: `https://mcp.box.com` @@ -87,0 +82 @@ The Box MCP server typically provides the following tools: + * **Client ID** – The client ID from your Box app. @@ -88,0 +84 @@ The Box MCP server typically provides the following tools: + * **Client secret** – The client secret from your Box app. @@ -89,0 +86 @@ The Box MCP server typically provides the following tools: + 7. Choose **Next**. @@ -91 +88 @@ The Box MCP server typically provides the following tools: -###### Note + 8. A Box authorization window opens. Review the requested permissions and choose **Grant access to Box**. @@ -93 +90 @@ The Box MCP server typically provides the following tools: -The specific tools and capabilities available through this MCP server may change over time. For the most current information about supported tools, features, and implementation details, check the official Box documentation and MCP server repository. + 9. On the **Review** page, review the available actions for the connector. Choose **Next**. @@ -95 +92 @@ The specific tools and capabilities available through this MCP server may change -## Setup requirements + 10. On the **Publish** page, choose who can access the connector. You can enable access for everyone in your organization or search for specific teams or groups. @@ -97 +94 @@ The specific tools and capabilities available through this MCP server may change -To set up Box integration, you need: + 11. Choose **Publish**. @@ -99 +95,0 @@ To set up Box integration, you need: - * Box account with appropriate permissions @@ -101 +96,0 @@ To set up Box integration, you need: - * Box API credentials (Client ID and Client Secret) @@ -103 +97,0 @@ To set up Box integration, you need: - * Amazon Quick with MCP integration enabled @@ -104,0 +99 @@ To set up Box integration, you need: +## Available actions @@ -105,0 +101 @@ To set up Box integration, you need: +After you set up the connector, the following actions are available. @@ -106,0 +103,28 @@ To set up Box integration, you need: +Box Agent available actions Category | Action | Description +---|---|--- +AI | AI Q&A (Hub) | Ask a question to a Box Hub using Box AI. +AI | AI Q&A (Single File) | Ask a question to a single file using Box AI. +AI | AI Q&A (Multiple Files) | Ask a question to multiple files using Box AI. +AI | AI Extract (Freeform) | Extract metadata from files using Box AI in freeform format. +AI | AI Extract (Structured) | Extract structured metadata from files using Box AI based on custom fields or a metadata template. +Files | Get File Content | Extract and return file content in text format for files under 50 MB. +Files | Get File Details | Get comprehensive file information including metadata, permissions, and version details. +Files | Update File Properties | Update file metadata including name, description, tags, and collections. +Files | Upload File | Upload a new file to Box. +Files | Upload File Version | Upload a new version of an existing file. +Files | Search Files | Search for files using keywords with support for metadata filters and file extension filtering. +Folders | Create Folder | Create a new folder in Box. +Folders | Get Folder Details | Retrieve comprehensive folder information including metadata and collaboration settings. +Folders | List Folder Content | List files, folders, and web links in a folder. +Folders | Update Folder Properties | Update folder metadata including name, description, tags, and collections. +Folders | Search Folders | Search for folders by name using keyword matching. +Hubs | Create Hub | Create a new hub for organizing content. +Hubs | Get Hub Details | Retrieve information about a specific hub. +Hubs | Get Hub Items | Retrieve items within a hub including files, folders, and web links. +Hubs | List Hubs | List all hubs accessible to the current user. +Hubs | Update Hub | Update the title or description of a hub. +Hubs | Add Items to Hub | Add files, folders, or web links to a hub. +Comments and tasks | Create File Comment | Create a new comment on a file. +Comments and tasks | List File Comments | List all comments on a file. +Comments and tasks | List Tasks | List all tasks associated with a file. +Users | Who Am I | Return information about the currently authenticated user. @@ -108 +132 @@ To set up Box integration, you need: -## Compatibility +## Managing and troubleshooting @@ -110 +134 @@ To set up Box integration, you need: -Box integration supports: +For instructions on editing, sharing, or deleting your connector, see [Managing existing integrations](./integration-workflows.html#managing-existing-integrations). @@ -112 +136 @@ Box integration supports: - * **Chat Agents:** Yes + * **Authentication popup fails** – Verify that your browser allows popups from the Amazon Quick console domain. @@ -114 +138 @@ Box integration supports: - * **Flows:** Yes + * **Invalid client credentials (Custom OAuth app)** – Verify that the Client ID and Client secret match the values in your Box Developer Console app. @@ -116 +140 @@ Box integration supports: - * **Knowledge Base:** No + * **Insufficient permissions** – Verify that your Box account has access to the files, folders, or hubs you are trying to access.