Skip to main content
Glama

begin_session

Start a persistent Python session in the O3DE editor for running scripts and automating editor workflows.

Instructions

Begin a persistent Python session in the O3DE editor.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.0

TDQS

A4/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 does disclose the key behavioral trait—that the session is persistent—but omits other important behaviors such as whether an existing session must be ended first, whether calling it twice creates multiple sessions, or what lifecycle cleanup is required.

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?

A single sentence that states the essential purpose without filler. Every word earns its place, and the most important qualifier ('persistent') is front-loaded.

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?

Given the zero-parameter schema, the presence of an output schema, and a relatively simple operation, the description is mostly sufficient. It could be slightly stronger by referencing the session lifecycle (e.g., using end_session), but nothing critical is missing for an agent to invoke this tool correctly.

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

Parameters4/5

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

The tool has zero parameters, so schema coverage is complete by nature. The description adds nothing about parameters, but none are needed; the 0-parameter baseline of 4 is appropriate.

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 names a specific action ('Begin'), a specific resource ('a persistent Python session'), and the environment ('in the O3DE editor'). It clearly distinguishes this from one-off execution tools like run_editor_python by emphasizing persistence.

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?

The word 'persistent' implies that this tool is for stateful, multi-step Python workflows rather than single commands, but the description does not explicitly say when to choose begin_session over run_editor_python or exec_in_session, nor does it mention pairing with end_session.

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