Skip to main content
Glama
PyAEDT-MCP
by yuxuan6426

Connect To Aedt

connect_to_aedt

Connects to an existing Ansys Electronics Desktop (AEDT) instance via gRPC, letting you specify port, machine, version, project, or design for automation.

Instructions

Connect to an existing AEDT instance via gRPC.

This tool establishes a connection to a running AEDT instance using gRPC. The AEDT instance must be started with a gRPC server enabled: ansysedt.exe -grpcsrv <port>

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": "connect_to_aedt"
  }
}

Input Schema

NameRequiredDescriptionDefault
portNogRPC port where AEDT is listening. If ``None``, the tool can auto-select a discovered local gRPC session or fall back to 50051.
machineNoMachine hostname or IP address where AEDT is running.localhost
versionNoAEDT version to connect to. If ``None``, the tool automatically detects the version.
design_nameNoDesign name to attach directly to a PyAEDT application session. If ``None``, the connection remains at the AEDT level.
project_nameNoProject name to activate when connecting directly to a design.
non_graphicalNoWhether AEDT is running in non-graphical mode.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A3.6/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 the transport (gRPC) and the server-side prerequisite, which is genuinely useful behavior context, but says nothing about failure modes (no running instance, wrong port), whether it mutates the environment by creating a PyAEDT session, or how long connection attempts take.

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?

Short and front-loaded: the core action is in the first sentence, with the prerequisite following. The second sentence largely restates the first before adding the prerequisite, so there is minor padding but nothing wasteful.

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, and all six parameters are fully covered by the schema. The missing piece is behavioral: what happens with multiple discovered sessions, and the relationship between design_name/project_name attachment and the resulting session scope, is left to the schema alone.

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 each of the six parameters (port, machine, version, design_name, project_name, non_graphical) is already documented in the schema with defaults and fallback behavior. The description adds no parameter meaning beyond that, 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?

The description states a specific verb and resource ('Connect to an existing AEDT instance via gRPC'), and the emphasis on 'existing' implicitly separates it from launch_aedt and disconnect_from_aedt. It does not name a sibling explicitly, so it stops short of a 5.

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 precondition for use: the AEDT instance must already be running with a gRPC server enabled, including the exact command form. What is missing is an explicit exclusion such as 'if AEDT is not running, use launch_aedt instead' or guidance on port/machine selection when multiple instances exist.

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