Skip to main content
Glama
PyAEDT-MCP
by yuxuan6426

Get Pyaedt Logs

get_pyaedt_logs

Retrieve recent PyAEDT file logs and native AEDT Desktop info/error messages for the active project and design, with optional case-insensitive filtering and tail limits.

Instructions

Return recent PyAEDT file logs and native AEDT Desktop messages.

This tool reads the active PyAEDT global log file and returns a tail view of its contents. When AEDT is connected, it also retrieves native info and error messages for the active project and design. Optionally filter file log lines using a case-insensitive substring.

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

Input Schema

NameRequiredDescriptionDefault
containsNoCase-insensitive substring used to filter log lines.
max_charsNoHard cap for returned file-log text length.
tail_linesNoNumber of recent lines to return after filtering.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does reasonably well: it discloses that it reads the active global log, returns only a tail view, adds native info/error messages conditionally on AEDT being connected, and that filtering is case-insensitive. It leaves unstated what happens when no log file exists or AEDT is disconnected, and does not restate read-only/safety properties, keeping it shy of a 5.

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?

The content is front-loaded with what is returned, followed by the source, the conditional AEDT behavior, and the optional filter, in a logical order. Each sentence contributes, though the phrasing is slightly verbose and a bulleted structure would read faster.

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?

An output schema exists, so return-value detail is not required in the description, and the tool is a simple read with three optional parameters. The description covers the data sources, the conditional AEDT connection case, and filtering behavior, which is everything an agent needs to call it correctly.

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 all three parameters (contains, max_chars, tail_lines) are already documented in the schema, making 3 the baseline. The description reinforces the case-insensitive filter and the 'tail view' idea that maps to tail_lines, but adds no new syntax, interaction, or precedence detail beyond what the schema provides.

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 uses a specific verb and resource: returns recent PyAEDT file logs plus native AEDT Desktop messages. It further scopes the source (the active PyAEDT global log file, a tail view) and the optional AEDT-connected path, so an agent knows exactly what this tool produces and can distinguish it from siblings like check_aedt_status or run_python_code.

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 implied rather than stated: 'This tool reads the active PyAEDT global log file' tells the agent the data source, and the AEDT-connected clause signals the additional case. There is no explicit 'use this when...' guidance, no statement of when not to use it, and no named alternative for diagnostics.

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