Skip to main content
Glama

vi_text

Extracts a LabVIEW VI’s text export, including front-panel control names, descriptions, captions, diagram comments, structures, and string constants. Use it to inspect readable VI content; use snapshots for wires and node types.

Instructions

Text content of a VI as LabVIEW's own string export (XML-like): front-panel controls (type + name, nested for clusters), descriptions, captions, and with include_diagram=true the block-diagram strings: free labels/comments, structures (case structures with one block per case), string constants. It does NOT include wires, node types or numeric constants — use vi_snapshot to see those.

raw=true returns the export unmodified (with font markup).

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": {
      "path": "<path>"
    },
    "name": "vi_text"
  }
}

Input Schema

NameRequiredDescriptionDefault
rawNo
pathYes
include_diagramNo

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.40.1

TDQS

A4.1/5.0
Behavior4/5

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

With no annotations, the description carries the burden and does well: it discloses the export format (LabVIEW's own XML-like string export), the exact scope of content, and that raw=true returns the export unmodified including font markup. It does not mention whether the file must be loaded/open or any permissions, which is a minor 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?

Front-loaded with the main purpose, then scope, then the exclusion and the raw flag; every sentence carries content. Slightly dense with parenthetical stacking and an unexplained 'VI' expansion at the start, but no filler.

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?

An output schema exists, so return values need not be explained; the description still clarifies the export's shape and the effect of raw on markup. For a read tool with three parameters this is nearly complete, with only the path parameter's meaning left implicit.

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: it explains include_diagram and raw meaningfully, but the required path parameter is never characterized (path to a .vi file vs. a project item). Two of three parameters are covered well, the most important one not at all.

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?

States a specific verb and resource ('text content of a VI'), enumerates what is returned (front-panel controls, descriptions, captions, diagram strings), and explicitly contrasts with the sibling vi_snapshot. The agent can distinguish it from alternatives 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 Guidelines4/5

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

Explicitly names what is excluded (wires, node types, numeric constants) and directs the agent to vi_snapshot for those, plus states the include_diagram toggle controls diagram coverage. It gives clear selection guidance but offers no exclusions relative to other plausible siblings such as vi_dump or vi_info.

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