Skip to main content
Glama

get_submodel

Fetch a specific submodel by its ID from an AAS server. Get submodel data via the BaSyx REST API.

Instructions

Retrieves a specific Submodel by its ID.

Corresponds to: GET /submodels/{submodel_id}

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

Behavior4/5

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

With no annotations, the description carries the burden of safety disclosure. It explicitly states 'GET /submodels/{submodel_id}', clearly indicating a read-only, side-effect-free operation. It does not mention the base64 encoding behavior or error cases, but the HTTP method provides a solid transparency baseline.

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 short sentences, front-loaded with the action and resource, followed by a concise HTTP endpoint. Every word earns its place, with no unnecessary detail.

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?

For a simple retrieval tool with an output schema, the description is sufficient. It explains the core purpose and endpoint. However, it does not explicitly differentiate from near siblings like get_submodel_value or get_submodel_metadata, which slightly limits contextual completeness.

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 provides 100% coverage with descriptions for all three parameters (host, encode, submodel_id). The tool description itself adds no additional parameter semantics beyond what the schema already documents, so baseline 3 applies.

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 'Retrieves a specific Submodel by its ID,' using a specific verb and resource, and also provides the HTTP endpoint. This distinguishes it from siblings like get_submodels (plural), get_submodel_value, and get_submodel_metadata.

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 usage when a specific submodel ID is known, reinforced by the GET endpoint. It does not explicitly mention alternatives or exclusions, but the context is clear enough for an agent to select this tool for retrieving a single submodel.

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