Skip to main content
Glama

Get Instances By Id

GetV1InstancesById
Read-onlyIdempotent

Returns the instance bound to your API key or connection, showing its type (development or production) and onboarding status so you can confirm it can transact before moving funds.

Instructions

Returns the instance your API key or connection is bound to. Check type before moving money: development simulates settlement and moves no real funds, production moves real funds. onboarding_step is completed once the instance can transact.

Input Schema

NameRequiredDescriptionDefault
idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.9.3

TDQS

A3.6/5.0
Behavior4/5

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

Annotations already declare this as a safe, idempotent read. The description adds valuable domain context beyond annotations, especially that `development` simulates settlement while `production` moves real funds, and that `onboarding_step=completed` means the instance can transact.

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 three short sentences with no filler. The core purpose is front-loaded, followed by the most important safety and onboarding context.

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 read operation with rich safety annotations and no output schema, the description provides enough behavioral context to interpret key fields safely. The main remaining gap is the unexplained `id` parameter.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The schema has 0% description coverage for the single required `id` parameter, and the description does not explain what `id` represents, its expected format, or how it relates to the bound instance. It leaves the only parameter semantically undocumented.

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 a specific action and resource: it returns the instance tied to the API key or connection. It is clear enough to distinguish this as an instance lookup tool, though it does not explicitly reinforce the `id`-based selection from the tool name.

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?

It gives useful conditional guidance to check `type` before moving money and explains what `onboarding_step` means. However, it does not explicitly say when to use this tool versus sibling instance or onboarding tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools