Skip to main content
Glama

catia_activate_document

Idempotent

Activates an already-open CATIA document, bringing it to the front and setting it as the target for subsequent modelling operations.

Instructions

Bring an already-open document to the front and make it the target of subsequent modelling calls.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
documentYesName or full path of the document.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.1

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already indicate idempotent and non-destructive behavior. The description adds valuable context by disclosing that the call changes focus and redirects subsequent modelling calls, which is a non-obvious side effect. It also specifies the already-open prerequisite.

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?

The description is a single clear sentence with no filler. The core action, prerequisite, and behavioral effect are all front-loaded and easy to parse.

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?

For a simple one-parameter tool with high schema coverage and no output schema, the description is nearly complete. It could additionally mention error behavior when the document is not open, but that is a minor gap.

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 schema covers the single parameter with 'Name or full path of the document.' The description adds the important constraint that the document must already be open, which is not stated in the schema. This extra semantic context helps agents choose a valid value.

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 a specific action: bringing an already-open document to the front and making it the target of subsequent modelling calls. This clearly distinguishes it from related siblings like catia_open_document, catia_close_document, and catia_set_active_body.

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

Usage Guidelines4/5

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

The description clearly implies when to use the tool: after a document is already open and before performing modelling operations on it. However, it does not explicitly mention alternatives or state when not to use it.

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