Skip to main content
Glama
Sign In
ros2-inspector

ros2-inspector

by XuChen-AI
OverviewSchemaSourceRelated ServersDiscussionsAdmin
Python
Local

show_interface

Look up ROS 2 message, service, or action type definitions by package/type/name to see fields and meanings.

Instructions

查看 ROS2 消息/服务/动作类型的字段定义。

何时用：拿到一个类型名（如 sample_topic 返回里的 type）想看它有哪些字段、 各字段是什么意思。 参数 interface_type：格式为 包/类型/名称，例如 std_msgs/msg/String、 example_interfaces/srv/AddTwoInts、turtlesim/action/RotateAbsolute。 返回：definition 字段为字段定义原文。失败时返回 error（常见：类型名拼错、 相应功能包未安装）。

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "interface_type": "<interface_type>"
    },
    "name": "show_interface"
  }
}

Input Schema

NameRequiredDescriptionDefault
interface_typeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4.8/5.0
Behavior4/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, and it does disclose the return shape (definition field with raw field text) and failure behavior (error on typo or missing package). It does not explicitly state that the call is read-only/has no side effects, so a small gap remains.

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?

Front-loaded purpose followed by clearly labeled when-to-use, parameter, and return sections; every sentence earns its place with no filler.

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?

For a single-parameter read tool with no output schema or annotations, the description covers purpose, invocation trigger, parameter format, return field, and error cases — everything an agent needs to call it correctly.

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

Parameters5/5

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

Schema description coverage is 0%, so the description must compensate, and it does: it specifies the 包/类型/名称 format and gives three concrete examples spanning msg, srv, and action variants. This adds meaning the bare string schema entirely lacks.

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 verb (查看/view) and resource (ROS2 消息/服务/动作类型的字段定义), making clear this is about interface type definitions rather than topics, nodes, or params like the siblings. An agent can distinguish it from sample_topic or get_topic_info without opening any schema.

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?

Explicit '何时用' section states the exact trigger condition — having a type name such as the 'type' returned by sample_topic — which directly links it to a sibling tool. This is precise when-to-use guidance rather than implied usage.

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