Skip to main content
Glama

Get Instances Onboarding Business Profile

GetV1InstancesOnboardingBusinessProfile
Read-onlyIdempotent

Retrieve an instance's onboarding business profile using its instance ID to review business details for setup and verification.

Instructions

Retrieve Business Profile

Input Schema

NameRequiredDescriptionDefault
instance_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.9.3

TDQS

C2.1/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, and openWorldHint=true, so the safety profile is covered. The description adds nothing beyond that — no information about what the profile contains, whether onboarding must be in progress, or what happens if no profile exists.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The three-word description is as brief as possible and front-loaded, but its brevity comes from omission rather than economy — it is under-specified rather than tight.

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

Completeness2/5

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

Given the tool has no output schema and competes with a near-identically named sibling, the description should clarify scope and return content but does neither. An agent cannot determine from this text what a 'Business Profile' returns or how it differs from BusinessDetails.

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?

Schema description coverage is 0% for the single required parameter, instance_id. The description says nothing about it, though the schema does supply a format example (in_ + 12 digits) and length constraints, which partially compensates.

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

Purpose2/5

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

The description is essentially a restatement of the tool name/title: 'Retrieve Business Profile' adds only the verb 'Retrieve' to what the name already conveys. It does not distinguish this tool from the very similar sibling GetV1InstancesOnboardingBusinessDetails, which an agent would have no basis for choosing between.

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?

There is no guidance on when to use this tool, no prerequisites, and no mention of alternatives. The closest sibling, GetV1InstancesOnboardingBusinessDetails, is never referenced, leaving the agent to infer the distinction on its own.

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