Skip to main content
Glama

rs232_add

Adds RS232 commands or sensors under an extension, modeled on existing objects, and wires them to pages via ref_add/block_connect.

Instructions

Adds a command (kind='befehl', code = command bytes) or a sensor (kind='sensor', code = check pattern such as \x07\xF0\x00\xDE\x14\s3\1) under an RS232 extension, modelled on existing objects there. Wire it on pages with ref_add/block_connect.

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": {
      "kind": "<kind>",
      "title": "<title>",
      "code": "<code>"
    },
    "name": "rs232_add"
  }
}

Input Schema

NameRequiredDescriptionDefault
codeYes
kindYes
titleYes
analogNo
deviceNo
code_offNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.9.0

TDQS

B3.1/5.0
Behavior2/5

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

No annotations exist, so the description carries the full burden. It signals a mutation ("Adds") and hints that the object is "modelled on existing objects there," but it never states whether the change is persisted, requires a saved project, is reversible, what gets destroyed, or what is returned. For a create operation with output_schema absent, this is a substantial disclosure gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two tightly packed sentences with the action front-loaded and no filler. It is dense but every clause (kind values, code formats, wiring hint) adds information.

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?

With six parameters at 0% schema coverage, no annotations, and no output schema, the description should cover more ground. It omits four of six parameters and says nothing about the state required to add under an extension or what the caller receives back.

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?

Schema description coverage is 0%, so the description must compensate and it only partially does: it defines kind (two literal values) and code (command bytes vs. a check pattern, with a concrete example). The remaining parameters — title, analog, device, code_off — are left entirely undefined in both schema and description.

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 uses a specific verb ("Adds") and names the resource and its two modes, including literal enum values ('befehl' for commands, 'sensor' for check patterns). It does not distinguish itself from other add tools in the catalog such as io_add_command, so an agent must guess which add tool applies to an RS232 extension.

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

Usage Guidelines3/5

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

It gives a clear follow-up workflow ("Wire it on pages with ref_add/block_connect") which routes the agent to the correct downstream tools, and the kind values implicitly tell you which mode to choose. However, there is no when-not-to-use guidance and no differentiation from sibling add/io_add_command tools.

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