Skip to main content
Glama

tc_session

Launch, connect to, or stop the 1C test client and control call logging to automate UI tests and record or replay scenarios.

Instructions

Connect to, launch or stop the 1C test client.

  • marks a required action parameter; the group schema treats action parameters as optional. Pass action="name" and only that action's parameters. Actions:

  • connect(port=null, host='127.0.0.1', version=null, profile=null) Connect to a running /TESTCLIENT -TPort client using port or a list_profiles profile; explicit parameters override the profile. version must match the full running version (omitted: built-in default). Connect before UI actions. A new host/port creates a connection; the same host/port reconnects that client: connection_id is retained, but find elements again.

  • disconnect(force=False) Close the connection to the test client. force=true interrupts a pending network call; its result may be unknown. The 1C application remains running.

  • get_logging_status() Return call logging status, paths, call count, disk usage and any reason recording stopped.

  • launch_client(base=null, port=null, server=False, user=null, password=null, version=null, exe=null, extra_args=null, wait=120, connect=True, desktop='default', profile=null) Launch and optionally connect. base is a file infobase path, or 'server\infobase' with server=true; alternatively use a list_profiles profile. Explicit parameters override the profile. user/password are infobase credentials; the password is visible in the process command line. exe is the full path to 1cv8/1cv8c (with .exe on Windows); omitted: configured or auto-detected installation. A version prefix selects the latest matching build; use a full version or exe for an exact build. Omitted port allocates a free local port; each launch creates a connection_id. wait covers total startup including readiness; increase for slow bases. Linux default needs DISPLAY/XAUTHORITY; isolated needs Xvfb. isolated uses a separate desktop (Windows 10+/Linux) and stops with the server. connect=false confirms only an answering port, not a usable client.

  • list_connections() List registered clients with connection_id, profile, host, port, base, user and recording status. busy, active_action and active_seconds describe the running call. connected reports an open connection, not client responsiveness. base/user are known for clients launched here.

  • list_profiles() List named launch/connect profiles and their descriptions and settings, without passwords. Pass the name as profile to the listed action. Does not connect to or launch a client.

  • start_logging(screenshot_mode=null, reports=null) Start a call journal. Repeated start keeps the current journal. screenshot_mode: off, actions (changes and errors), or all calls; default follows server settings. reports: ["html"], ["allure"], ["html", "allure"], or ["none"] for JSONL only. Omit reports to use the server's configured formats; the response lists the selected reports. Saves files on the server. Allure results are finalized when logging stops.

  • stop_client(graceful_timeout=15) Stop the test client started by launch_client in this connection, and disconnect from it. Tries normal exit for graceful_timeout seconds (0..120, default 15), confirming known exit questions, then forces termination if needed. 0 forces termination immediately. Unsaved changes may be lost. Returns shutdown: graceful, forced, or already_exited; forced includes shutdown_reason. A failed stop retains process ownership for retry.

  • stop_logging() Stop call logging, finalize selected reports and return their paths. Does not stop the client. Set connection_id when several clients are connected. Use tc_session(action="list_connections"). Success may omit target/connection echoes and shorten window details.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
exeNo
baseNo
hostNo
portNo
userNo
waitNo
forceNo
actionYes
serverNo
connectNo
desktopNo
profileNo
reportsNo
versionNo
passwordNo
extra_argsNo
connection_idNo
screenshot_modeNo
graceful_timeoutNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv1.7.1
    • addedInput schema / properties / force
      Added value: +{
      +  "default": null,
      +  "title": "Force",
      +  "type": "boolean"
      +}
    • addedInput schema / properties / graceful_timeout
      Added value: +{
      +  "default": null,
      +  "title": "Graceful Timeout",
      +  "type": "number"
      +}
    • addedInput schema / properties / reports
      Added value: +{
      +  "default": null,
      +  "items": {
      +    "enum": [
      +      "html",
      +      "allure",
      +      "none"
      +    ],
      +    "type": "string"
      +  },
      +  "title": "Reports",
      +  "type": "array"
      +}
  2. Changed3 schema fields changedv1.5.0
    • changedInput schema / properties / action / enum
      Previous value: -[
      -  "connect",
      -  "disconnect",
      -  "launch_client",
      -  "list_connections",
      -  "stop_client"
      -]New value: +[
      +  "connect",
      +  "disconnect",
      +  "get_logging_status",
      +  "launch_client",
      +  "list_connections",
      +  "list_profiles",
      +  "start_logging",
      +  "stop_client",
      +  "stop_logging"
      +]
    • addedInput schema / properties / profile
      Added value: +{
      +  "default": null,
      +  "title": "Profile",
      +  "type": "string"
      +}
    • addedInput schema / properties / screenshot_mode
      Added value: +{
      +  "default": null,
      +  "enum": [
      +    "off",
      +    "actions",
      +    "all"
      +  ],
      +  "title": "Screenshot Mode",
      +  "type": "string"
      +}
  3. Changed1 schema field changedv1.4.0
    • addedInput schema / properties / desktop
      Added value: +{
      +  "default": null,
      +  "enum": [
      +    "default",
      +    "isolated"
      +  ],
      +  "title": "Desktop",
      +  "type": "string"
      +}
  4. First observedv1.0.0

TDQS

A4.9/5.0
Behavior5/5

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

With no annotations, the description carries the full behavioral load and does so richly: password visible in the process command line, wait covers total startup including readiness, force=true may leave an unknown result, unsaved changes may be lost on stop, failed stop retains process ownership for retry, repeated start_logging keeps the current journal, and Allure results finalize only on stop.

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?

Length is justified by nine sub-actions. The dispatch grammar ('required action parameter... pass action="name" and only that action's parameters') is front-loaded, then each action is a compact bullet with only its own parameters and gotchas. No filler sentences.

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?

For a 19-parameter, action-dispatched tool with no annotations and no output schema, the description is complete: it covers connection semantics, credentials, launch/version selection, logging modes and report formats, shutdown result values (graceful/forced/already_exited), and even notes that success responses may omit echoes.

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?

Schema description coverage is 0%, so the description must compensate, and it largely does — port, host, version (full version vs prefix), profile override behavior, base ('server\infobase' with server=true), user/password, exe path rules, wait, desktop (isolated needs Xvfb), screenshot_mode, reports, graceful_timeout, and connection_id are all explained. Only extra_args is left undefined, a minor gap against 19 parameters.

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 states exactly what the tool is (a connection/launch/stop controller for the 1C test client) and enumerates all nine actions with their concrete purposes. Each action is a specific verb+resource (connect, disconnect, launch_client, start_logging...), and the sibling UI tools (tc_table, tc_app, etc.) are implicitly differentiated as post-connection actions.

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?

Explicit routing is given: 'Pass action="name" and only that action's parameters', 'Connect before UI actions', and 'Set connection_id when several clients are connected'. Action-level guidance includes when to use launch_client vs connect, and connect=false semantics vs. a real connection.

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