Skip to main content
Glama

set_viewport_annotations

Set viewport title, subtitle, and legend visibility to control plot annotations in Abaqus/CAE.

Instructions

Set viewport annotations (title, legend, etc.).

Args: title: Title text for the viewport subtitle: Subtitle text legend: Show/hide legend

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
titleNo
legendNo
timeoutNo
subtitleNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.5/5.0
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It communicates that annotations are being modified, but does not state whether this replaces existing annotations, whether it applies to the current viewport, or what side effects may occur.

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?

The description is compact and front-loaded, with a clear purpose statement followed by a concise parameter breakdown. There is 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 tool is simple and an output schema exists, so return-value details are not necessary. However, the description leaves gaps: it does not clarify effect scope, what 'etc.' includes, or how the timeout parameter is used.

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

Parameters4/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 clearly defines title, subtitle, and legend parameters, adding meaning beyond the bare schema. Timeout is omitted, though its name and null default make it reasonably self-explanatory.

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?

The description states a specific verb and resource: 'Set viewport annotations'. It also lists concrete annotation types (title, subtitle, legend), making the tool's job unmistakable even among many viewport-related siblings.

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?

No guidance is given about when to use this tool versus sibling tools like set_viewport_display or set_viewport_view. The context is implied by the name, but there is no explicit when-to-use or alternative routing.

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