ras_policies_list
Retrieve all client policies to audit configuration settings, troubleshoot user experience issues, and review display, audio, printing, and device redirection controls.
Instructions
List all Parallels RAS client policies, including policy names, settings, and assignment status. Client policies control user experience settings such as display, audio, printing, and device redirection. Use this to audit policy configuration or troubleshoot client behaviour issues.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/policies.ts:31-38 (handler)The handler function that executes the ras_policies_list tool logic. It makes a GET request to the RAS API /api/policies endpoint and returns the JSON response or an error message.async () => { try { const data = await rasClient.get("/api/policies"); return { content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }] }; } catch (err) { return { content: [{ type: "text" as const, text: sanitiseError(err, "Failed to retrieve policies") }], isError: true }; } }
- src/tools/policies.ts:19-39 (registration)Complete registration of the ras_policies_list tool with the MCP server, including its title, description, annotations, empty input schema, and the handler function.server.registerTool( "ras_policies_list", { title: "Client Policies", description: "List all Parallels RAS client policies, including policy names, settings, " + "and assignment status. Client policies control user experience settings " + "such as display, audio, printing, and device redirection. Use this to " + "audit policy configuration or troubleshoot client behaviour issues.", annotations: READ_ONLY_ANNOTATIONS, inputSchema: {}, }, async () => { try { const data = await rasClient.get("/api/policies"); return { content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }] }; } catch (err) { return { content: [{ type: "text" as const, text: sanitiseError(err, "Failed to retrieve policies") }], isError: true }; } } );
- src/tools/policies.ts:29-29 (schema)Input schema definition for ras_policies_list tool - an empty object indicating no input parameters are required.inputSchema: {},
- src/client.ts:43-54 (helper)Helper function sanitiseError used by the handler to format error messages by removing sensitive information (auth tokens, passwords) and truncating long messages.function sanitiseError(err: unknown, context: string): string { const raw = err instanceof Error ? err.message : String(err); // Remove anything that looks like a token or password value let sanitised = raw .replace(/auth_token[=:]\s*\S+/gi, "auth_token=[REDACTED]") .replace(/password[=:]\s*\S+/gi, "password=[REDACTED]"); // Truncate excessively long API response bodies if (sanitised.length > 500) { sanitised = sanitised.substring(0, 500) + "... (truncated)"; } return `${context}: ${sanitised}`; }
- src/client.ts:128-166 (helper)The RasClient.get method used by the handler to make authenticated GET requests to the RAS API, with automatic login, token refresh on 401, and timeout handling.async get(path: string): Promise<unknown> { // Ensure we have a valid session if (!this.authToken) { await this.login(); } const fetchOptions = { method: "GET" as const, headers: { ...this.headers, auth_token: this.authToken!, }, signal: AbortSignal.timeout(REQUEST_TIMEOUT_MS), }; let response = await fetch(`${this.baseUrl}${path}`, fetchOptions); // Token may have expired — re-authenticate once and retry if (response.status === 401) { await this.login(); response = await fetch(`${this.baseUrl}${path}`, { ...fetchOptions, headers: { ...this.headers, auth_token: this.authToken!, }, signal: AbortSignal.timeout(REQUEST_TIMEOUT_MS), }); } if (!response.ok) { const body = await response.text(); throw new Error( `RAS API error (HTTP ${response.status}) on ${path}: ${body.substring(0, 300)}` ); } return response.json(); }