Skip to main content
Glama

Add Session

add_session

Manually register a Maya session at a known host and port when auto-discovery fails or you need to connect to a specific Maya instance.

Instructions

Manually add a Maya session at a specific host and port.

Boundary: Disambiguated from list_sessions (report the sessions the SessionManager already discovered) and maya_setup_guide (diagnose and repair a connection) — add_session registers a host:port you already know.

Use this when auto-discovery doesn't find your Maya session, or to connect to a Maya instance on a specific port.

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

Input Schema

NameRequiredDescriptionDefault
hostNoThe session host (default: "127.0.0.1")127.0.0.1
portNoThe session port number (default: 7001)

Output Schema

NameRequiredDescriptionDefault
pidYes
hostYes
portYes
userYes
scene_nameNo
scene_pathNo
session_keyYes
maya_versionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.4.1

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare the safety profile (not read-only, not destructive, not idempotent), so the description's contribution is the registration semantics — this writes an entry into the session registry rather than probing the network. It does not say what happens if that host:port is already registered, whether the registration persists, or what an unreachable host does, which matters given idempotentHint=false.

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?

Front-loaded with the action, then boundary, then usage — a sensible ordering for a routing-sensitive tool. Slight redundancy: the Boundary sentence and the 'Use this when' paragraph restate the same disambiguation from two angles, which costs a few words without adding much.

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?

An output schema exists, so return values need no explanation, and both optional parameters are fully documented in-schema. What remains unaddressed is the failure/duplicate path for a non-idempotent mutation, which is the one thing an agent calling this twice would want to know.

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 coverage is 100% and both parameters carry default values and descriptions, so the schema does the heavy lifting. The description only echoes 'host:port' in prose — it adds no syntax, validation, or port-range guidance beyond what the schema already states.

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 first sentence states a specific verb and resource — manually registering a Maya session at a given host and port — and the Boundary line explicitly separates it from list_sessions (discovery reporting) and maya_setup_guide (diagnosis/repair). An agent can pick this tool out of a 24-sibling list without opening any schema.

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

Usage Guidelines5/5

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

It gives both a positive trigger (auto-discovery failed, or you know a specific port) and explicit alternatives with the condition that selects each. Nothing about when to prefer list_sessions or maya_setup_guide is left to inference.

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