Skip to main content
Glama
appleton

Eufy RoboVac MCP Server

by appleton

robovac_get_play_pause

Check whether your Eufy RoboVac vacuum cleaner is currently running or paused to monitor cleaning status and manage cleaning sessions.

Instructions

Get the current play/pause state of the robovac

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
forceNoForce refresh of cached data

Implementation Reference

  • Handler function for the 'robovac_get_play_pause' tool. Ensures the RoboVac instance is initialized, retrieves the play/pause state using the library method, and returns it as text content.
    case "robovac_get_play_pause":
      this.ensureRoboVacInitialized();
      const playPause = await this.robovac!.getPlayPause(
        args?.force as boolean
      );
      return {
        content: [
          {
            type: "text",
            text: `Play/Pause State: ${playPause}`,
          },
        ],
      };
  • Tool schema definition including name, description, and input schema for optional 'force' parameter, used in the listTools response.
    {
      name: "robovac_get_play_pause",
      description: "Get the current play/pause state of the robovac",
      inputSchema: {
        type: "object",
        properties: {
          force: {
            type: "boolean",
            description: "Force refresh of cached data",
            default: false,
          },
        },
      },
    },
  • src/server.ts:118-384 (registration)
    The tool is registered by including it in the tools array returned by the ListToolsRequest handler.
    tools: [
      {
        name: "robovac_set_work_mode",
        description: "Set the cleaning mode of the robovac",
        inputSchema: {
          type: "object",
          properties: {
            mode: {
              type: "string",
              description: "The work mode to set",
              enum: ["AUTO", "SMALL_ROOM", "SPOT", "EDGE", "NO_SWEEP"],
            },
          },
          required: ["mode"],
        },
      },
      {
        name: "robovac_set_clean_speed",
        description: "Set the suction speed of the robovac",
        inputSchema: {
          type: "object",
          properties: {
            speed: {
              type: "string",
              description: "The cleaning speed to set",
              enum: ["STANDARD", "BOOST_IQ", "MAX", "NO_SUCTION"],
            },
          },
          required: ["speed"],
        },
      },
      {
        name: "robovac_play",
        description: "Start/resume robovac cleaning",
        inputSchema: {
          type: "object",
          properties: {},
        },
      },
      {
        name: "robovac_pause",
        description: "Pause robovac cleaning",
        inputSchema: {
          type: "object",
          properties: {},
        },
      },
      {
        name: "robovac_find_robot",
        description: "Make the robovac beep to help locate it",
        inputSchema: {
          type: "object",
          properties: {
            enable: {
              type: "boolean",
              description: "Whether to enable or disable find robot mode",
              default: true,
            },
          },
        },
      },
      {
        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,
            },
          },
        },
      },
      {
        name: "robovac_get_work_mode",
        description: "Get the current work mode of the robovac",
        inputSchema: {
          type: "object",
          properties: {
            force: {
              type: "boolean",
              description: "Force refresh of cached data",
              default: false,
            },
          },
        },
      },
      {
        name: "robovac_get_clean_speed",
        description: "Get the current cleaning speed of the robovac",
        inputSchema: {
          type: "object",
          properties: {
            force: {
              type: "boolean",
              description: "Force refresh of cached data",
              default: false,
            },
          },
        },
      },
      {
        name: "robovac_get_work_status",
        description: "Get the current work status of the robovac",
        inputSchema: {
          type: "object",
          properties: {
            force: {
              type: "boolean",
              description: "Force refresh of cached data",
              default: false,
            },
          },
        },
      },
      {
        name: "robovac_get_play_pause",
        description: "Get the current play/pause state of the robovac",
        inputSchema: {
          type: "object",
          properties: {
            force: {
              type: "boolean",
              description: "Force refresh of cached data",
              default: false,
            },
          },
        },
      },
      {
        name: "robovac_format_status",
        description:
          "Get a formatted display of all robovac status information",
        inputSchema: {
          type: "object",
          properties: {},
        },
      },
      {
        name: "robovac_get_all_statuses",
        description: "Get all status information from the robovac at once",
        inputSchema: {
          type: "object",
          properties: {
            force: {
              type: "boolean",
              description: "Force refresh of cached data",
              default: false,
            },
          },
        },
      },
      {
        name: "robovac_auto_initialize",
        description:
          "Automatically discover and initialize the first RoboVac device found",
        inputSchema: {
          type: "object",
          properties: {
            email: {
              type: "string",
              description: "Your Eufy account email address",
            },
            password: {
              type: "string",
              description: "Your Eufy account password",
            },
            deviceIndex: {
              type: "number",
              description:
                "Index of device to connect to (0 for first device)",
              default: 0,
            },
          },
          required: ["email", "password"],
        },
      },
      {
        name: "robovac_connect_discovered",
        description:
          "Connect to a discovered RoboVac device by IP (requires device ID and local key)",
        inputSchema: {
          type: "object",
          properties: {
            ip: {
              type: "string",
              description: "IP address of the discovered device",
            },
            deviceId: {
              type: "string",
              description: "The device ID of your Eufy RoboVac",
            },
            localKey: {
              type: "string",
              description: "The local key for your Eufy RoboVac",
            },
          },
          required: ["ip", "deviceId", "localKey"],
        },
      },
      {
        name: "robovac_connect",
        description:
          "Connect to your RoboVac using device credentials (manual setup)",
        inputSchema: {
          type: "object",
          properties: {
            deviceId: {
              type: "string",
              description: "The device ID of your Eufy RoboVac",
            },
            localKey: {
              type: "string",
              description: "The local key for your Eufy RoboVac",
            },
            ip: {
              type: "string",
              description:
                "The IP address of your Eufy RoboVac (optional, defaults to 192.168.1.100)",
            },
          },
          required: ["deviceId", "localKey"],
        },
      },
      {
        name: "robovac_start_cleaning",
        description: "Start the robovac cleaning cycle",
        inputSchema: {
          type: "object",
          properties: {},
        },
      },
      {
        name: "robovac_stop_cleaning",
        description: "Stop the robovac cleaning cycle",
        inputSchema: {
          type: "object",
          properties: {},
        },
      },
      {
        name: "robovac_return_home",
        description: "Send the robovac back to its charging dock",
        inputSchema: {
          type: "object",
          properties: {},
        },
      },
      {
        name: "robovac_get_status",
        description: "Get the current status of the robovac",
        inputSchema: {
          type: "object",
          properties: {},
        },
      },
      {
        name: "robovac_get_battery",
        description: "Get the battery level of the robovac",
        inputSchema: {
          type: "object",
          properties: {},
        },
      },
    ],
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. While 'Get' implies a read-only operation, the description doesn't specify whether this requires authentication, if it's safe to call frequently, what happens if the robovac is offline, or any error handling. For a tool with no annotation coverage, this leaves significant gaps in understanding its behavior.

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 purpose without any unnecessary words. It's front-loaded and efficient, making it easy to parse quickly. Every word earns its place, contributing to understanding the tool's function.

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

Completeness3/5

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

Given the tool's low complexity (1 optional parameter, no output schema, no annotations), the description is minimally adequate. It explains what the tool does but lacks details on usage context, behavioral traits, or output format. For a simple read operation, this might suffice, but it doesn't provide a complete picture for an AI agent to use it effectively in all scenarios.

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 1 parameter with 100% description coverage, so the schema already documents the 'force' parameter thoroughly. The description doesn't add any extra meaning about parameters beyond what's in the schema, such as explaining when to use 'force' or its implications. With high schema coverage, the baseline score of 3 is appropriate.

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: 'Get the current play/pause state of the robovac'. It specifies the verb ('Get') and resource ('play/pause state'), making it easy to understand what the tool does. However, it doesn't explicitly distinguish itself from siblings like 'robovac_get_status' or 'robovac_get_work_status', which might provide overlapping or related information.

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. It doesn't mention any prerequisites, such as needing the robovac to be connected or initialized first, nor does it compare it to sibling tools like 'robovac_get_status' that might include play/pause state as part of a broader status check.

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