Skip to main content
Glama
WattsonicAdmin

wattsonic-modbus-docs

Official

get_sunspec_point

Fetch documentation for a SunSpec model point, including layout, device address/offset, access, scaling, and read/write notes, to plan and validate Modbus writes without connecting to the device.

Instructions

One SunSpec point in the SunSpec model layout (name, type, size, sf, units, access, mandatory, symbols) with the device object: address, offset, implemented (yes/conditional/no), writable and write_range (raw), write_kind (control, stored_setting, fixed_value), sf_address and sf_value, and the device notes on how to read or write it precisely. Documentation only; never touches a device.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
modelYesSunSpec model number of this device: 1, 123, 124, 103, 203, 120, 121, 122 or 160.
pointYesPoint name, e.g. 'WMaxLimPct'. For model 160 modules use 'module[2].DCW' or just 'DCW' for all modules.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

B3.3/5.0
Behavior2/5

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

No annotations are supplied, so the description carries the full behavioral burden. It does well on the read-only point ('never touches a device') and discloses the returned attribute set, but says nothing about failure modes when a model/point combination is unsupported, whether 'implemented'/'writable' are device-derived or static, or where the 'device notes' come from — meaningful gaps for a no-annotation tool.

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?

A single dense sentence with the resource front-loaded and the read-only guarantee placed at the end as a qualifier. The long parenthetical field list earns its place because there is no output schema, though it reads as a run-on enumeration rather than a structured list.

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

Completeness4/5

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

With no output schema, the description must describe the payload, and it does so item by item, including nested sf_address/sf_value and the write_kind taxonomy. Missing only error/edge behavior and any pointer to which sibling supplies the surrounding model context (list_sunspec_models).

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 100%, with both 'model' and 'point' documented including the model enumeration and module[2].DCW syntax, so the schema already does this work. The description adds nothing about parameter behavior (e.g. what happens for an unsupported model or an ambiguous point name), leaving it at the baseline.

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?

Specific verb implied (retrieve documentation for one SunSpec point) plus a precise resource, and the description enumerates exactly what comes back: layout fields plus device object fields (address, offset, implemented, writable, write_range, write_kind, sf_address/sf_value). It separates itself from device-reading siblings only indirectly via 'Documentation only; never touches a device' rather than naming get_register or search_registers.

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?

The phrase 'Documentation only; never touches a device' implies the use case (look up a point's spec/semantics before acting) and rules out live device reads, but there is no explicit when-to-use statement and no sibling named as an alternative, even though get_register and search_registers are obvious overlapping candidates.

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