Skip to main content
Glama

Sync status

get_sync_status
Read-onlyIdempotent

Returns a coherent local index snapshot and a separately observed Bitcoin Core tip height. The two heights can differ during indexing or a reorg. Conditional requests refresh these observations before validation.

REST operation: GET /api/server/sync.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedOutput schema / $defs / Height / format
      Removed value: -"uint32"
    • addedOutput schema / $defs / SyncStatus / properties / last_indexed_at / format
      Added value: +"date-time"
    • removedOutput schema / $defs / Timestamp / format
      Removed value: -"uint32"
  2. First observed

TDQS

A3.8/5.0
Behavior4/5

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

Annotations already establish this as a read-only, idempotent, non-destructive call, so the bar is lowered. The description still adds genuine context the annotations do not: the two heights may legitimately diverge, and conditional requests re-observe the values before validation — a caching/ETag nuance an agent would otherwise misinterpret as stale data.

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?

Four short sentences, front-loaded with the return semantics before the edge-case note and the REST route. The 'Conditional requests refresh these observations before validation' line is terse to the point of being cryptic, but nothing is redundant.

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?

With an output schema present and annotations covering the safety profile, the description only needs to explain the semantic subtlety of two divergent heights, which it does. It stops short of stating what a caller should conclude from a non-zero divergence, leaving interpretation to the schema.

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

Parameters4/5

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

The tool takes zero parameters and the schema is closed with additionalProperties=false, so baseline is 4. Nothing in the description is needed to explain inputs, and the return-shape explanation is left to the output schema.

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 names a specific resource (sync status) and states precisely what is returned: a coherent local index snapshot plus a separately observed Bitcoin Core tip height. It is clear enough to distinguish from the block/tip siblings, but never explicitly contrasts with get_block_tip_height or get_block_status, which report related heights.

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 only implied: 'can differ during indexing or a reorg' hints at when an agent would care (diagnosing index lag or a chain reorg), but there is no explicit when-to-use, when-not, or named alternative such as get_block_tip_height for the raw tip alone.

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.