Skip to main content
Glama
itential

Itential MCP Server

Official
by itential

describe_instance

Retrieve instance details for a Lifecycle Manager resource using resource name and optional instance name, returning an error if the instance does not exist.

Instructions

Get details about an instance of a Lifecycle Manager resource

Gets the resource instance that is specified in the instance_name argument and returns the instance details. This function will return an error if the instance does not exist

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
instance_nameNoThe instance name
resource_nameYesThe Lifecycle Manager resource name

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
descriptionNoShort description of the instance
last_actionYesInformation about the last action performed on the instance
instance_dataNoData about the instance
Behavior3/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It does disclose that an error is returned if the instance does not exist, which is useful. However, it does not address what happens when the optional instance_name parameter is omitted, nor does it mention permissions or side effects. The description is minimally transparent but has 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 extremely concise, with a front-loaded purpose statement followed by a brief expansion. Every sentence contributes, and there is no fluff or redundant detail. It is well-structured and easy to parse.

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 2-parameter tool with an output schema, the description is largely complete: it states what is returned and the error condition. However, the optional nature of instance_name and its interaction with resource_name is not addressed, which leaves a small but relevant gap in understanding the tool's behavior.

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 context that instance_name is the argument identifying the instance, but it does not clarify the relationship with resource_name or the optionality of instance_name. It provides only marginal added meaning over the schema.

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's function: 'Get details about an instance of a Lifecycle Manager resource.' This uses a specific verb ('Get') and resource ('instance'), distinguishing it from sibling tools like describe_resource or describe_session.

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 implies usage by stating it gets the instance specified in instance_name, but it does not explicitly mention when to use this tool versus alternatives such as describe_resource. There is no when-not or alternative guidance, so the usage context is only implied.

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

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