Skip to main content
Glama

Wait for an index to build

wait_for_index
Read-onlyIdempotent

Poll an index until its build is ready or has failed. Every poll is a metered request (starting 1 second apart, slowing to 10 seconds); the result says how many were made. A failed build is an error; running out of time returns timedOut: true with buildStatus "building".

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
listYesThe list: its id or pathName
indexYesThe index: its id or pathName
timeoutSecondsNoHow long to wait (1-120 seconds)

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
indexYes
pollsYes
buildStatusYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior5/5

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

Annotations already mark it readOnly, idempotent, and non-destructive, and the description adds substantial behavior beyond them: polling is metered, intervals start at 1s and back off to 10s, the result reports poll count, a failed build surfaces as an error, and a timeout returns timedOut: true with buildStatus "building". This is exactly the context an agent needs to handle the call's cost and outcomes.

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?

Two dense sentences, terminal conditions first, then cost/backoff behavior, then the failure and timeout outcomes. Every clause carries information and nothing is padding.

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?

An output schema exists, yet the description still usefully explains the salient return semantics (poll count, timedOut, buildStatus). Combined with full schema coverage and annotations, an agent has everything needed to call and interpret this tool.

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 list, index, and timeoutSeconds are documented in the schema itself; baseline is 3. The description only alludes to the timeout ('running out of time') without adding format or default detail beyond what the schema already provides.

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?

States a specific verb (poll) and resource (index) plus the terminal conditions (ready or failed), which cleanly separates it from rebuild_index, create_index, and list_indexes. An agent can identify the operation without opening the schema.

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?

Usage is implied (call it after kicking off an index build to block until completion), but no sibling is named and no explicit when-to-use/when-not guidance is given. A reader must infer that this replaces manual polling via list_indexes.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources