cozyvtt-mcp

Initiative Read

initiative_read

Read-onlyIdempotent

Read current initiative state without altering turn order or advancing combat. Get fresh or cached state to check whose turn it is.

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. 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

TableJSON Schema

Name	Required	Description	Default
`refresh`	No	True requests and waits for fresh state; false uses cached state, which may be absent or stale.

Output Schema

TableJSON Schema

Name	Required	Description	Default
No arguments

Schema Changelog

Changes observed during successful MCP inspections.

Addedv0.3.0Sep 20, 2026

TDQS

A5/5.0

Behavior5/5

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

The description goes well beyond annotations by explaining WS refresh behavior, the two-second timeout, the meaning of stale=true, the difference between refresh=true and refresh=false, and that repeated requests do not change initiative. It also covers authentication requirements and error return shapes, providing rich behavioral context.

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?

The description is well-structured and front-loaded: purpose first, then alternatives, access, behavior details, and return contract. Every sentence adds value, and the length is appropriate for the complexity of the tool.

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?

Given the presence of a rich output schema, comprehensive annotations, and a single parameter, the description covers all necessary contextual aspects: usage intent, sibling differentiation, access control, caching and timeout behavior, authentication, and error handling. Nothing important is missing.

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

Parameters5/5

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

Although the schema already documents the refresh parameter with 100% coverage, the description adds crucial semantics: by default it requests a new WS state and waits up to two seconds, timeout yields state=null/stale=true, and refresh=false uses cached state and marks it stale. This meaningfully enhances the parameter's interpretation.

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?

The description states a specific verb and resource: 'Read initiative state'. It further clarifies the read-only nature by saying it does not change turn order or advance combat, and it names sibling tools (initiative_manage, events_poll) for comparison, making the tool's purpose unmistakable.

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?

Explicit guidance is given: use initiative_manage to modify combat and events_poll for broadcast history. It also states that campaign members may read, providing access context. This clearly distinguishes when this tool should be selected over siblings.

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