@atrib/annotate 0.2.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or otherwise designated in writing by the copyright owner as
+      "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and subsequently
+      incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or a Contribution
+      incorporated within the Work constitutes direct or contributory patent
+      infringement, then any patent licenses granted to You under this License
+      for that Work shall terminate as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative Works
+          a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the attribution
+          notices contained within such NOTICE file, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own license statement for Your modifications and
+      may provide additional grant of rights to use, modify, or distribute
+      those modifications in accordance with this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format in question. Also, an optional
+      "Statement of Purpose" appears after the copyright notice.
+
+   Copyright 2025-2026 Atrib contributors
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.

package/README.md

@@ -0,0 +1,74 @@
+# @atrib/annotate
+
+MCP server exposing the `atrib-annotate` tool. Marks a past signed record with importance, a one-line summary, and topics, so future recall can surface what mattered without re-scanning every record flat.
+
+Closes the producer-side recall-fidelity gap: an agent reading back its own past loses enormous nuance compared to the agent that signed it. An annotation lets the agent at signing time say "future-self: this one is critical, and here's why in one line", and the graph carries that judgment forward.
+
+## Tool
+
+```
+mcp__atrib-annotate__atrib-annotate({
+  annotates: "sha256:<64-hex>",         // REQUIRED: target record_hash
+  importance: "critical" | "high" | "medium" | "low" | "noise",
+  summary: string,                       // ≤ 2048 chars; one-line gist
+  topics?: string[],                     // up to 16 lowercase-hyphenated tags
+  context_id?: "<32-hex>",               // defaults to ATRIB_CONTEXT_ID
+  informed_by?: ["sha256:<64-hex>", ...] // optional lineage refs
+})
+→ {
+  record_hash: "sha256:<64-hex>",       // the new annotation record
+  log_index: number | null,
+  inclusion_proof: ProofBundle["inclusion_proof"] | null,
+  context_id: string,
+  warnings: string[]
+}
+```
+
+## Writes
+
+Signs an `annotation` record per spec [§1.2.4](https://github.com/creatornader/atrib/blob/main/atrib-spec.md#124-event_type-values) (event_type `0x05`, promoted via [D058](https://github.com/creatornader/atrib/blob/main/DECISIONS.md#d058-promote-annotation-to-atrib-normative-event_type-byte-0x05)) and persists it through the same pipeline `@atrib/emit` uses: same key resolution, same chain composition, same JSONL mirror at `ATRIB_MIRROR_FILE`. A verifier cannot distinguish annotation records signed via this tool from annotation records signed via `@atrib/emit`'s polymorphic surface; the wire format is identical.
+
+The graph layer derives an ANNOTATES edge from the new record to the `annotates` target per spec [§3.2.4](https://github.com/creatornader/atrib/blob/main/atrib-spec.md#324-edge-derivation-rules) step 8. Recall pipelines that filter or rank by importance can use this edge to surface the annotation alongside its target.
+
+## Behaviors
+
+- **Required-field enforcement**: `annotates`, `importance`, and `summary` are required. The Zod schema rejects calls missing any of these before the signing pipeline runs.
+- **Spec validators**: `annotates` is rejected on non-annotation event_types per spec [§1.2.7](https://github.com/creatornader/atrib/blob/main/atrib-spec.md#127-annotates) (the underlying `handleEmit` enforces this; the tool's narrow schema prevents it from happening here).
+- **Env-honoring**: `ATRIB_CONTEXT_ID` is honored as the default `context_id` per [D078](https://github.com/creatornader/atrib/blob/main/DECISIONS.md#d078-mcp-servers-honor-atrib_context_id-env-as-context_id-default) when the caller omits the field.
+- **Multi-producer chain composition**: inherits chain state from the mirror or `ATRIB_CHAIN_TAIL_<context_id>` env per [D067](https://github.com/creatornader/atrib/blob/main/DECISIONS.md#d067-multi-producer-chain-composition-precedence-contract), the same way `@atrib/emit` does.
+- **Graceful degradation**: signing failures surface in `warnings`; never throws to the agent per spec [§5.8](https://github.com/creatornader/atrib/blob/main/atrib-spec.md#58-degradation-contract).
+
+## Wire-up
+
+Add to your MCP host config (e.g. `~/.claude.json` `mcpServers`):
+
+```json
+{
+  "atrib-annotate": {
+    "command": "node",
+    "args": ["/path/to/atrib-annotate/dist/main.js"]
+  }
+}
+```
+
+Or run as a one-off subprocess via `pnpm --filter @atrib/annotate start`.
+
+### Env vars (inherited from `@atrib/emit`)
+
+- `ATRIB_PRIVATE_KEY` / `ATRIB_KEY_FILE` / macOS Keychain `atrib-creator-<ATRIB_AGENT>` / `ATRIB_OP_REFERENCE`: key resolution chain.
+- `ATRIB_MIRROR_FILE`: JSONL mirror destination (where the signed annotation persists).
+- `ATRIB_AUTOCHAIN_SOURCE`: optional cross-producer chain inheritance source.
+- `ATRIB_LOG_ENDPOINT`: log.atrib.dev override (e.g. for self-hosted log nodes).
+- `ATRIB_CONTEXT_ID`: default context_id per [D078](https://github.com/creatornader/atrib/blob/main/DECISIONS.md#d078-mcp-servers-honor-atrib_context_id-env-as-context_id-default).
+
+## Relationship to @atrib/emit
+
+`@atrib/annotate` depends on `@atrib/emit` per the package layering documented in [D079](https://github.com/creatornader/atrib/blob/main/DECISIONS.md#d079-the-six-core-cognitive-primitives--atribs-agent-facing-surface). Each is a monomorphic agent-facing tool with one narrow purpose, but the underlying signing, chain composition, and mirror-writing pipeline is shared via `@atrib/emit`'s `handleEmit` export. When the canonical write pipeline evolves (chain-composition fixes, env-honoring extensions, cross-attestation), `@atrib/annotate` inherits the change automatically.
+
+## Status
+
+Initial scaffold (v0.2.0). Cognitive primitive #2 per [D079](https://github.com/creatornader/atrib/blob/main/DECISIONS.md#d079-the-six-core-cognitive-primitives--atribs-agent-facing-surface). Builds clean against `@atrib/mcp` and `@atrib/emit`'s public exports introduced in `@atrib/emit@0.8.0`. The companion specialized writer `@atrib/revise` covers the contradiction-handling primitive (revision event_type).
+
+## License
+
+Apache-2.0.

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { type ResolvedKey } from '@atrib/emit';
+export interface AtribAnnotateServer {
+    /** Underlying McpServer; expose for testing or composition. */
+    mcp: McpServer;
+    /** Drain pending submissions (for tests/shutdown). */
+    flush(): Promise<void>;
+}
+export interface CreateAtribAnnotateServerOptions {
+    /** Override the resolved key (primarily for testing). */
+    key?: ResolvedKey;
+    /** Override the log endpoint (defaults to env or @atrib/mcp default). */
+    logEndpoint?: string | undefined;
+}
+/**
+ * Wire up the atrib-annotate MCP server with one `atrib-annotate` tool.
+ * Per D079: this is a specialized form of @atrib/emit; the underlying
+ * signing pipeline is shared via handleEmit so annotation records are
+ * byte-identical regardless of which tool produced them.
+ */
+export declare function createAtribAnnotateServer(options?: CreateAtribAnnotateServerOptions): Promise<AtribAnnotateServer>;

package/dist/index.js

@@ -0,0 +1,96 @@
+// @atrib/annotate MCP server: cognitive primitive #2 of D079.
+//
+// Specialized form of @atrib/emit that narrows the schema to the annotation
+// event_type (spec §1.2.7 / D058). Per D079's package layering: depends on
+// @atrib/emit as the canonical record-signing surface and wraps handleEmit
+// with a narrow Zod schema enforcing the annotation-specific required fields
+// (annotates + importance + summary). The signing + chain composition path
+// is byte-identical to atrib-emit's; a verifier MUST NOT distinguish
+// annotation records signed via this tool from those signed via emit's
+// polymorphic surface.
+//
+// Scope:
+//   - One tool: atrib-annotate
+//   - Narrow input schema: REQUIRES annotates (sha256:<64-hex>), importance, summary
+//   - One key per process (same identity as the wrapper + atrib-emit)
+//   - Persists to the same JSONL mirror convention as atrib-emit
+import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
+import { z } from 'zod';
+import { handleEmit, resolveKey, } from '@atrib/emit';
+import { createSubmissionQueue, EVENT_TYPE_ANNOTATION_URI, } from '@atrib/mcp';
+const SHA256_REF_PATTERN = /^sha256:[0-9a-f]{64}$/;
+const HEX_32_PATTERN = /^[0-9a-f]{32}$/;
+const Importance = z.enum(['critical', 'high', 'medium', 'low', 'noise']);
+const AnnotateInput = z.object({
+    annotates: z.string().regex(SHA256_REF_PATTERN).describe("'sha256:<64-hex>' record_hash this annotation describes per spec §1.2.7 / D058. " +
+        'REQUIRED. The target record can be any prior record (yours or another agent\'s).'),
+    importance: Importance.describe('Felt importance for future-self recall ranking. ' +
+        "'critical' (load-bearing decisions, identity claims), " +
+        "'high' (worth surfacing in default recall), " +
+        "'medium' (general signal), " +
+        "'low' (background noting), " +
+        "'noise' (deliberately deprioritized for recall)."),
+    summary: z.string().min(1).max(2048).describe('One-line semantic gist of the annotation. The recall pipeline reads this verbatim ' +
+        'for snippet display; keep it under ~120 chars when possible. ' +
+        'Distinct from the annotated record\'s own content — this summary captures what ' +
+        'future-you should know about why this record matters.'),
+    topics: z.array(z.string().min(1).max(128)).max(16).optional().describe('Optional topic tags. Used by recall_my_attribution_history\'s topics filter. ' +
+        'Lowercase-hyphenated convention (e.g. "bug-fix", "design-decision").'),
+    context_id: z.string().regex(HEX_32_PATTERN).optional().describe('32-hex context_id. Defaults to process.env.ATRIB_CONTEXT_ID per D078 when omitted; ' +
+        'falls back to a fresh genesis context_id if neither is set.'),
+    informed_by: z.array(z.string().regex(SHA256_REF_PATTERN)).optional().describe("Array of 'sha256:<64-hex>' record_hashes that informed this annotation. " +
+        'Sorted lexicographically before signing per §1.2.5. The `annotates` reference ' +
+        'is separate from `informed_by` and need not be duplicated here.'),
+});
+/**
+ * Wire up the atrib-annotate MCP server with one `atrib-annotate` tool.
+ * Per D079: this is a specialized form of @atrib/emit; the underlying
+ * signing pipeline is shared via handleEmit so annotation records are
+ * byte-identical regardless of which tool produced them.
+ */
+export async function createAtribAnnotateServer(options = {}) {
+    const key = options.key ?? (await resolveKey());
+    const logEndpoint = options.logEndpoint ?? process.env['ATRIB_LOG_ENDPOINT'];
+    const queue = createSubmissionQueue(logEndpoint);
+    const mcp = new McpServer({ name: 'atrib-annotate', version: '0.1.0' });
+    mcp.registerTool('atrib-annotate', {
+        description: 'Mark a past record\'s importance and meaning without superseding it. ' +
+            'Cognitive primitive #2 of D079; produces a signed annotation event ' +
+            '(spec §1.2.7 / D058) that adds an ANNOTATES graph edge to the target. ' +
+            'Use when you want future-self or other agents to read back this past ' +
+            'record with weighted importance and a one-line gist.',
+        inputSchema: AnnotateInput.shape,
+    }, async (rawInput) => {
+        const input = AnnotateInput.parse(rawInput);
+        const result = await handleEmit({
+            input: {
+                event_type: EVENT_TYPE_ANNOTATION_URI,
+                content: {
+                    annotates: input.annotates,
+                    importance: input.importance,
+                    summary: input.summary,
+                    ...(input.topics ? { topics: input.topics } : {}),
+                },
+                annotates: input.annotates,
+                ...(input.context_id ? { context_id: input.context_id } : {}),
+                ...(input.informed_by ? { informed_by: input.informed_by } : {}),
+            },
+            key,
+            queue,
+        });
+        const out = {
+            record_hash: result.record_hash,
+            log_index: result.log_index,
+            inclusion_proof: result.inclusion_proof,
+            context_id: result.context_id,
+            warnings: result.warnings,
+        };
+        return {
+            content: [{ type: 'text', text: JSON.stringify(out, null, 2) }],
+        };
+    });
+    return {
+        mcp,
+        flush: () => queue.flush(),
+    };
+}

package/dist/main.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/main.js

@@ -0,0 +1,15 @@
+#!/usr/bin/env node
+// atrib-annotate standalone binary. Wires the McpServer to a stdio transport
+// so it can be launched as a subprocess by an MCP host (Claude Code,
+// Claude Desktop, etc.).
+import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
+import { createAtribAnnotateServer } from './index.js';
+async function main() {
+    const { mcp } = await createAtribAnnotateServer();
+    const transport = new StdioServerTransport();
+    await mcp.connect(transport);
+}
+main().catch((e) => {
+    console.error('atrib-annotate: fatal', e instanceof Error ? e.stack ?? e.message : String(e));
+    process.exit(1);
+});

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@atrib/annotate",
+  "version": "0.2.0",
+  "description": "MCP server for atrib. Lets agents mark a past record's importance and meaning. Adds an ANNOTATES graph edge so recall surfaces weighted annotations ahead of flat scans.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "bin": {
+    "atrib-annotate": "./dist/main.js"
+  },
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.29.0",
+    "zod": "^3.25.76",
+    "@atrib/emit": "0.8.0",
+    "@atrib/mcp": "0.6.2"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.17",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rm -rf dist && tsc",
+    "start": "node dist/main.js",
+    "dev": "tsx src/main.ts",
+    "test": "vitest run"
+  }
+}