Skip to main content
Glama

update_submodel_element

Replace or create a Submodel element in an AAS server via full replacement.

Instructions

Updates or creates a Submodel element by full replacement.

Corresponds to: PUT /submodels/{submodel_id}/submodel-elements/{idShortPath}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hostNoBase URL of the AAS server. Defaults to configured host.http://localhost:8081
encodeNoWhether to Base64-encode the Submodel ID. Defaults to True.
elementYesA dictionary representing the new element content.
submodel_idYesThe unique identifier of the Submodel.
id_short_pathYesThe idShort path of the Submodel element.
Behavior3/5

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

With no annotations, the description must carry the behavioral disclosure burden. It does so by stating 'full replacement', which warns that any existing element at the path will be overwritten, and the 'Updates or creates' phrase implies an upsert behavior. However, it does not mention permissions, error scenarios, or what happens to omitted fields.

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 concise and front-loaded: the first line states the action and resource, the second gives the HTTP mapping. No superfluous words or redundancy.

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

Completeness3/5

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

For a write tool with no annotations and no output schema, the description explains the core replacement behavior and endpoint but does not mention return value, error handling, or response format. The schema covers parameters well, so the description is adequate but not fully complete for a 5-parameter tool with a nested object.

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% so the schema descriptions cover all parameters. The description adds context about 'element' being the new content and maps the path via the endpoint, but does not add syntax or format details beyond what the schema already provides. The baseline of 3 is appropriate.

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 clearly states the action ('Updates or creates') and the resource ('Submodel element') with a specific mechanism ('by full replacement'). This distinguishes it from related tools like update_submodel_element_value, which only updates the value, not the whole element.

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?

The description does not explicitly tell when to use this tool versus alternatives such as create_submodel_element or update_submodel_element_value. It mentions 'updates or creates' but does not explain when one would prefer the dedicated create tool or when this is the right choice over the value-only update tool.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/SmartFactory-KL/aas-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server