Skip to main content
Glama

catia_run_script

Destructive

Run custom VBScript functions in CATIA and retrieve results, enabling access to any API or object-model feature not covered by dedicated tools.

Instructions

Run a VBScript function inside CATIA and return its value. This is the escape hatch to the whole CATIA object model, including anything this server has no dedicated tool for and any API that only exists on some releases. The script must define the named function; CATIA is passed in automatically as the first parameter unless you pass your own. Returns whatever the function returns.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
scriptYesFull VBScript source, defining the function named below. Example: 'Function Run(catia)\n Run = catia.Documents.Count\nEnd Function'
functionNoName of the function inside the script to call.Run
pass_applicationNoPass the CATIA Application object as the first argument to the function. Turn this off if your function takes no arguments.

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 flag destructiveHint=true and idempotentHint=false; the description adds that arbitrary CATIA object model access is possible, CATIA is passed as the first argument automatically, and the return value is whatever the function returns. No contradiction with annotations.

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?

Three focused sentences front-load the purpose, then provide selection guidance and invocation semantics. Every sentence earns its place; no filler or redundancy.

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 high-complexity escape-hatch tool with no output schema, it explains what the script must define, how CATIA is passed, and what is returned. Potential side effects are covered by the destructiveHint annotation, though error behavior is not described.

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% with clear parameter descriptions and an example, so the baseline is 3. The description adds some context about automatic CATIA passing, but most parameter meaning is already present in the schema.

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?

States a specific action: run a VBScript function inside CATIA and return its value. Positions itself as the 'escape hatch' to the whole CATIA object model, clearly distinguishing it from the many dedicated sibling tools.

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?

Explicitly says to use it for anything the server has no dedicated tool for and for release-specific APIs. The escape-hatch framing tells the agent this is the fallback when no specialized sibling applies.

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