Skip to main content
Glama

robot_health

Check robot health and connectivity by verifying the robot's operational status and network connection using its IP address.

Instructions

Check robot health and connectivity

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
robot_ipYesRobot IP address

Implementation Reference

  • The main handler function for the robot_health tool. It sends a GET request to the robot's /health endpoint, extracts key information like API version, firmware, system version, model, and serial, and returns a formatted status report. Handles connection errors gracefully.
    async robotHealth(args) {
      const { robot_ip } = args;
      
      try {
        const data = await this.makeApiRequest(
          'GET',
          `http://${robot_ip}:31950/health`
        );
        
        const health = data;
        const links = health.links || {};
        
        let healthText = `✅ **Robot is healthy and connected!**\n\n`;
        healthText += `**Robot Name:** ${health.name || 'Unknown'}\n`;
        healthText += `**API Version:** ${health.api_version}\n`;
        healthText += `**Firmware Version:** ${health.fw_version || 'Unknown'}\n`;
        healthText += `**System Version:** ${health.system_version || 'Unknown'}\n`;
        healthText += `**Robot Model:** ${health.robot_model || 'Unknown'}\n`;
        healthText += `**Robot Serial:** ${health.robot_serial || 'Unknown'}\n\n`;
        
        healthText += `**Available Logs:**\n`;
        Object.entries(links).forEach(([key, value]) => {
          if (key.includes('Logs')) {
            healthText += `- ${key}: ${value.href}\n`;
          }
        });
        
        return {
          content: [
            {
              type: "text",
              text: healthText
            }
          ]
        };
      } catch (error) {
        return {
          content: [
            {
              type: "text",
              text: `❌ Failed to check robot health: ${error.message}`
            }
          ]
        };
      }
  • Tool schema definition including name, description, and input schema requiring 'robot_ip' parameter.
    {
      name: "robot_health",
      description: "Check robot health and connectivity",
      inputSchema: {
        type: "object",
        properties: {
          robot_ip: { type: "string", description: "Robot IP address" }
        },
        required: ["robot_ip"]
      }
    },
  • index.js:262-263 (registration)
    Registration of the robot_health tool handler in the CallToolRequestSchema switch statement, mapping the tool name to the robotHealth method.
    case "robot_health":
      return this.robotHealth(args);
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 'Check' implies a read-only operation, it doesn't specify whether this requires authentication, what the response format looks like, if there are rate limits, or what 'health and connectivity' entails (e.g., metrics, status codes). This leaves significant gaps for an agent to understand the tool's 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 extremely concise at just four words, with zero wasted language. It's front-loaded with the core action ('Check') and resource, making it easy to parse quickly. Every word earns its place by directly contributing to understanding the tool's purpose.

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 incomplete for a tool that presumably returns health status information. It doesn't explain what 'health and connectivity' means in practice, what values are returned, or how to interpret results. For a diagnostic tool, this leaves too much ambiguity for effective agent 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 single parameter 'robot_ip' clearly documented as 'Robot IP address'. The description doesn't add any meaningful semantic context beyond this, such as format requirements (e.g., IPv4) or examples. With high schema coverage, the baseline score of 3 is appropriate as the schema does the heavy lifting.

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 ('Check') and resource ('robot health and connectivity'), making it immediately understandable. However, it doesn't explicitly differentiate this health-checking function from similar sibling tools like 'get_run_status' or 'poll_error_endpoint_and_fix', which might also provide status 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. With sibling tools like 'get_run_status' and 'poll_error_endpoint_and_fix' that might overlap in functionality, there's no indication of when this health check is preferred, what prerequisites exist, or any exclusions for its use.

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/yerbymatey/opentrons-mcp'

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