Skip to main content
Glama

get_submodel_element

Retrieve a specific Submodel element by its idShort path from an AAS server. Use this to access individual elements without fetching the entire Submodel.

Instructions

Retrieves a specific Submodel element by its idShort path.

Corresponds to: GET /submodels/{submodel_id}/submodel-elements/{id_short_path}

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.
submodel_idYesThe unique identifier of the Submodel.
id_short_pathYesThe idShort path of the Submodel element.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior2/5

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

With no annotations, the description carries full responsibility for disclosing behavioral traits. It only says 'Retrieves' and gives the endpoint, omitting the significant default behavior that submodel_id is Base64-encoded (as revealed by the 'encode' parameter default in the schema). No side effects, authentication needs, or potential error conditions are mentioned.

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 exceptionally concise and front-loaded: a single action-oriented sentence followed by the corresponding endpoint. Every word contributes to understanding the tool's core purpose, with no redundancy or filler.

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?

Given the presence of an output schema and fully described parameters, the description is minimally complete for a simple retrieval tool. However, the lack of guidance on when to prefer this over sibling tools and the absence of any mention of the encoding behavior leave gaps. The description does not fully prepare an agent to handle the encode default or to distinguish value retrieval.

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 description coverage is 100%, so the baseline is 3. The description adds minimal semantic value beyond the schema; it reuses the term 'idShort path' but does not explain parameter relationships or encode behavior. It correctly implies that submodel_id and id_short_path are the core identifiers, but adds no new meaning.

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 tool 'Retrieves a specific Submodel element by its idShort path,' identifying the verb, resource, and scoping mechanism. It distinguishes from sibling tools like get_submodel_elements (plural) and get_submodel_element_value (value-only retrieval) by emphasizing the element object and path-based lookup.

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?

No explicit usage guidance is provided. The description does not state when to use this tool versus alternatives such as get_submodel_elements or get_submodel_element_value, nor does it mention any prerequisites or conditions. The endpoint reference is informative but does not clarify selection criteria.

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