Skip to main content
Glama

xae_open_solution

Idempotent

Opens a specified TwinCAT solution (.sln) in the attached engineering shell so agents can load and work with XAE projects by path.

Instructions

Open a .sln in the attached shell.

Input Schema

NameRequiredDescriptionDefault
pathYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.6.0

TDQS

B3/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=false, idempotentHint=true, and destructiveHint=false, so the safety/mutation profile is largely covered. The description adds only the implicit precondition that a shell must be attached; it says nothing about what happens on failure, whether the solution replaces the current project state, or whether it triggers a build/load.

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?

A single short sentence with the action front-loaded and no filler. It is efficient, though brevity here shades into under-specification rather than tight, information-dense writing.

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, but the lone parameter is undocumented and the dependency on a prior attach is only implied. For a simple one-parameter tool that is minimally adequate, not complete.

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% for the single required 'path' parameter, so the description carries the full burden and fails to add anything: no expected format (.sln extension, absolute vs relative, escaping). An agent must guess what a valid path looks like.

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 names a specific verb (Open) and resource (.sln solution file) and clarifies the operating context ('in the attached shell'). It does not, however, distinguish this from nearby siblings like xae_boot_project or xae_attach, so an agent must infer which entry point applies.

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?

There is no statement of when to use this versus xae_attach, xae_boot_project, or xae_activate_configuration, and no prerequisites (e.g. that a shell must already be attached). The phrase 'attached shell' hints at a precondition but never states it or tells the agent what to do if none exists.

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

Deploy Server

Other Tools