Skip to main content
Glama

LogNexus Note: Show Git Note attached to commit

lognexus_note_show

Read and parse the LogNexus Git note attached to a commit to verify its tier, subtask and contract before review or merge. Defaults to HEAD; use lognexus_note_attach to create or repair notes.

Instructions

Read the LogNexus Git Note (refs/notes/lognexus) attached to a commit and return its parsed JSON payload. Defaults to HEAD. Use when verifying that a commit carries the expected tier, subtask and contract before a review or a merge. Not for creating or repairing notes (use lognexus_note_attach).

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": {
      "commitRef": "HEAD"
    },
    "name": "lognexus_note_show"
  }
}

Input Schema

NameRequiredDescriptionDefault
commitRefNoGit commit reference (SHA, branch, tag or HEAD). Defaults to HEAD.

Schema Changelog

Changes observed during successful MCP inspections.

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

TDQS

A4.2/5.0
Behavior3/5

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

With no annotations, the description must carry behavioral burden; it does disclose the read-only nature, the note ref, and the HEAD default. However, it does not say what happens when a commit has no LogNexus note (error vs. empty result), which is the main failure mode an agent would encounter.

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 tight sentences: what it does, how to use it, and what it is not for. The core purpose is front-loaded and nothing is wasted.

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 one-parameter read tool with no output schema, it is largely complete, indicating the payload is parsed JSON with tier/subtask/contract fields. The absence of a missing-note behavior description keeps it from full completeness.

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

Parameters3/5

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

Schema coverage is 100% and the single commitRef parameter is fully documented, including its HEAD default. The description only repeats the HEAD defaulting, adding no new semantic detail beyond the schema.

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 (read) and resource (LogNexus Git Note at refs/notes/lognexus) and describes the return as a parsed JSON payload. It is clearly distinguishable from the sibling lognexus_note_attach, which handles creation.

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 triggering context ('verifying that a commit carries the expected tier, subtask and contract before a review or a merge') and an exclusion with a redirect ('Not for creating or repairing notes (use lognexus_note_attach)'). 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.