@fenglimg/fabric-server 2.0.0-rc.36 → 2.0.0-rc.38

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 wangzhichao (fenglimg)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# @fenglimg/fabric-server
+
+Fabric MCP knowledge server. Runs over stdio transport and serves Claude Code, Cursor, and Codex CLI from a single `.fabric/` directory.
+
+## Tools exposed
+
+- `fab_plan_context` — neutral rule description index + selection token
+- `fab_get_knowledge_sections` — fetch full markdown bodies by stable_id
+- `fab_recall` — combined one-call recall (plan + sections), the rc.37+ default
+- `fab_extract_knowledge` — persist a pending knowledge entry
+- `fab_review` — list / approve / reject / modify / defer pending entries
+
+## Install
+
+Usually installed indirectly via [`@fenglimg/fabric-cli`](https://www.npmjs.com/package/@fenglimg/fabric-cli):
+
+```bash
+npm i -g @fenglimg/fabric-cli
+fabric install
+```
+
+Direct consumption (programmatic):
+
+```bash
+npm i @fenglimg/fabric-server
+```
+
+## Repo
+
+Source + issues + roadmap: <https://github.com/fenglimg/fabric-v2>
+
+## License
+
+MIT — see [LICENSE](./LICENSE).

package/dist/index.d.ts

@@ -1,8 +1,6 @@
-import { Server } from 'node:http';
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { AgentsMeta, KnowledgeTestIndex, AgentsLayer, AgentsTopologyType, KnowledgeType, Layer, StableId, AgentsMetaCounters, EventLedgerEventInput, EventLedgerEvent, RuleDescriptionIndexItem } from '@fenglimg/fabric-shared';
 import { FabExtractKnowledgeInput, FabExtractKnowledgeOutput, FabReviewInput, FabReviewOutput } from '@fenglimg/fabric-shared/schemas/api-contracts';
-import { IOFabricError } from '@fenglimg/fabric-shared/errors';
 
 interface InFlightTracker {
     enter(requestId: string): void;
@@ -18,9 +16,11 @@ declare function createInFlightTracker(): InFlightTracker;
 declare const LEDGER_PATH = ".fabric/.intent-ledger.jsonl";
 declare const LEGACY_LEDGER_PATH = ".intent-ledger.jsonl";
 declare const EVENT_LEDGER_PATH = ".fabric/events.jsonl";
+declare const METRICS_LEDGER_PATH = ".fabric/metrics.jsonl";
 declare function getLedgerPath(projectRoot: string): string;
 declare function getLegacyLedgerPath(projectRoot: string): string;
 declare function getEventLedgerPath(projectRoot: string): string;
+declare function getMetricsLedgerPath(projectRoot: string): string;
 
 type DoctorStatus = "ok" | "warn" | "error";
 type DoctorIssueKind = "fixable_error" | "manual_error" | "warning" | "info";
@@ -132,6 +132,10 @@ type CiteCoverageReport = {
         recalled_unverified: number;
         expected_but_missed: number;
         total_turns: number;
+        cite_compliance_rate?: number | null;
+        compliant_cites?: number;
+        noncompliant_cites?: number;
+        uncorrelatable_edits?: number;
     };
     per_client?: Record<string, Partial<CiteCoverageReport["metrics"]>>;
     dismissed_reason_histogram?: Record<string, number>;
@@ -164,6 +168,23 @@ type ArchiveHistoryReport = {
 declare function runDoctorArchiveHistory(projectRoot: string, options: {
     since: number;
 }): Promise<ArchiveHistoryReport>;
+type HistoryDayRow = {
+    date: string;
+    doctor_runs_lint: number;
+    doctor_runs_fix: number;
+    doctor_total_issues: number;
+    doctor_total_mutations: number;
+    archive_attempts: number;
+    archive_proposed: number;
+};
+type HistoryAllReport = {
+    rows: HistoryDayRow[];
+    since_ms: number;
+    generated_at: string;
+};
+declare function runDoctorHistoryAll(projectRoot: string, options: {
+    since: number;
+}): Promise<HistoryAllReport>;
 type EnrichDescriptionsMode = "auto" | "preview" | "readonly" | "interactive";
 type EnrichDescriptionsCandidate = {
     path: string;
@@ -324,8 +345,6 @@ type PlanContextInput = {
 };
 type RequirementProfile = {
     target_path: string;
-    path_segments: string[];
-    extension: string;
     known_tech: string[];
     user_intent: string;
     detected_entities: string[];
@@ -333,25 +352,24 @@ type RequirementProfile = {
 type PlanContextEntry = {
     path: string;
     requirement_profile: RequirementProfile;
-    description_index: RuleDescriptionIndexItem[];
+};
+type PreflightDiagnostic = {
+    code: "missing_description" | "empty_shell_suppressed";
+    severity: "warn";
+    message: string;
+    stable_ids?: string[];
+    path?: string;
 };
 type PlanContextResult = {
     revision_hash: string;
     stale: boolean;
     selection_token: string;
     entries: PlanContextEntry[];
-    shared: {
-        description_index: RuleDescriptionIndexItem[];
-        preflight_diagnostics: Array<{
-            code: "missing_description";
-            severity: "warn";
-            message: string;
-            stable_ids?: string[];
-            path?: string;
-        }>;
-    };
+    candidates: RuleDescriptionIndexItem[];
+    preflight_diagnostics: PreflightDiagnostic[];
     auto_healed?: boolean;
     previous_revision_hash?: string;
+    redirects?: Record<string, string>;
 };
 type SelectionTokenState = {
     token: string;
@@ -365,6 +383,126 @@ type SelectionTokenState = {
 declare function planContext(projectRoot: string, input: PlanContextInput): Promise<PlanContextResult>;
 declare function readSelectionToken(token: string, now?: number): SelectionTokenState | undefined;
 
+type RecallInput = PlanContextInput & {
+    /**
+     * Optional explicit set of stable_ids to fetch bodies for. When omitted,
+     * fab_recall picks up every stable_id surfaced in the shared description
+     * index (the common case after rc.37 selectable-filter removal). When
+     * provided, filters the fetched body set to this intersection.
+     */
+    ids?: string[];
+};
+type RecallResult = PlanContextResult & {
+    rules: Array<{
+        stable_id: string;
+        level: "L0" | "L1" | "L2";
+        path: string;
+        body: string;
+    }>;
+    selected_stable_ids: string[];
+    diagnostics: Array<{
+        code: "missing_knowledge_metadata";
+        severity: "warn";
+        stable_id: string;
+        message: string;
+    }>;
+};
+declare function recall(projectRoot: string, input: RecallInput): Promise<RecallResult>;
+
+/**
+ * O(1) in-memory increment for a named counter. Safe to call from any MCP
+ * tool handler; no I/O happens until the next `flushMetrics()` call.
+ *
+ * `delta` defaults to 1; callers can pass a positive integer (e.g. fetched
+ * N stable_ids in a single sections call) to fold N bumps into one.
+ */
+declare function bumpCounter(projectRoot: string, name: string, delta?: number): void;
+/**
+ * Snapshot the current counter accumulator and reset it. Returned map is a
+ * frozen copy; the live accumulator starts fresh from zero. Exposed so
+ * flushMetrics + tests + a future fab_metrics manual-flush CLI hook can all
+ * use the same primitive without racing.
+ */
+declare function drainCounters(projectRoot: string): Record<string, number>;
+/**
+ * Drain the current accumulator and append one JSONL row to
+ * `.fabric/metrics.jsonl`. Returns the appended row (or `null` when the
+ * accumulator was empty — no spurious zero rows). fs failures degrade
+ * silently; the next flush will carry the union of the failed-write
+ * interval + the current one.
+ */
+declare function flushMetrics(projectRoot: string, options?: {
+    windowMs?: number;
+    now?: Date;
+}): Promise<MetricsRow | null>;
+/**
+ * Start the background flush timer for a project root. Idempotent — calling
+ * twice on the same root replaces the prior interval. Returns a stop handle
+ * the caller can invoke at shutdown to flush + clear the timer.
+ *
+ * The flush is fire-and-forget (no await on the setInterval callback) so
+ * the timer cadence stays accurate even when fs is slow.
+ */
+declare function startMetricsFlush(projectRoot: string, options?: {
+    intervalMs?: number;
+}): () => Promise<void>;
+/**
+ * Cancel the background flush timer for a project root if one is running.
+ * Does NOT drain the accumulator — callers that want a final flush should
+ * await flushMetrics(projectRoot) afterward.
+ */
+declare function stopMetricsFlush(projectRoot: string): void;
+/**
+ * Read accumulated metrics rows from `.fabric/metrics.jsonl`. Missing file
+ * returns []. Malformed rows are dropped silently (the sidecar is best-
+ * effort observability; a corrupt row never blocks a reader).
+ *
+ * Exposed for the NEW-34 `fab metrics` CLI dashboard + future doctor lints
+ * (e.g. cite-goodhart pattern replay) that need counter trends without
+ * walking events.jsonl.
+ */
+declare function readMetrics(projectRoot: string): Promise<MetricsRow[]>;
+type MetricsRow = {
+    timestamp: string;
+    window: string;
+    counters: Record<string, number>;
+};
+/**
+ * Canonical metric counter names used by the high-frequency emitters that
+ * left events.jsonl as part of the rc.37 Wave B clean-slate. Centralized
+ * here so the B5 hard-gate (`metric_event_in_jsonl`) can grep for these
+ * exact strings and fail when one accidentally re-appears in the audit
+ * ledger emit path.
+ */
+declare const METRIC_COUNTER_NAMES: {
+    readonly knowledge_consumed: "knowledge_consumed";
+    readonly edit_intent_checked: "edit_intent_checked";
+    readonly knowledge_context_planned: "knowledge_context_planned";
+    readonly knowledge_sections_fetched: "knowledge_sections_fetched";
+};
+type MetricCounterName = (typeof METRIC_COUNTER_NAMES)[keyof typeof METRIC_COUNTER_NAMES];
+
+/**
+ * Start the background rotation timer for a project root. Idempotent —
+ * calling twice on the same root replaces the prior interval. Returns a
+ * stop handle the caller can invoke at shutdown.
+ *
+ * The tick fires fire-and-forget (no await on the setInterval callback) so
+ * the cadence stays accurate even when fs is slow. The first tick fires
+ * AFTER one full interval — startup-time rotation should run separately
+ * if desired (most callers don't, because rotation work blocks the
+ * connect path).
+ */
+declare function startRotationTick(projectRoot: string, options?: {
+    intervalMs?: number;
+}): () => void;
+/**
+ * Cancel the background rotation timer for a project root if one is
+ * running. Does NOT trigger a final rotation — callers that want a final
+ * rotation should call rotateEventLedgerIfNeeded(projectRoot) directly.
+ */
+declare function stopRotationTick(projectRoot: string): void;
+
 /**
  * Shared constants used across the server package.
  */
@@ -466,23 +604,6 @@ interface ReconcileKnowledgeOptions {
  */
 declare function reconcileKnowledge(projectRoot: string, opts?: ReconcileKnowledgeOptions): Promise<KnowledgeSyncReport>;
 
-declare class ServeLockHeldError extends IOFabricError {
-    readonly code = "SERVE_LOCK_HELD";
-    readonly httpStatus = 423;
-}
-interface LockState {
-    pid: number;
-    acquiredAt: number;
-    host?: string;
-}
-interface AcquireOptions {
-    force?: boolean;
-}
-declare function acquireLock(projectRoot: string, opts?: AcquireOptions): void;
-declare function releaseLock(projectRoot: string): void;
-declare function readLockState(projectRoot: string): LockState | null;
-declare function checkLockOrThrow(projectRoot: string, opts?: AcquireOptions): void;
-
 /**
  * Returns an info-level startup message when CLAUDE.md or AGENTS.md exist at
  * the project root, or null when neither is present.
@@ -517,12 +638,5 @@ interface ShutdownHandlerDeps {
  * `invoked` flag, so per-signal dedup is isolated.
  */
 declare function createShutdownHandler(deps: ShutdownHandlerDeps): () => void;
-declare function startHttpServer(options: {
-    port: number;
-    projectRoot: string;
-    host?: string;
-    authToken?: string;
-    allowLoopbackNoAuth?: boolean;
-}): Promise<Server>;
 
-export { AGENTS_MD_RESOURCE_URI, type AcquireOptions, type ArchiveHistoryEntry, type ArchiveHistoryReport, type CiteCoverageReport, type DoctorApplyLintMutation, type DoctorApplyLintMutationKind, type DoctorApplyLintReport, type DoctorFixReport, type DoctorIssue, type DoctorReport, EVENT_LEDGER_PATH, type EnrichDescriptionsCandidate, type EnrichDescriptionsMode, type EnrichDescriptionsReport, type InFlightTracker, KnowledgeIdAllocator, type KnowledgeMetaBuildResult, type KnowledgeMetaBuildSource, type KnowledgeSyncLedgerEvent, type KnowledgeSyncOptions, type KnowledgeSyncReport, LEDGER_PATH, LEGACY_LEDGER_PATH, type LedgerEvent, type LockState, type PlanContextInput, type PlanContextResult, type ReconcileKnowledgeOptions, type RequirementProfile, type SelectionTokenState, ServeLockHeldError, type ShutdownHandlerDeps, type StructuredWarning, type WriteKnowledgeMetaOptions, acquireLock, appendEventLedgerEvent, buildKnowledgeMeta, checkLockOrThrow, computeKnowledgeBasedAgentsMeta, computeKnowledgeTestIndex, createFabricServer, createInFlightTracker, createShutdownHandler, deriveKnowledgeMetaLayer, deriveKnowledgeMetaTopologyType, enrichDescriptions, ensureKnowledgeFresh, extractKnowledge, flushAndSyncEventLedger, formatPreexistingRootMessage, getEventLedgerPath, getLedgerPath, getLegacyLedgerPath, isSameKnowledgeTestIndex, loadKbIdTypeMap, planContext, readLockState, readSelectionToken, reconcileKnowledge, releaseLock, reviewKnowledge, runDoctorApplyLint, runDoctorArchiveHistory, runDoctorCiteCoverage, runDoctorFix, runDoctorReport, stableStringify, startHttpServer, startStdioServer, writeKnowledgeMeta };
+export { AGENTS_MD_RESOURCE_URI, type ArchiveHistoryEntry, type ArchiveHistoryReport, type CiteCoverageReport, type DoctorApplyLintMutation, type DoctorApplyLintMutationKind, type DoctorApplyLintReport, type DoctorFixReport, type DoctorIssue, type DoctorReport, EVENT_LEDGER_PATH, type EnrichDescriptionsCandidate, type EnrichDescriptionsMode, type EnrichDescriptionsReport, type HistoryAllReport, type HistoryDayRow, type InFlightTracker, KnowledgeIdAllocator, type KnowledgeMetaBuildResult, type KnowledgeMetaBuildSource, type KnowledgeSyncLedgerEvent, type KnowledgeSyncOptions, type KnowledgeSyncReport, LEDGER_PATH, LEGACY_LEDGER_PATH, type LedgerEvent, METRICS_LEDGER_PATH, METRIC_COUNTER_NAMES, type MetricCounterName, type MetricsRow, type PlanContextInput, type PlanContextResult, type RecallInput, type RecallResult, type ReconcileKnowledgeOptions, type RequirementProfile, type SelectionTokenState, type ShutdownHandlerDeps, type StructuredWarning, type WriteKnowledgeMetaOptions, appendEventLedgerEvent, buildKnowledgeMeta, bumpCounter, computeKnowledgeBasedAgentsMeta, computeKnowledgeTestIndex, createFabricServer, createInFlightTracker, createShutdownHandler, deriveKnowledgeMetaLayer, deriveKnowledgeMetaTopologyType, drainCounters, enrichDescriptions, ensureKnowledgeFresh, extractKnowledge, flushAndSyncEventLedger, flushMetrics, formatPreexistingRootMessage, getEventLedgerPath, getLedgerPath, getLegacyLedgerPath, getMetricsLedgerPath, isSameKnowledgeTestIndex, loadKbIdTypeMap, planContext, readMetrics, readSelectionToken, recall, reconcileKnowledge, reviewKnowledge, runDoctorApplyLint, runDoctorArchiveHistory, runDoctorCiteCoverage, runDoctorFix, runDoctorHistoryAll, runDoctorReport, stableStringify, startMetricsFlush, startRotationTick, startStdioServer, stopMetricsFlush, stopRotationTick, writeKnowledgeMeta };