Skip to main content
Glama

get_submodel_metadata

Retrieves structural metadata for a Submodel identified by its unique ID. Enables inspection of the Submodel's elements and properties from an AAS server.

Instructions

Retrieves the metadata of a specific Submodel.

Corresponds to: GET /submodels/{submodel_id}/$metadata

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.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

The description indicates a read-only operation via 'Retrieves' and the corresponding GET endpoint, which is useful behavioral context. However, with no annotations provided, it does not disclose error handling, authentication requirements, or the exact structure of the returned metadata beyond what the output schema might cover.

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 two sentences with no filler. The first sentence states the action and target, the second provides the corresponding HTTP endpoint. Every word contributes value.

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?

Given the simplicity of the tool, complete schema coverage, and presence of an output schema, the description provides sufficient context for an agent to understand the tool's purpose. However, it lacks explicit sibling differentiation, which prevents a perfect score.

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?

The input schema has 100% coverage for all three parameters, so the description does not need to add parameter details. The description adds no additional meaning beyond the schema, which is acceptable given the baseline.

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 metadata for a specific Submodel, using a specific verb and resource. The 'Corresponds to GET /submodels/{submodel_id}/$metadata' further clarifies the exact operation and distinguishes it from the sibling get_submodel which retrieves the full submodel rather than its metadata.

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 guidance is provided on when to use this tool versus alternatives like get_submodel or get_submodel_value. The description implies its purpose but does not state usage context or exclusions.

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