Skip to main content
Glama
appleton

Eufy RoboVac MCP Server

by appleton

robovac_get_error_code

Retrieve the current error code from your Eufy RoboVac to diagnose and troubleshoot cleaning issues.

Instructions

Get the current error code of the robovac

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
forceNoForce refresh of cached data

Implementation Reference

  • The handler logic for the robovac_get_error_code tool. Ensures the RoboVac instance is initialized, calls getErrorCode with optional force parameter, and returns the error code in the tool response.
    case "robovac_get_error_code":
      this.ensureRoboVacInitialized();
      const errorCode = await this.robovac!.getErrorCode(
        args?.force as boolean
      );
      return {
        content: [
          {
            type: "text",
            text: `Error Code: ${errorCode}`,
          },
        ],
      };
  • src/server.ts:179-192 (registration)
    Registration of the robovac_get_error_code tool in the listTools response, including name, description, and input schema definition.
    {
      name: "robovac_get_error_code",
      description: "Get the current error code of the robovac",
      inputSchema: {
        type: "object",
        properties: {
          force: {
            type: "boolean",
            description: "Force refresh of cached data",
            default: false,
          },
        },
      },
    },
  • Helper method called by the handler to ensure the RoboVac instance is initialized before executing the tool.
    private ensureRoboVacInitialized(): void {
      if (!this.robovac) {
        throw new Error(
          "RoboVac not initialized. Please run robovac_auto_initialize or robovac_connect first."
        );
      }
    }
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It states the tool retrieves error codes but doesn't mention whether this is a read-only operation, if it requires prior connection/initialization, potential rate limits, or what happens if no error exists. For a tool with zero annotation coverage, this leaves significant behavioral gaps.

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 a single, clear sentence that directly states the tool's function without any unnecessary words. It's front-loaded and efficiently communicates the core purpose, making it easy for an AI agent to parse and understand quickly.

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

Completeness2/5

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

Given the lack of annotations and output schema, the description is insufficient for a tool that retrieves operational data. It doesn't explain the format or meaning of the error code (e.g., numeric codes, strings, or structured data), nor does it cover prerequisites like needing the robovac to be connected. This leaves critical context gaps for effective tool use.

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

Parameters3/5

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

The input schema has 100% description coverage, with the 'force' parameter fully documented in the schema itself. The description adds no additional parameter semantics beyond implying retrieval of an error code, which aligns with the tool's name. This meets the baseline score of 3, as the schema adequately handles parameter documentation.

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

Purpose4/5

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

The description clearly states the tool's purpose with a specific verb ('Get') and resource ('current error code of the robovac'), making it immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'robovac_get_status' or 'robovac_format_status', which might also provide error-related information, so it doesn't reach the highest score.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. With siblings like 'robovac_get_status' that might include error codes, there's no indication of whether this tool is preferred for error-specific queries or if it should be used in specific contexts (e.g., troubleshooting). This lack of comparative guidance limits its utility for an AI agent.

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/appleton/sam'

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