Skip to main content
Glama

create_submodel_element

Create a Submodel element at the root or nested path within a Submodel. Specify the element data and optional idShortPath to place it.

Instructions

Creates a Submodel element.

If id_short_path is given, creates the element at that nested path. Otherwise, creates the element at the root level.

Corresponds to: POST /submodels/{submodel_id}/submodel-elements POST /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 Submodel element to create.
submodel_idYesThe unique identifier of the Submodel.
id_short_pathNoThe idShort path for the new Submodel element.
Behavior3/5

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

No annotations are provided, so the description carries the full transparency burden. It discloses the key nested-path vs root behavior, but lacks details on idempotency, error handling, element structure requirements, or response format. For a mutation tool, this leaves some behavioral gaps.

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 succinct and front-loaded with the main verb+object. It uses a clear conditional and includes only relevant endpoint information. Every sentence contributes value without 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?

The combination of the schema and description covers all parameters and explains the unique nested path behavior. However, with no output schema or annotations, the description does not mention return values or potential errors. For an AAS API, it is reasonably complete given the schema's richness.

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 input schema covers all parameters, and the description adds meaning to id_short_path by explaining its effect on the creation location. It also maps parameters to the HTTP endpoints. The 'element' parameter remains abstract, but the schema provides an adequate description.

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 'Creates a Submodel element' with a specific verb and resource. It distinguishes behavior based on id_short_path, separating it from siblings like create_submodel or update_submodel_element. The HTTP mapping further clarifies the exact endpoints.

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 implies when to use the tool by explaining the action and the two path scenarios, but it does not explicitly mention alternatives or when not to use it. The sibling names provide context, but no explicit exclusions are given.

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