Skip to main content
Glama
PyAEDT-MCP
by yuxuan6426

Launch Aedt

launch_aedt

Starts a new Ansys Electronics Desktop (AEDT) instance, optionally for a specific version or application, and connects it for subsequent PyAEDT operations.

Instructions

Launch a new AEDT instance.

This tool starts a new AEDT instance using PyAEDT's Desktop class, or it launches directly into a specific AEDT application session when requested. The launched instance is automatically connected and stored in the context for subsequent operations.

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

Input Schema

NameRequiredDescriptionDefault
versionNoAEDT version to launch (such as ``"2026.1"`` or ``"261"``). If ``None``, the latest installed version is used.
applicationNoAEDT application to launch directly, such as ``"Hfss"`` or ``"Maxwell3d"``. If ``None``, AEDT launches in desktop mode.
non_graphicalNoWhether to launch AEDT in non-graphical mode. If ``False``, AEDT launches with the GUI visible.
confirm_new_sessionNoWhether a new AEDT instance should be launched even when one or more connectable AEDT sessions are already available.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations, the description must carry the full behavioral burden, and it does disclose two meaningful traits: the new instance is automatically connected and stored in the context for subsequent operations, and launching can target desktop mode vs. a specific app. It omits what happens when connectable sessions already exist, whether launching blocks or is slow, and failure/licensing behavior — significant for a process-spawning tool.

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?

Three short sentences, front-loaded with the core action, with no filler or repetition of schema content. Slightly inefficient in the split between sentence one and two, which restate the launch action before adding the new information.

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?

An output schema exists, so return-value explanation is not required, and the context-storage note helps chain this tool with later calls. However, for a side-effecting launch tool with no annotations, the description leaves out the practical consequences of confirm_new_session and what state the environment is left in on failure.

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%, including defaults, enum values, and version-string examples, so the description adds essentially no parameter meaning beyond the schema. Baseline 3 applies; the mention of "when requested" loosely corresponds to the application parameter but conveys nothing new.

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 opens with a specific verb and resource ("Launch a new AEDT instance") and adds a mechanism detail: PyAEDT's Desktop class, or a direct application session. It is distinguishable from siblings like connect_to_aedt or check_aedt_status, though it never names them, so the differentiation is implied rather than stated.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

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

Usage is only implied by the phrase "or it launches directly into a specific AEDT application session when requested" — the reader must infer that this selects the application branch of the tool. Nothing says when to prefer this over connect_to_aedt or what to do if an instance is already running; that decision is only hinted at through the confirm_new_session parameter.

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