Skip to main content
Glama

LogNexus State: Synchronize state from Git branch and GitHub

lognexus_state_sync

Reconcile stored state with the current Git branch and GitHub metadata, then rewrite .lognexus/state.json. Use after branch changes, rebases, or PRs to replace stale state.

Instructions

Reconcile the persistent state with the current Git branch and GitHub metadata, rewriting .lognexus/state.json and returning the updated state. Use when you just checked out a branch, rebased, opened a PR, or suspect the stored state is stale. Not for a plain read of what is already on disk (use lognexus_state_get); sync mutates the store and runs git and gh.

Example tool call

This call uses example arguments supplied in the tool’s input schema.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "lognexus_state_sync"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv1.2.6
    • addedInput schema / examples
      Added value: +[
      +  {}
      +]
  2. First observedv0.1.0

TDQS

A4.6/5.0
Behavior4/5

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

No annotations are supplied, so the description carries the full burden, and it does disclose key traits: it mutates the store, rewrites .lognexus/state.json, and shells out to git and gh (implying local repo and GitHub auth/network requirements). It stops short of stating failure behavior, idempotency, or what happens to existing local state on conflict.

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?

Three sentences, each earning its place: purpose/side effects first, then use cases, then the exclusion with the alternative. The mutating nature is front-loaded before the routing guidance.

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?

For a zero-param tool with no output schema, the description covers the mutation target, external dependencies, and that the updated state is returned. The remaining gap is error/conflict handling, which matters for a tool that rewrites a state file but is not strictly required to invoke it correctly.

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, so there is nothing for the description to clarify beyond the empty schema; baseline 4 applies. The description correctly implies no arguments are needed.

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?

Names a specific verb (reconcile/sync) and resource (persistent state), plus the concrete artifacts involved: the Git branch, GitHub metadata, and .lognexus/state.json. It explicitly distinguishes itself from the read-only sibling lognexus_state_get, so an agent can pick correctly without opening either 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?

Gives explicit triggers (after checkout, rebase, opening a PR, suspected staleness) and an explicit exclusion with a named alternative: 'Not for a plain read of what is already on disk (use lognexus_state_get)'. Both when-to-use and when-not-to-use are covered.

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