Skip to main content
Glama
aimdb-dev

aimdb-mcp

Official

get_record

Retrieve the current JSON value of a named record from an AimDB instance to debug, monitor, or inspect live data.

Instructions

Get the current value of a specific record from an AimDB instance. Returns the record's current JSON value.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
endpointNoEndpoint URL (unix://PATH, serial://DEVICE?baud=N) or a bare path. Falls back to AIMDB_CONNECT env var if omitted.
record_nameYesName of the record to retrieve (e.g., server::Temperature)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.3/5.0
Behavior3/5

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

With no annotations, the description carries the full burden. It discloses that the operation is a read and that the result is the record's current JSON value, which is useful. However it says nothing about what happens when the record does not exist, connection/auth requirements, or whether the value is a snapshot versus a live subscription.

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?

Two short sentences that are front-loaded with the action and immediately follow with the return value. No filler or redundancy.

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

Completeness3/5

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

The description compensates for the absent output schema by naming the return type (current JSON value). But for a tool with no annotations and no output schema, the absence of any error/not-found behavior keeps it only minimally adequate.

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%, so both parameters (endpoint with its env-var fallback, and record_name with an example) are already fully documented. The description adds no syntax or format detail beyond the schema, so the baseline 3 applies.

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?

States a specific verb and resource ('Get the current value of a specific record') plus the scope ('from an AimDB instance'), which clearly separates it from sibling set_record. It does not explicitly name a sibling to disambiguate against, but the read semantics are unambiguous.

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?

There is no guidance on when to prefer this over list_records, drain_record, get_instance_info, or query_schema. The retrieval intent is implied by the verb, but no conditions or alternatives are stated.

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