Skip to main content
Glama
Sign In
ros2-inspector

ros2-inspector

by XuChen-AI
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

health_check

Check ROS 2 daemon status and doctor diagnostics to diagnose environment, network, or daemon issues when nodes are missing or business-node problems are ruled out.

Instructions

对 ROS2 环境本身做健康检查：daemon 状态 + doctor 体检结论。

何时用：怀疑问题不在业务节点，而在 ROS 环境/网络/daemon 本身时； 或 list_nodes 为空想进一步定位原因。 返回：daemon_running（是否在运行）、doctor_returncode （0 全部通过 / 1 有警告 / 2 有错误）、verdict（doctor 结论行）、 warnings_found（警告摘要）、raw_tail（doctor 原始输出尾部）。 注意：doctor 含网络检查，最长约 30 秒。失败时返回 error 字段。

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "health_check"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4.7/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses the latency ceiling (~30s because doctor runs network checks) and the failure behavior (an error field is returned). What it doesn't cover (permissions, whether the check is purely read-only) is minor for a diagnostic tool, so a 4 is warranted.

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 sectioned into purpose, when-to-use, return values, and cautions, with the most decision-relevant content (purpose and trigger) front-loaded. Every sentence earns its place; the return-field list is terse and non-redundant.

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

Completeness5/5

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

There is no output schema, so the description fully documents the return shape: daemon_running, doctor_returncode with its enumerated values (0/1/2), verdict, warnings_found, raw_tail, plus the error field on failure. Nothing an agent needs to interpret the result is missing.

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?

The tool takes zero parameters, so parameter semantics require no explanation and the baseline of 4 applies. There is no input whose meaning could be ambiguous.

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?

Names a specific action (health check) and a specific resource (the ROS2 environment itself), explicitly distinguishing it from business-node tools. The scope is bounded to daemon status plus doctor diagnosis, so an agent immediately knows what class of problem this tool addresses.

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?

Explicitly states when to use it: when the problem is suspected to lie in the ROS environment/network/daemon rather than business nodes, or when list_nodes comes back empty and further localization is needed. It names the sibling list_nodes and the exact triggering condition, leaving nothing to inference.

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

Deploy Server

Other Tools