Skip to main content
Glama
Plant Simulation Research Bridge

Plant Simulation Research Bridge

method_create

Create a Method object in a Plant Simulation frame and write its SimTalk source, enabling you to define reusable simulation logic within a model.

Instructions

Create a Method object in a frame and write its SimTalk source.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>",
      "source": "<source>"
    },
    "name": "method_create"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYes
sourceYes
work_dirNo
frame_pathNo
model_rootNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

C2.7/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full behavioral burden, and it only implies a mutation ('create ... and write'). It does not say what happens if a Method of that name already exists, whether an existing object is overwritten or an error is raised, what permissions or open-model state are required, or what the call returns. For an unannotated write tool this is a substantial disclosure gap.

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?

A single front-loaded sentence with zero filler that states the action and the payload in order. It is efficient rather than padded; the shortfall is under-specification, not verbosity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a five-parameter mutation tool with no annotations and no output schema, the definition leaves the optional targeting/path parameters and the failure modes entirely undocumented. An agent could construct the required arguments but would be guessing about frame resolution and collision behavior.

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

Parameters2/5

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

Schema description coverage is 0% across five parameters, and the description only weakly maps 'name' to the Method name and 'source' to SimTalk code. The three optional parameters (work_dir, frame_path, model_root) get no meaning at all, so an agent cannot tell how to target a frame or resolve paths relative to a model root.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description gives a specific verb+resource pair: creating a Method object inside a frame and writing its SimTalk source. That is enough to distinguish it from method_get_source and method_set_source, which read and rewrite source on an existing method. It stops short of explicitly contrasting itself with those siblings, so it is clear but not fully differentiated.

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

Usage Guidelines2/5

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

There is no statement of when to use this versus method_set_source (modify existing source) or generate_simtalk, and no prerequisites are given such as the frame needing to exist or the model being open. The agent must infer the create-vs-update boundary purely from the tool name.

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