Skip to main content
Glama
nx-ai-bridge

nx-ai-bridge

by qiuyekai

nx_status

Verifies NX connectivity and reports version, receiver mode, work part path, and unsaved changes; call first to confirm the bridge is ready before modeling or journal runs.

Instructions

Check the connection to NX. Returns NX version, receiver mode (live/batch/mock), the work part path and whether it has unsaved changes. Call this first.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "nx_status"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

With no annotations supplied, the description carries the burden and does disclose the concrete return contract in prose — version, receiver mode, active part, and a dirty-state flag — which implies a read-only probe. What it omits is stating outright that it mutates nothing and how it behaves when NX is unreachable (error vs. a disconnected status), which matters for a connectivity check.

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 sentences, zero filler, and the operation is front-loaded ahead of the return-value inventory. The closing directive is short enough that it reads as guidance rather than padding.

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

Completeness5/5

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

There is no output schema, so the description must enumerate return values itself, and it names all four fields the agent would act on, including the receiver mode and dirty-part flag that determine whether saving or mode-switching is needed first. Nothing required to invoke a parameterless status check is missing.

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 and the schema is an empty object, so there is no parameter meaning to convey; the baseline of 4 applies. The description correctly mentions no inputs, consistent with the schema.

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 pairs a specific verb and resource ("Check the connection to NX") with an explicit enumeration of what it reports: NX version, receiver mode (live/batch/mock), work part path, and unsaved-changes state. No sibling tool in the catalog performs a connection/status check, so the agent can identify this immediately.

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?

"Call this first" is a direct, actionable ordering instruction that tells the agent when to reach for this tool relative to the rest of the workflow. It stops short of naming alternatives or when-NOT-to-call conditions, but for a zero-parameter preflight check there are no realistic alternatives to exclude.

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