Skip to main content
Glama

omnistate_explain_rules

Explains transaction lifecycle rules and guardrails for AI coding assistants, clarifying how governed code-change workflows operate.

Instructions

Explain the OMNISTATE transaction lifecycle rules and guardrails for AI coding assistants.

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A3.6/5.0
Behavior3/5

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

With no annotations at all, the description must carry the behavioral burden; 'Explain' implies a non-mutating informational call, but this is inference rather than stated. It does not say whether the output is static documentation or state-dependent, and there is no output schema to fall back on.

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?

A single front-loaded sentence with no filler; the verb and subject arrive immediately.

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 zero-param, no-annotation, no-output-schema tool, the description covers the topic but not the return shape or invocation context. One clause on what the explanation covers (e.g., states, transitions, guardrail violations) would close the gap.

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?

Zero parameters, so the baseline of 4 applies; the description correctly implies no inputs are needed and nothing contradicts that.

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 ('Explain') and resource ('OMNISTATE transaction lifecycle rules and guardrails'), which clearly distinguishes it from the operational siblings (begin/step/finish) that actually act on transactions. It is clear what the tool returns conceptually, though the phrase 'for AI coding assistants' is audience framing rather than scope.

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: an agent can infer this is the reference lookup to consult for the lifecycle rules, presumably before or alongside using omnistate_begin/step/finish. It never says when to call it versus just proceeding, nor whether it must be called before starting a transaction.

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