CommitLore
CommitLore’s MCP server lets an agent inspect Git-recorded decisions and run the assisted capture workflow before committing.
Report the exact CommitLore runtime, package root, version, and index schema.
Query active records for the whole repo or a path, by kind: context, limits, ruled-out, or warnings.
List stale records: superseded, expired, or flagged for review.
Guard a proposed approach against ruled-out alternatives for a path; returns matches and rejection reasons, but it is an experimental advisory.
Get combined context and optional guard for a path before editing.
Prepare a capture transaction from a session transcript, producing binding state and a nonce.
Verify a capture draft against the transcript and staged diff, discarding fabricated quotes.
Stage a verified capture so it can be picked up by the prepare-commit-msg hook.
curl -fsSL https://raw.githubusercontent.com/MongLong0214/commitlore/v1.2.18/install.sh | sh -s v1.2.18curl -fsSLO https://raw.githubusercontent.com/MongLong0214/commitlore/v1.2.18/install.sh
sh install.sh v1.2.18
# Or skip the script: the checkout it makes is one you can make yourself.
git clone --depth 1 --branch v1.2.18 https://github.com/MongLong0214/commitlore
node commitlore/dist/commitlore.mjs --versionIt installs a pinned source checkout and a wrapper that runs
node <checkout>/dist/commitlore.mjs — no compiled download, no build step.
The code survives. The judgment doesn't.
An agent proposes an approach. Your team rejects it because of a non-obvious constraint. The final code preserves the outcome, but usually not why the alternative was rejected. A later agent sees only the code and proposes the same idea again.
CommitLore keeps that judgment beside the code.
What CommitLore does
Behavior | Product path | |
Captures | Preserves constraints, rejected alternatives, and warnings that a diff cannot show. Candidates are checked against the session transcript and the staged diff. |
|
Preserves | Stores accepted records in Git trailers or notes instead of a hosted memory database. | commit hooks · |
Tracks lifecycle | Keeps active, superseded, and expired decisions distinct. |
|
Scopes | Selects decisions for the path an agent is about to edit. |
|
Grades trust | Delivers records as directives, claims, or withheld content. | default / signed mode |
Delivers | Gives supported agents current context before an edit. | plugin hook · MCP |
Most commits should carry no record. CommitLore is for judgment the code cannot preserve, not for narrating every change.
Related MCP server: Hypermnesic
60 seconds to decision-aware agents
1. Install the CLI
macOS and Linux:
curl -fsSL https://raw.githubusercontent.com/MongLong0214/commitlore/v1.2.18/install.sh | sh -s v1.2.18Windows:
& ([scriptblock]::Create((irm https://raw.githubusercontent.com/MongLong0214/commitlore/v1.2.18/install.ps1))) v1.2.18Requires Node.js 22.23.2+ and Git. The script checks both before it writes anything.
2. Connect your agent
Claude Code:
/plugin marketplace add MongLong0214/commitlore
/plugin install commitlore@commitloreCodex:
commitlore plugin install-codexThe plugin puts no commitlore on PATH, so the commands below need the CLI
install as well. The installers also detect and wire supported MCP hosts where
they can do so safely; the exact matrix is below.
3. Initialize a repository
cd your-repository
commitlore init
commitlore context .Start a new agent session after installing or updating a plugin: a running session keeps the runtime it loaded.
Then work and commit normally. On supported skill integrations, CommitLore is considered during ordinary commit requests and stays silent when there is nothing worth preserving. You do not need to name CommitLore on every commit.
Want accepted records to stage without a per-record prompt? The repository can
opt in once with commitlore auto on. That policy is repository-owned and
applies to the team, so it is not silently enabled by this page.
What the agent receives
Before editing src/pricing.ts:
commitlore: active records for src/pricing.ts
Limit
[claim] r-price01 calculatePrice owns final checkout pricing only
Ruled-out
[claim] r-price01 Reuse it for admin quotes |
eligibility and rounding semantics differ[claim] means "weigh this as information." A repository can opt into the
stronger signed-authority mode. Delivery gives the agent context; it does not
block the edit.
Why Git?
The repository should own the judgment behind its code.
CommitLore stores records in ordinary Git trailers and notes, so they branch, merge, clone, review, and survive provider changes with the code they explain.
SQLite is only a rebuildable index. Delete it and Git still holds the record.
Finding an old decision is not enough
A general memory or retrieval system asks:
Which old text looks related?
CommitLore asks:
Which recorded decisions still apply to this path now?
A superseded decision can be highly relevant and still be wrong as current guidance. Relevance and authority are different questions.
How it works
Capture — an agent drafts only decision context the diff cannot show.
Verify — CommitLore checks the draft against the session and staged diff.
Preserve — the accepted record lives in Git with identity and lifecycle.
Deliver — before a later edit, only active records for that path are returned.
Most commits carry no record. The commit hook validates a record when one is present; it does not invent one.
An existing hook is not overwritten. commitlore init honours core.hooksPath,
moves any hook already installed to <hook>.commitlore-chained, and calls it
first; commitlore hooks uninstall puts it back.
What happens automatically
Host | Pre-edit delivery | Verified capture workflow | Deterministic every-commit capture |
Claude Code | Automatic through the plugin | Available through the plugin skill | Not certified |
Codex | Automatic through the plugin | Available through the plugin skill | Not certified |
Hermes | Available after | Available after host install | Not certified |
Gemini CLI, Cursor, Windsurf, opencode | MCP delivery where the host uses the registration | Procedure exposed over MCP | No |
| Procedure only | Procedure only | No |
"Available" means the prepare → verify → stage workflow exists. It does not mean every eligible commit is assessed automatically.
Users on supported skill hosts do not need to say "record this in CommitLore" on every commit. The remaining limitation is host initiation, not a required per-record user command.
Squash-merge repositories
A squash merge replaces a branch's commits with one new commit, and that commit does not carry the branch's trailers. If your repository merges with the squash button, a record made on a branch is dropped by the merge unless something carries it onto the commit that squashed it.
Two paths cover that, and one of them needs a one-time setup:
How the squash happens | What carries the record | Setup |
| The installed | None — |
GitHub's Squash and merge button | The | The workflow below |
GitHub performs that merge on its own servers, where no local git hook runs at all, so the local hook cannot see it. The Action is the only place that has what it needs at that moment: the pull request, its commits, and the commit they were squashed into.
Add .github/workflows/commitlore-preserve.yml:
name: CommitLore squash inheritance
# pull_request_target, not pull_request: a pull request from a fork gets a
# read-only token on pull_request, so the job would build the record and then
# fail to publish it.
on:
pull_request_target:
types: [closed]
permissions:
contents: write # the one push to refs/notes/commitlore
concurrency:
group: commitlore-notes
cancel-in-progress: false
jobs:
preserve:
if: github.event.pull_request.merged == true
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
# the merge commit is on the base branch, and a closed pull request
# has no merge ref left to check out
ref: ${{ github.event.pull_request.base.ref }}
fetch-depth: 0
# the mirror this action writes; publishing from a checkout that never
# read it would fork the notes history
- run: git fetch --no-tags origin '+refs/notes/commitlore:refs/notes/commitlore'
# a squash merge usually deletes the branch, and then the pull request's
# own ref is the only one still reaching the commits that carry records
- run: git fetch --no-tags --force origin
'+refs/pull/${{ github.event.pull_request.number }}/head:refs/commitlore/pr-head'
# The action runs CommitLore from a checkout of this repository: the
# package is private, so there is no published npm name to fall back to.
# `dist/` is committed (ADR-0011), so nothing needs building.
- uses: actions/checkout@v4
with:
repository: MongLong0214/commitlore
ref: v1.2.18
path: .commitlore-cli
persist-credentials: false
- uses: MongLong0214/commitlore/action/preserve@v1.2.18
with:
cli-path: .commitlore-cli/dist/cli.jsTwo rules for whoever edits this next, because pull_request_target runs with a
writable token: never check out the pull request's head here, and never execute
anything reachable from refs/commitlore/pr-head. The fork's commits arrive as
data to read trailers from, not as code to run.
commitlore doctor reports whether this is switched on, under
squash inheritance. It says so before a record is lost;
squash conservation is the row that reports records already gone.
If you merge with merge commits or rebase, records survive on their own and this setup is unnecessary.
A field report, not a measurement
One run, on an unrelated repository, by someone installing v1.2.1 for the first time. Nothing here was measured and none of it is in the evidence logs. It is on this page because the paragraph above asserts a loop that no table here covers.
They asked an agent to fix a rounding bug, mentioned in passing that a decimal library had already been considered and dropped, and ended with "commit it". CommitLore was never named. Part of what the commit carried:
Ruled-out: adopting a decimal library such as Decimal.js | the backend is a
number contract, so it is meaningless
Warn: do not revert the test file to console.assert: it exits 0 even on
failure, so CI passes silently
Provenance: draftedThe Warn was not dictated to the agent. It hit the trap while working and left
it for whoever came next. Provenance: drafted records that no human read the
record, which grades it claim — delivered as a report to weigh, not an order.
A later session with no shared history was asked to adopt the decimal library
after all. It did not, and named the record as its reason. It also read the
grade: a claim is not an instruction, so it checked the stated reason against
the code before agreeing with it.
Unlike memory storage
General memory / RAG | CommitLore | |
Primary question | What old text is related? | Which decisions still apply here now? |
Authority | Memory store or provider | Git |
Scope | Semantic similarity | Repository paths |
Lifecycle | Often append-first | Active · superseded · expired |
Trust | Retrieved text | Directive · claim · blocked |
Capture | Transcript or note storage | Evidence-checked decision record |
Portability | Backend-dependent | Ordinary Git |
CommitLore is intentionally narrower. It is not a general user-memory system, conversation archive, or vector database replacement.
Evidence
Question | Measured result | Boundary |
Did claim-grade context change re-proposal in the registered study? | 2.8% (16/580) with CommitLore vs 18.8% (109/579) without | one model, one harness, constructed tasks |
Did lifecycle filtering deliver retired records in the measured active projection? | 0 retired records | superseded records were present; expiry was not |
Does indexed lookup scale? | 496 ms p50 at 100k commits | the no-index fallback is much slower |
Index build time follows the number of records, not the number of commits: the expensive pass runs once per record, so a long history that has recorded little builds faster than a short one dense with records.
Path scope is what keeps a large history from reaching the model. On the #167 corpus, only 2 of 10,002 records did:
route | model-visible records | relevant records | model-visible tokens |
inject everything | 10,002 | 2/2 | 1,004,554 |
top-k lexical | 2 | 1/2 | 190 |
CommitLore path scope | 2 | 2/2 | 335 |
That measures exposure and recall at a fixed two-record budget — not token cost, billed cost, accuracy, or agent behaviour. One corpus, one query, one pinned embedding model.
The agent study does not establish a universal model effect. Delivery is not proof that a model read or followed a record.
Methods, full tables, exclusions, and negative results →
Limits, trust and privacy
Capture is assisted, not deterministic. Supported skills consider ordinary commit requests, but no host is certified to assess every eligible commit.
Default directive mode is not authentication. It matches the commit author header, and anyone who can write a commit can set that header — so a
[directive]in default mode is policy metadata, not proof of identity. Signature mode additionally requires Git's own verified status and a match in the repository-localcommitlore.trustedSignerallowlist; an absent, empty, or unreadable signer allowlist authorizes nobody, so the mode fails closed.Guard is an experimental advisory, not a safety net: precision 44.8% (95% Wilson CI 32.7%–57.5%), recall 22.0% on the 417-decision corpus. An empty guard result is not a safety verdict.
Delivery spends tokens on every matching tool call. The pre-edit hook fires on
Readas well asEdit,Write,MultiEditandNotebookEdit, so it runs far more often than an editing agent commits. Each fire spends up to the payload budget — 800 tokens by default, changed with--budget. A repository with no records spends nothing, which means this is a cost that arrives with adoption rather than with installation.An answer may be partial. Coverage is disclosed; absence from a partial result is not proof that no record exists. Repository-wide coverage, symbol anchors, and an interactive record builder remain open: #32, #33.
Commit trailers travel with a clone; notes do not. Git does not fetch
refs/notes/*by default, so a record inrefs/notes/commitloreis absent from an ordinary clone untilcommitlore initconfigures that mirror.There is no hosted backend. But once the server or hook returns context, the host handles that context under its own policy; CommitLore does not control that data flow.
Security · Compatibility · Evidence
Records are untrusted until graded. Default author matching is policy metadata, not authentication. Signed directive mode requires Git verification and a repository-local signer allowlist; an absent or unreadable allowlist authorizes nobody. Injection-shaped payload is withheld from model-readable routes.
The CLI installer cannot rewrite hooks inside repositories it does not know
about, and running host sessions retain the runtime they loaded. commitlore doctor names both states and their repair, and commitlore upgrade reports
whether a newer release exists.
Records are ordinary Git trailers or notes. Protocol 2.0 defines lifecycle, trust grades, validation, and compatibility.
Human guide → · Normative specification →
The repository publishes the methods, exclusions, unsuccessful measurements, and the cases where the original benchmark or diagnosis was wrong.
Documentation
Contributing
CONTRIBUTING.md covers the record protocol this repository holds itself to, the release gate, and how to reproduce the evidence.
License
MIT — see LICENSE.
Available Tools
8 toolscommitlore_before_changeARead-only
Check a proposal against the Ruled-out records for a path before acting on it. Returns every record whose alternative matches, with the reason it was rejected. Experimental advisory: precision 44.8%, recall 22.0% on the 417-decision corpus. An empty matched array does not guarantee the proposal avoids every ruled-out alternative.
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | repository-relative path whose Ruled-out records to check against | |
| proposal | No | the proposed approach, in the words it would be carried out in; omit for context only (no guard run) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The description goes beyond annotations by disclosing experimental precision/recall metrics and warning that an empty 'matched' array does not guarantee avoidance. This adds valuable behavioral context beyond the readOnlyHint and destructiveHint annotations, which only indicate safety.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is four sentences, each providing distinct value: the action, the return, the reliability, and a limitation. It is front-loaded with the primary purpose and avoids redundancy, making it both concise and well-structured.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Despite lacking an output schema, the description explains what is returned (records with reasons) and its reliability. It covers when to use, what to expect, and limitations, making it complete for a guard tool. No critical information is missing.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so both parameters (path and proposal) are fully documented. The description does not add new parameter-level semantics; it only restates the purpose of the proposal parameter, which is already covered in the schema. Baseline of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's action: checking a proposal against Ruled-out records for a path before acting on it. It specifies the resource (Ruled-out records for a path) and the expected output (records with rejection reasons). This distinguishes it as a pre-action guard, even though it doesn't name sibling tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides temporal context ('before acting on it') and mentions an optional proposal parameter for guard runs, implying two usage modes (context-only and guard). However, it does not explicitly contrast with sibling tools like commitlore_guard, so an agent must infer when this tool is the appropriate choice.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
commitlore_guardARead-only
Check a proposal against the Ruled-out records for a path before acting on it. Returns every record whose alternative matches, with the reason it was rejected. Experimental advisory: precision 44.8%, recall 22.0% on the 417-decision corpus. An empty matched array does not guarantee the proposal avoids every ruled-out alternative.
| Name | Required | Description | Default |
|---|---|---|---|
| path | No | repository-relative path whose Ruled-out records to check against | |
| proposal | Yes | the proposed approach, in the words it would be carried out in |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already indicate read-only and non-destructive behavior, and the description adds transparency about the output ('Returns every record whose alternative matches') and the important caveat that an empty result does not guarantee safety. It does not describe error behavior, but the main behavioral characteristics are disclosed.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is three sentences, each conveying essential information: the action, the return behavior, and the experimental limitations. No filler or redundant phrasing is present.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description explains what the tool returns and includes a critical limitation about false negatives. There is no output schema, but the return shape is described well enough for basic use; error cases and exact record structure are not specified.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, and the description does not add significant semantic detail beyond the schema. 'Path' and 'proposal' are both described in the schema, so the description mostly repeats rather than enriches parameter meaning.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific action ('Check a proposal'), a specific resource ('Ruled-out records for a path'), and a clear purpose ('before acting on it'). It clearly distinguishes this tool's role from generic query or mutation tools.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides clear timing guidance ('before acting on it') and warns that the tool is experimental and advisory, with precision/recall metrics. It does not explicitly name alternative sibling tools, but the usage context and limitations are sufficiently clear.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
commitlore_prepare_captureA
Prepare a capture transaction: computes binding conditions (HEAD, staged diff, tree, policy hash), generates the prompt contract for the agent to use, and persists a phase:"prepared" pending transaction. Returns the nonce needed for verify and stage. The prompt carries the end of the transcript rather than all of it; transcript_window says which lines, numbered as the whole transcript numbers them. Verification still reads the whole transcript, so quote only what the prompt shows you.
| Name | Required | Description | Default |
|---|---|---|---|
| transcript | Yes | the session transcript to compute source hashes from | |
| unattended | No | declare this capture unattended: nobody was asked before staging. Refused unless the repository opted in (.commitlore-policy.json: "unattended": true, mode "auto") |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the annotations, the description discloses that the tool persists a pending transaction, that the generated prompt carries only a window of the transcript, and that verification reads the full transcript while the agent should quote only what the prompt shows. This is genuinely useful behavioral nuance that prevents a common mistake.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is compact and front-loaded with the core purpose, then adds behavioral constraints that affect how the agent should interact with the result. Every sentence contributes value, though the prompt-window detail gains some length but remains justified because it prevents a false quote from the verification step.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a tool with no output schema, the description provides essential return info (the nonce), the transaction phase, the prompt contract, and the verification-confirm behavior. Combined with the 100% schema coverage, an agent has enough information to invoke the tool correctly and know what to do next.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, and the schema already documents both the transcript and unattended parameters. The description does not add per-parameter meaning beyond what the schema provides, so it hits the baseline rather than exceeding it.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific action — preparing a capture transaction — and details what that entails: computing binding conditions, generating a prompt contract, and persisting a prepared pending transaction. It also distinguishes itself from siblings like commitlore_stage_capture and commitlore_verify_capture by identifying the nonce return value as the requirement for those downstream steps.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description clearly conveys that this tool is the first step in a multi-step transaction flow, since it persists a "prepared" phase and returns the nonce needed for verify and stage. It does not explicitly say when NOT to use it or name alternatives, so a small gap remains, but the context is enough for an agent to know its role relative to the siblings.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
commitlore_queryARead-only
Active CommitLore records for a path: the constraints, ruled-out alternatives and warnings recorded in git history. Same answer as commitlore <kind> --json.
| Name | Required | Description | Default |
|---|---|---|---|
| kind | Yes | context = every kind at once; limits = Limit:; ruled-out = Ruled-out:; warnings = Warn: | |
| path | No | repository-relative path to scope the answer to (renames are followed); omit for the whole repository |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false, so safety is covered. The description adds that records are 'active' and that it returns the same answer as a CLI command, implying a JSON response. This adds meaningful context beyond the annotations without contradicting them.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with zero waste. The core purpose is front-loaded, and the second sentence clarifies the CLI equivalence. No redundant phrasing or unnecessary elaboration.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a 2-parameter read-only query tool with no output schema, the description explains the content returned (active records of kinds), the scope via path, and the JSON format via CLI reference. It is sufficiently complete for an agent to invoke it correctly, though it does not detail the exact response structure.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, with both parameters (kind and path) already fully described in the schema. The description does not add parameter-specific details beyond the schema, so a baseline score of 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
States it retrieves active CommitLore records (constraints, ruled-out alternatives, warnings) for a path, and mentions it is equivalent to `commitlore <kind> --json`. This clearly distinguishes it from sibling tools that handle guard, capture, identity, etc.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies usage context (querying records for a path) but does not explicitly compare to alternative commitlore tools or state when not to use it. It lacks explicit exclusions or alternative selection guidance, relying on the purpose to convey when it should be invoked.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
commitlore_runtime_identityARead-only
Report the exact CommitLore entrypoint, package root, version and index schema this MCP server executes.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
The annotations already indicate readOnlyHint: true and destructiveHint: false, and the description's 'Report' action aligns perfectly with these. It further discloses the exact content of the report, leaving no ambiguity about the tool's behavior or side effects.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is a single, well-structured sentence that lists all reported items without unnecessary words. It is highly concise and easy to parse.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Given that there are no parameters and no output schema, the description is complete. It fully informs the agent of what the tool reports, with no missing context needed to invoke it correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, and the description does not need to explain any. Since there are no params to clarify, the baseline score of 4 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool's purpose with the specific verb 'Report' and lists the exact items reported (entrypoint, package root, version, index schema). It is distinct from the sibling tools, which focus on query, capture, and guard operations.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides no explicit guidance on when to use this tool versus alternatives, nor does it mention any prerequisites or conditions. It is a self-explanatory reporting tool, but the absence of any usage context leaves the agent without direction on when to invoke it.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
commitlore_stage_captureA
Stage a verified capture transaction: advances the pending record from verified to staged, stamps expires_at (staged_at + 5 minutes), and makes it eligible for the prepare-commit-msg hook. Accepts only a nonce; all bindings are server-owned and computed from stored state.
| Name | Required | Description | Default |
|---|---|---|---|
| nonce | Yes | the 32-character lowercase hex nonce returned by prepare_capture |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Beyond the basic readOnly/destructive flags, the description discloses the exact state transition, the computed expires_at value, the eligibility effect on a hook, and the fact that bindings are server-owned. It explains what the operation does to internal state while not hiding the mutation. It lacks only error-handling or side-effect detail, but the core behavior is transparent.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences long, leve with no fluff, and begins with the action and state transition, followed by the temporal stamp and the hook eligibility. Every clause carries meaningful information, and it is fully readable at a glance.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
Although the absence of an output schema means the description ideally could hint at what the tool returns or error conditions, it adequately explains the input, the state change, and the outcome (ready for the hook). Given the low complexity (single parameter) and full schema coverage, the core guidance is present. A minor gap remains in not saying whether the operation returns a status or a new nonce, but this is not blocking.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema already documents the nonce property as a mandatory 32-character lowercase hex returned from prepare_capture, which covers a lot of the semantic ground. The description adds the key insight that only a nonce is accepted and that all other bindings are server-owned, reinforcing that the agent does not need to supply additional context and that the nonce references stored state.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific action (stage a verified capture transaction), identifies the exact staging state transition (verified to staged), and names the downstream effect (preparation for prepare-commit-msg). It is distinct from sibling tools like prepare_capture or verify_capture, as it describes the concrete phase in the pipeline.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description provides strong implied usage guidance by saying it advances only a verified record to staged, so it naturally belongs after verification. It does not explicitly name alternatives or state exclusions, but the precondition is unmistakable: the record must already be verified. This yields clear context without explicit when-not wording.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
commitlore_staleARead-only
Records that are no longer carrying their weight: superseded, past a date-form Expires:, or flagged for review by a condition-form one. Same answer as commitlore stale --json.
| Name | Required | Description | Default |
|---|---|---|---|
No parameters | |||
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true and destructiveHint=false. The description adds value by defining what 'stale' means (superseded, past Expires:, flagged for review), which goes beyond the annotation. No contradiction; it reinforces the read-only nature by focusing on listing.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
The description is two sentences with no filler. The core purpose and criteria are front-loaded, and the command equivalence is a concise note. Every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
For a zero-parameter listing tool with read-only annotations, the description is sufficiently complete. It explains what is returned (stale records) and the criteria. No output schema exists, but the tool's purpose is simple enough that return format is implied.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The tool has zero parameters, so schema coverage is trivially 100%. The baseline for 0 params is 4, and the description does not need to explain parameters. It appropriately omits parameter details.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states the tool lists stale CommitLore records, with specific criteria (superseded, past Expires:, flagged for review). The verb 'list' and resource 'stale records' are clear. It doesn't explicitly differentiate from siblings like commitlore_query, but the specific criteria make it distinct.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies the tool is for viewing stale records but provides no guidance on when to use it versus other tools or when not to use it. The mention of 'Same answer as commitlore stale --json' is a command equivalence, not an alternative selection. No exclusions or context are given.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
commitlore_verify_captureA
Verify a capture draft against the transcript and diff that were hashed at prepare time. Evidence citations are checked mechanically (verbatim match); fabricated quotes are discarded. Stores the verified result in the pending transaction for stage to consume.
| Name | Required | Description | Default |
|---|---|---|---|
| diff | Yes | the staged diff (same content hashed at prepare time) | |
| draft | Yes | The agent's draft, as the harvest contract specifies it: a JSON object with a "records" array. A bare JSON array of records is also accepted. | |
| nonce | Yes | the 32-character lowercase hex nonce returned by prepare_capture | |
| transcript | Yes | the session transcript (same content hashed at prepare time) |
TDQS
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already set readOnlyHint=false and destructiveHint=false. The description adds valuable behavioral context: it mechanically checks citations, discards fabricated quotes, and stores the verified result in a pending transaction. It does not contradict annotations, though it omits failure behavior.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences, front-loaded with the core action, and every clause earns its place. The workflow context is succinctly conveyed without fluff.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
There is no output schema, yet the description never states what the tool returns (e.g., success/failure, verified draft, or error codes). It also doesn't cover what happens when verification fails or if the nonce is invalid. For a verification step in a multi-tool pipeline, this is a notable gap.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema coverage is 100%, with each parameter already documented (e.g., nonce 'returned by prepare_capture', transcript and diff 'same content hashed at prepare time'). The description reinforces the hashed-at-prepare constraint but adds little beyond the schema, so baseline 3 is appropriate.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description clearly states a specific verb (verify) and resource (capture draft) against the transcript and diff, and distinguishes itself from siblings like prepare_capture and stage_capture by its role in the pipeline. The mention of mechanical evidence checking and discarding fabricated quotes further clarifies its unique purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies the workflow: it verifies against content 'hashed at prepare time' and stores results 'for stage to consume', indicating it sits between prepare and stage. However, it does not explicitly state when NOT to use it or name alternative tools, leaving some inference required.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
8 tool updates
v0.1.0- First observed
commitlore_before_change - First observed
commitlore_guard - First observed
commitlore_prepare_capture - First observed
commitlore_query - First observed
commitlore_runtime_identity - First observed
commitlore_stage_capture - First observed
commitlore_stale - First observed
commitlore_verify_capture
TDQS
Scored across 8 tools
commitlore_before_change and commitlore_guard have identical descriptions and appear to be the same tool under different names, creating a serious selection ambiguity. The remaining tools are distinct enough, but this duplicate pair prevents an agent from reliably choosing between them.
All names share the commitlore_ prefix and use snake_case, which provides some coherence. However, the suffixes mix patterns: verb_noun for capture tools, bare verbs like query, adjectives like stale, and descriptive phrases like before_change and runtime_identity.
Eight tools is well within the ideal range for a focused domain. The count covers runtime introspection, querying, advisory checking, and the prepare-verify-stage capture lifecycle without feeling bloated.
The main workflow is well covered: query records, check proposals, prepare/verify/stage captures, and identify stale records. The most notable gap is the lack of an explicit cancel or discard path for a prepared capture transaction, though this may be a minor operational concern rather than a critical dead end.
Maintenance
Related MCP Connectors
Project memory for coding agents: requirements, decisions, code graph and delivery telemetry.
Shared memory for coding agents. Stop re-explaining your codebase every session.
Memory for coding agents: the decisions, the dead ends, and where the last session stopped.
Persistent cross-session memory shared by Codex, Claude Code, ChatGPT, and other AI agents.
Related MCP Servers
- AlicenseAqualityAmaintenanceLocal-first memory layer for AI coding agents — captures issues, attempts, fixes, and decisions, and warns at git commit before you repeat a mistake.17799MIT
- AlicenseAqualityAmaintenanceGit-native long-term memory for AI agents: your markdown files are the source of truth, the search index is a disposable projection rebuilt from git, and every memory the agent writes is a reviewable git commit. Served over one OAuth-secured MCP endpoint with hybrid lexical+semantic recall and a gated, git-first commit_note write tool.78AGPL 3.0
- AlicenseAqualityBmaintenanceLocal-first project memory for AI coding agents. Records failed attempts, fragile files, and decisions per repo, and warns the agent via hooks before it repeats a recorded mistake.650 npmMIT
- AlicenseAqualityAmaintenanceSelf-hosted decision memory for AI coding agents. Captures decisions with the alternatives you rejected, and warns before an agent re-proposes a rejected approach.481Apache 2.0