Skip to main content
Glama

Initiative Read

initiative_read
Read-onlyIdempotent

Read current initiative state without changing turn order or advancing combat. Use it for safe status checks; timeouts return stale state, not proof combat is inactive.

Instructions

Read initiative state without changing turn order or advancing combat. Use initiative_manage to modify combat and events_poll for broadcast history. Campaign members may read. By default, request a new WS state and wait up to two seconds; timeout returns state=null/stale=true, not proof that combat is inactive. refresh=false reads the current connection's cache and marks it stale. Repeated requests do not change initiative; WS authentication is still required. State is recipient-filtered and only current-generation data is treated as fresh. Returns {ok:true,data} on success; tool-body failures return {ok:false,error} with optional diagnostic data. Argument-schema errors are MCP errors.

Input Schema

NameRequiredDescriptionDefault
refreshNoTrue requests and waits for fresh state; false uses cached state, which may be absent or stale.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.3.0

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing timeout semantics (up to two seconds, timeout returns state=null/stale=true and is not proof combat is inactive), cache staleness under refresh=false, idempotence rationale, WS authentication requirement, recipient filtering, and freshness generation rules. This is exactly the kind of behavioral context annotations cannot carry.

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?

Front-loaded with purpose and alternative routing, then behavior and return contract. Dense but every sentence carries operational information; the only mild cost is readability from packing many clauses together.

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?

Covers routing, permissions, timeout semantics, caching, idempotence, and the success/failure return envelopes even though an output schema exists. Nothing an agent needs to call this correctly appears to be missing.

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?

Schema coverage is 100% so the schema already documents the single 'refresh' parameter, but the description adds real meaning: the two-second wait, the null/stale timeout result, and the stale-marking cache path. That is more than restating the schema, though not exhaustive.

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 and resource ('Read initiative state') plus the key negative scope ('without changing turn order or advancing combat'), which immediately separates it from initiative_manage. An agent can identify this tool's role without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly names the alternatives and when to use them: initiative_manage for modifying combat, events_poll for broadcast history. Also states the access precondition ('Campaign members may read') and the refresh=true/false selection rule.

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