Skip to main content
Glama
RMITBLOG

Parallels RAS MCP Server

by RMITBLOG

FSLogix Profile Config

ras_site_get_fslogix
Read-onlyIdempotent

Retrieve FSLogix profile container configuration to verify settings, check storage paths, and troubleshoot profile loading issues in Parallels RAS environments.

Instructions

Get FSLogix profile container configuration, including VHD location paths, size limits, and redirection settings. Use this to verify profile management setup, check storage paths, or troubleshoot profile loading issues.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Implementation Reference

  • Handler function that executes the ras_site_get_fslogix tool. Makes an async GET request to /api/site-settings/fslogix/profile-container endpoint to retrieve FSLogix profile container configuration, including VHD location paths, size limits, and redirection settings. Returns JSON data or handles errors using sanitiseError.
    async () => {
      try {
        const data = await rasClient.get("/api/site-settings/fslogix/profile-container");
        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 FSLogix config") }], isError: true };
      }
    }
  • Tool registration for ras_site_get_fslogix. Defines the tool with title 'FSLogix Profile Config', description for retrieving profile container configuration, read-only annotations, and empty input schema. Binds the handler that calls the RAS API.
    server.registerTool(
      "ras_site_get_fslogix",
      {
        title: "FSLogix Profile Config",
        description:
          "Get FSLogix profile container configuration, including VHD location paths, " +
          "size limits, and redirection settings. Use this to verify profile management " +
          "setup, check storage paths, or troubleshoot profile loading issues.",
        annotations: READ_ONLY_ANNOTATIONS,
        inputSchema: {},
      },
      async () => {
        try {
          const data = await rasClient.get("/api/site-settings/fslogix/profile-container");
          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 FSLogix config") }], isError: true };
        }
      }
    );
  • RasClient.get() method - Helper function used by the tool to make authenticated GET requests to the RAS API. Handles lazy authentication, automatic retry on 401 (token expiration), request timeouts, and error response 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();
    }
  • sanitiseError() function - Helper utility used to sanitize error messages by removing sensitive data (auth tokens, passwords) and truncating excessively long API responses to prevent information leakage.
    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}`;
    }
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The description adds valuable context beyond annotations: it explains that the tool retrieves configuration details for troubleshooting and verification, which complements the annotations (readOnlyHint=true, destructiveHint=false) that indicate a safe, non-destructive read operation. However, it does not mention potential limitations like rate limits or authentication requirements, which could be useful for an agent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with the core purpose in the first sentence, followed by specific usage scenarios in the second. Both sentences are essential, providing clear value without redundancy or unnecessary details, making it highly efficient and well-structured.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (a read-only configuration retrieval with no parameters) and rich annotations (readOnlyHint, openWorldHint, idempotentHint, destructiveHint), the description is largely complete. It explains what is retrieved and when to use it, though it could briefly mention the output format or data structure since there is no output schema, leaving a minor gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 0 parameters and 100% schema description coverage, the baseline is 4. The description appropriately does not discuss parameters, as none exist, and instead focuses on the tool's purpose and usage, which is sufficient given the empty input schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Get FSLogix profile container configuration') and resource ('FSLogix profile container'), distinguishing it from sibling tools by focusing on FSLogix-specific settings rather than general site configurations like 'ras_site_get_ad_integration' or 'ras_site_get_printing'. It explicitly lists what is retrieved: VHD location paths, size limits, and redirection settings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on when to use this tool: 'to verify profile management setup, check storage paths, or troubleshoot profile loading issues.' It clearly differentiates this tool from siblings by specifying its troubleshooting and verification purposes, which are not covered by other tools like 'ras_site_get_connection_settings' or 'ras_site_get_mfa'.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/RMITBLOG/ParallelsRAS_MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server