Skip to main content
Glama

nx_list_annotations

Reads notes, GD&T, and surface roughness annotations from an NX 2D process drawing to complement dimension data and support drawing review.

Instructions

Read the non-dimension annotations of a drawing: notes, GD&T, roughness.

Each entry is prefixed by kind: "NOTE|<journal_id>|" drafting / technical-requirement text "GDT|<journal_id>||tol=|datum=,," "ROUGH|<journal_id>" surface finish symbol Use this together with nx_list_dimensions to fully understand an existing NX 2D process drawing.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
statusNosuccess
messageYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

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

No annotations are supplied, so the description carries the full burden: 'Read' signals a safe non-mutating operation, and the pipe-delimited format block discloses the exact shape of each returned entry per annotation kind, which is real behavioral value. It stops short of stating prerequisites such as requiring an open part or drawing sheet, and says nothing about what happens when no annotations exist.

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?

Front-loaded with the one-sentence purpose, then a compact format reference, then the pairing advice. The monospace format lines are dense and information-bearing rather than filler; nothing could be removed without losing specification detail.

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 the return-value explanation is optional reinforcement rather than a necessity, and the description is complete for a zero-parameter read tool. The one gap is operational context: it never states that a drawing must already exist or be open, which matters given the many part/drawing creation siblings.

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?

The tool takes zero parameters, so there is nothing to disambiguate and the baseline applies. The description correctly adds no parameter prose, though it also does not explain what is implicitly scoped (e.g. which drawing is read).

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 leads with a specific verb and resource ('Read the non-dimension annotations of a drawing') and enumerates exactly which annotation types are covered: notes, GD&T, roughness. It explicitly carves out the boundary against nx_list_dimensions, so an agent can distinguish it from that sibling without opening either 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?

It gives a clear usage condition: pair it with nx_list_dimensions to fully understand an existing NX 2D process drawing. The complement-sibling relationship is explicit, but there are no stated exclusions or prerequisites (e.g. whether a drawing sheet must be active), which keeps it short of a 5.

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