Skip to main content
Glama
mystify59

ansys-mechanical-mcp

by mystify59

inspect_workbench_project

Enumerate systems and cells in a saved ANSYS Workbench project to inspect its structure.

Instructions

[READ ONLY] Enumerate systems and cells in a saved Workbench project.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_pathYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

B3.1/5.0
Behavior3/5

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

The description explicitly marks the tool as READ ONLY, which is a useful behavioral disclosure given no annotations exist. It also clarifies it operates on a saved project, implying it does not require an open session. However, it does not disclose any failure modes, prerequisites, or side effects beyond the read-only nature, which is minimal but adequate for a simple inspection tool.

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?

One concise sentence with the read-only flag front-loaded. No filler or redundancy. The information density is high for its length.

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?

The tool is simple with one parameter and an output schema, so the description covers the core action. However, it lacks context on when to use it relative to sibling inspection tools and does not clarify whether the project must be opened first or if it reads directly from disk. This leaves some operational ambiguity for an agent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, so the description must compensate. It mentions 'saved Workbench project', giving context that project_path should point to a saved project, but does not specify expected format, file type, or path structure. For a single parameter, this is insufficient semantic addition beyond the parameter name itself.

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?

States a specific verb (enumerate) and resource (systems and cells in a saved Workbench project). The purpose is clear, though it does not explicitly differentiate from sibling tools like get_tree or get_project_info, leaving some scope ambiguity.

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

Usage Guidelines2/5

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

No guidance on when to use this tool versus siblings. It does not mention alternatives or conditions that would select this tool over others like get_project_info or get_tree. The description only implies use for inspecting project structure without explicit context.

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