Skip to main content
Glama

Get Instances Rfi

GetV1InstancesRfi
Read-onlyIdempotent

Retrieves the pending RFI for a specified instance, returning null when no open RFI exists.

Instructions

Returns the open (pending) RFI for this instance, or null if the instance has no pending RFI.

Input Schema

NameRequiredDescriptionDefault
instance_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.9.3

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds real value by disclosing the filtering behavior ('open (pending)') and the null-when-absent return contract, but says nothing about what an RFI object looks like or whether history is reachable elsewhere.

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

Conciseness4/5

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

A single front-loaded sentence with no waste. The parenthetical '(pending)' is mildly redundant with 'open' but serves as a synonym bridge for matching against API docs using either term.

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

Completeness3/5

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

For a simple one-parameter read with strong annotations, the essentials are present. However, with no output schema the description carries the burden of explaining the return value, and it only says the result is an 'RFI' without characterizing fields or shape.

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 coverage is 0% for the single instance_id parameter, so the description is the only source of meaning. 'For this instance' confirms the parameter's target, but it adds no format, length, or validity detail beyond what the parameter name already implies.

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?

States a specific verb and resource ('Returns the open (pending) RFI') and scopes it to 'this instance', which implicitly distinguishes it from the customer-level RFI siblings. It stops short of naming the sibling it differs from, so an agent must infer the instance-vs-customer split from the name alone.

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 explicit when-to-use guidance and no mention of alternatives such as GetV1InstancesCustomersRfi or the related PostV1InstancesRfi. The only conditional information is the null case, which describes the result rather than when an agent should reach for this tool.

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