Skip to main content
Glama
idfkit

idfkit-mcp

Official
by idfkit

describe_object_type

Read-onlyIdempotent

Retrieve the field schema for an EnergyPlus object type, including types, constraints, defaults, and references. Use this before adding objects to ensure correct structure.

Instructions

Field schema with types, constraints, defaults, and references. Call before adding objects.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
versionNoEnergyPlus version as "X.Y.Z".
object_typeYesObject type name (e.g. "Zone", "Material").

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
memoYes
fieldsYes
doc_urlNo
has_nameYes
object_typeYes
is_extensibleYes
extensible_sizeYes
required_fieldsYes
extensible_groupNo
Behavior4/5

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

Annotations already indicate readOnlyHint=true, so the tool is safe. The description adds specific behavioral context about the returned content (schema with types, constraints, defaults, references), which aids the agent beyond the annotations.

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 extremely concise (8 words) and front-loaded. Every word earns its place, providing essential information without verbosity.

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

Completeness5/5

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

The description is complete given that an output schema exists (not shown but context indicates its presence) and the tool is a simple read-only schema retrieval. It tells the agent when to use it (before adding objects) and what it returns.

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?

Input schema has 100% description coverage, so parameters are well-defined. The description does not add extra semantic detail about parameters beyond what the schema provides, meeting the baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states it provides a field schema with types, constraints, defaults, and references, and instructs to call before adding objects. The purpose is clear but could explicitly state the action 'describe'. It distinguishes from sibling manipulation tools.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description gives a when-to-use context ('Call before adding objects') but does not mention when not to use or alternatives among siblings like search_schema or list_objects.

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/idfkit/idfkit-mcp'

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