AWS appstream2: Restructure MCP tool forwarding steps and add Linux config path
Summary
Reformats the MCP tool forwarding setup into numbered steps, adds a platform table with the Linux configuration file path (/etc/dcv/mcp_server_redirection_config.json) alongside the Windows path, and scopes the forward-slash path guidance to Windows instances.
Security assessment
The diff is a documentation restructuring plus a new Linux config-file path and a Windows-scoped JSON path-escaping tip; it does not fix a vulnerability, add authentication/encryption guidance, or reference any CVE, so security impact is tangential.
Evidence
+ * **On Windows instances, use forward slashes in paths.** For example, use `C:/Program Files/my-mcp/server.exe`. JSON treats the backslash as an escape character, so a Windows-style path written with single backslashes is invalid. Windows accepts forward slashes for absolute paths, which avoids the need to escape every separator as `\\`.
Diff
diff --git a/appstream2/latest/developerguide/agent-access-mcp-tool-forwarding-details.md b/appstream2/latest/developerguide/agent-access-mcp-tool-forwarding-details.md index da707ac..1529605 100644 --- a//appstream2/latest/developerguide/agent-access-mcp-tool-forwarding-details.md +++ b//appstream2/latest/developerguide/agent-access-mcp-tool-forwarding-details.md @@ -17 +17 @@ To set up MCP tool forwarding: - 1. **Enable tool forwarding**. Turn on the `FORWARD_MCP_TOOLS` agent action through the API or console settings. +**Step 1: Enable tool forwarding** @@ -19 +19 @@ To set up MCP tool forwarding: - 2. **Add the configuration file to the fleet's image**. WorkSpaces Applications creates each streaming instance from the fleet's image, so the configuration file must be part of that image. Add it when you build or update the image. A file placed on a running instance does not carry over to new sessions. The service looks for the file at the following path: +Turn on the `FORWARD_MCP_TOOLS` agent action through the API or console settings. @@ -21 +21,14 @@ To set up MCP tool forwarding: - C:\ProgramData\NICE\dcv\mcp_server_redirection_config.json +**Step 2: Add the configuration file to the fleet's image** + +WorkSpaces Applications creates each streaming instance from the fleet's image, so the configuration file must be part of that image. Add it when you build or update the image. A file placed on a running instance does not carry over to new sessions. The service looks for the file at the following location, which depends on the platform: + +Platform | Configuration file path +---|--- +Windows instances | `C:\ProgramData\NICE\dcv\mcp_server_redirection_config.json` +Linux instances | `/etc/dcv/mcp_server_redirection_config.json` + +**Step 3: Define the MCP servers in the configuration file** + +The configuration file is JSON with a single top-level `mcpServers` object. Each key is a unique name that you choose for a server. Each value specifies how to launch that server. + +The following example is for a Windows instance: @@ -23 +35,0 @@ To set up MCP tool forwarding: - 3. **Define the MCP servers in the configuration file**. The configuration file is JSON with a single top-level `mcpServers` object. Each key is a unique name that you choose for a server. Each value specifies how to launch that server. @@ -42,3 +54 @@ Field | Required | Type | Description - 4. **Verify tool availability**. If the file is present, the service connects to the MCP servers listed in the file and forwards their tools. The forwarded tools appear when the agent lists its available tools. - - 5. **Test the configuration**. To confirm that tool forwarding works, run the `mcpforwardingtester` script. You can find it in the [sample-code-for-workspaces-agent-access](https://github.com/aws-samples/sample-code-for-workspaces-agent-access/tree/main/utils/mcpforwardingtester) repository on GitHub. The script tests the MCP setup on your WorkSpace. It reports which tools are ready and flags any issues. +**Step 4: Verify tool availability** @@ -45,0 +56 @@ Field | Required | Type | Description +If the configuration file is present, the service connects to the MCP servers it lists and forwards their tools. Forwarded tools appear when the agent lists its available tools. @@ -46,0 +58 @@ Field | Required | Type | Description +**Step 5: Test the configuration** @@ -47,0 +60 @@ Field | Required | Type | Description +To confirm that tool forwarding works, run the `mcpforwardingtester` script. You can find it in the [sample-code-for-workspaces-agent-access](https://github.com/aws-samples/sample-code-for-workspaces-agent-access/tree/main/utils/mcpforwardingtester) repository on GitHub. The script tests the MCP setup on your WorkSpace. It reports which tools are ready and flags any issues. @@ -61,3 +74 @@ Note the following considerations when you configure MCP tool forwarding: - * **Use forward slashes in paths.** For example, use `C:/Program Files/my-mcp/server.exe`. JSON treats the backslash as an escape character, so a Windows-style path written with single backslashes is invalid. Windows accepts forward slashes for absolute paths, which avoids the need to escape every separator as `\\`. - - * **Tool-call timeout.** Each forwarded tool call must complete within 5 seconds. The MCP server cancels calls that take longer and returns an error to the agent. Design forwarded tools to return quickly. + * **On Windows instances, use forward slashes in paths.** For example, use `C:/Program Files/my-mcp/server.exe`. JSON treats the backslash as an escape character, so a Windows-style path written with single backslashes is invalid. Windows accepts forward slashes for absolute paths, which avoids the need to escape every separator as `\\`.