@agentskit/doc-bridge 0.1.0-alpha.2 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +59 -0
- package/README.md +139 -57
- package/action.yml +78 -0
- package/dist/cli/program.js +1122 -114
- package/dist/cli/program.js.map +1 -1
- package/dist/index.d.ts +258 -28
- package/dist/index.js +824 -54
- package/dist/index.js.map +1 -1
- package/docs/DOGFOOD-ROUND2.md +142 -0
- package/docs/DOGFOOD-ROUND3.md +74 -0
- package/docs/POSITIONING.md +2 -0
- package/docs/RELEASE.md +5 -3
- package/docs/chat-and-rag.md +2 -0
- package/docs/getting-started.md +14 -1
- package/docs/landing/index.html +299 -0
- package/docs/mcp.md +10 -1
- package/docs/ollama-demo.md +64 -0
- package/docs/playbook/doc-bridge-pattern.md +114 -0
- package/docs/recipes/index-pipeline.md +89 -0
- package/docs/skills/doc-bridge.md +64 -0
- package/docs/spec/cli.md +6 -0
- package/docs/spec/playbook-feedback.md +12 -4
- package/examples/demo-example/doc-bridge.config.json +23 -0
- package/examples/demo-example/docs/for-agents/INDEX.md +3 -0
- package/examples/demo-example/docs/for-agents/packages/example.md +14 -0
- package/examples/demo-example/package.json +7 -0
- package/examples/demo-example/src/.gitkeep +0 -0
- package/examples/demo-monorepo/doc-bridge.config.json +37 -0
- package/examples/demo-monorepo/docs/for-agents/INDEX.md +4 -0
- package/examples/demo-monorepo/docs/for-agents/packages/auth.md +22 -0
- package/examples/demo-monorepo/docs/for-agents/packages/billing.md +19 -0
- package/examples/demo-monorepo/docs/human/guides/auth.md +7 -0
- package/examples/demo-monorepo/package.json +7 -0
- package/examples/demo-monorepo/packages/auth/package.json +8 -0
- package/examples/demo-monorepo/packages/billing/package.json +7 -0
- package/examples/demo-monorepo/pnpm-workspace.yaml +2 -0
- package/examples/ollama-chat.config.ts +42 -0
- package/package.json +12 -9
- package/src/cli/demo.ts +143 -0
- package/src/cli/program.ts +220 -26
- package/src/doctor/badge.ts +53 -0
- package/src/doctor/run-doctor.ts +286 -0
- package/src/federation/llms.ts +20 -11
- package/src/index-builder/build-handoffs.ts +35 -2
- package/src/index-builder/scan-corpus.ts +5 -1
- package/src/index-builder/watch-index.ts +94 -0
- package/src/index.ts +24 -0
- package/src/lib/markdown.ts +31 -4
- package/src/mcp/install.ts +84 -0
- package/src/memory/github-pr.ts +190 -0
- package/src/playbook/doc-bridge-pattern.ts +121 -0
- package/src/query/query.ts +19 -1
- package/src/query/search.ts +85 -17
- package/src/schemas/agent-handoff.ts +11 -0
- package/src/schemas/doc-bridge-index.ts +3 -1
- package/src/schemas/json-schemas.ts +2 -1
- package/src/version.ts +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -25,6 +25,20 @@ declare const HandoffTargetSchema: z.ZodObject<{
|
|
|
25
25
|
layer?: string | undefined;
|
|
26
26
|
}>;
|
|
27
27
|
type HandoffTarget = z.infer<typeof HandoffTargetSchema>;
|
|
28
|
+
declare const HandoffBridgeSchema: z.ZodObject<{
|
|
29
|
+
humanDoc: z.ZodEnum<["linked", "missing", "external"]>;
|
|
30
|
+
action: z.ZodOptional<z.ZodString>;
|
|
31
|
+
bootstrap: z.ZodOptional<z.ZodString>;
|
|
32
|
+
}, "strict", z.ZodTypeAny, {
|
|
33
|
+
humanDoc: "linked" | "missing" | "external";
|
|
34
|
+
action?: string | undefined;
|
|
35
|
+
bootstrap?: string | undefined;
|
|
36
|
+
}, {
|
|
37
|
+
humanDoc: "linked" | "missing" | "external";
|
|
38
|
+
action?: string | undefined;
|
|
39
|
+
bootstrap?: string | undefined;
|
|
40
|
+
}>;
|
|
41
|
+
type HandoffBridge = z.infer<typeof HandoffBridgeSchema>;
|
|
28
42
|
/** v1 — canonical AgentHandoff. Legacy payloads may omit schemaVersion. */
|
|
29
43
|
declare const AgentHandoffV1Schema: z.ZodObject<{
|
|
30
44
|
type: z.ZodLiteral<"agent-handoff">;
|
|
@@ -54,6 +68,19 @@ declare const AgentHandoffV1Schema: z.ZodObject<{
|
|
|
54
68
|
editRoots: z.ZodArray<z.ZodString, "many">;
|
|
55
69
|
checks: z.ZodArray<z.ZodString, "many">;
|
|
56
70
|
humanDoc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
71
|
+
bridge: z.ZodOptional<z.ZodObject<{
|
|
72
|
+
humanDoc: z.ZodEnum<["linked", "missing", "external"]>;
|
|
73
|
+
action: z.ZodOptional<z.ZodString>;
|
|
74
|
+
bootstrap: z.ZodOptional<z.ZodString>;
|
|
75
|
+
}, "strict", z.ZodTypeAny, {
|
|
76
|
+
humanDoc: "linked" | "missing" | "external";
|
|
77
|
+
action?: string | undefined;
|
|
78
|
+
bootstrap?: string | undefined;
|
|
79
|
+
}, {
|
|
80
|
+
humanDoc: "linked" | "missing" | "external";
|
|
81
|
+
action?: string | undefined;
|
|
82
|
+
bootstrap?: string | undefined;
|
|
83
|
+
}>>;
|
|
57
84
|
playbookPatterns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
58
85
|
notes: z.ZodArray<z.ZodString, "many">;
|
|
59
86
|
}, "strict", z.ZodTypeAny, {
|
|
@@ -73,6 +100,11 @@ declare const AgentHandoffV1Schema: z.ZodObject<{
|
|
|
73
100
|
editRoots: string[];
|
|
74
101
|
notes: string[];
|
|
75
102
|
humanDoc?: string | null | undefined;
|
|
103
|
+
bridge?: {
|
|
104
|
+
humanDoc: "linked" | "missing" | "external";
|
|
105
|
+
action?: string | undefined;
|
|
106
|
+
bootstrap?: string | undefined;
|
|
107
|
+
} | undefined;
|
|
76
108
|
playbookPatterns?: string[] | undefined;
|
|
77
109
|
}, {
|
|
78
110
|
type: "agent-handoff";
|
|
@@ -91,6 +123,11 @@ declare const AgentHandoffV1Schema: z.ZodObject<{
|
|
|
91
123
|
notes: string[];
|
|
92
124
|
humanDoc?: string | null | undefined;
|
|
93
125
|
schemaVersion?: 1 | undefined;
|
|
126
|
+
bridge?: {
|
|
127
|
+
humanDoc: "linked" | "missing" | "external";
|
|
128
|
+
action?: string | undefined;
|
|
129
|
+
bootstrap?: string | undefined;
|
|
130
|
+
} | undefined;
|
|
94
131
|
playbookPatterns?: string[] | undefined;
|
|
95
132
|
}>;
|
|
96
133
|
type AgentHandoffV1 = z.infer<typeof AgentHandoffV1Schema>;
|
|
@@ -123,6 +160,19 @@ declare const AgentHandoffLegacySchema: z.ZodObject<Omit<{
|
|
|
123
160
|
editRoots: z.ZodArray<z.ZodString, "many">;
|
|
124
161
|
checks: z.ZodArray<z.ZodString, "many">;
|
|
125
162
|
humanDoc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
163
|
+
bridge: z.ZodOptional<z.ZodObject<{
|
|
164
|
+
humanDoc: z.ZodEnum<["linked", "missing", "external"]>;
|
|
165
|
+
action: z.ZodOptional<z.ZodString>;
|
|
166
|
+
bootstrap: z.ZodOptional<z.ZodString>;
|
|
167
|
+
}, "strict", z.ZodTypeAny, {
|
|
168
|
+
humanDoc: "linked" | "missing" | "external";
|
|
169
|
+
action?: string | undefined;
|
|
170
|
+
bootstrap?: string | undefined;
|
|
171
|
+
}, {
|
|
172
|
+
humanDoc: "linked" | "missing" | "external";
|
|
173
|
+
action?: string | undefined;
|
|
174
|
+
bootstrap?: string | undefined;
|
|
175
|
+
}>>;
|
|
126
176
|
playbookPatterns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
127
177
|
notes: z.ZodArray<z.ZodString, "many">;
|
|
128
178
|
}, "schemaVersion"> & {
|
|
@@ -144,6 +194,11 @@ declare const AgentHandoffLegacySchema: z.ZodObject<Omit<{
|
|
|
144
194
|
notes: string[];
|
|
145
195
|
humanDoc?: string | null | undefined;
|
|
146
196
|
schemaVersion?: 1 | undefined;
|
|
197
|
+
bridge?: {
|
|
198
|
+
humanDoc: "linked" | "missing" | "external";
|
|
199
|
+
action?: string | undefined;
|
|
200
|
+
bootstrap?: string | undefined;
|
|
201
|
+
} | undefined;
|
|
147
202
|
playbookPatterns?: string[] | undefined;
|
|
148
203
|
}, {
|
|
149
204
|
type: "agent-handoff";
|
|
@@ -162,6 +217,11 @@ declare const AgentHandoffLegacySchema: z.ZodObject<Omit<{
|
|
|
162
217
|
notes: string[];
|
|
163
218
|
humanDoc?: string | null | undefined;
|
|
164
219
|
schemaVersion?: 1 | undefined;
|
|
220
|
+
bridge?: {
|
|
221
|
+
humanDoc: "linked" | "missing" | "external";
|
|
222
|
+
action?: string | undefined;
|
|
223
|
+
bootstrap?: string | undefined;
|
|
224
|
+
} | undefined;
|
|
165
225
|
playbookPatterns?: string[] | undefined;
|
|
166
226
|
}>;
|
|
167
227
|
declare const AgentSearchV1Schema: z.ZodObject<{
|
|
@@ -272,6 +332,8 @@ declare const KnowledgeEntrySchema: z.ZodObject<{
|
|
|
272
332
|
title: z.ZodString;
|
|
273
333
|
path: z.ZodString;
|
|
274
334
|
description: z.ZodOptional<z.ZodString>;
|
|
335
|
+
/** Flattened body excerpt for full-text search (not for display). */
|
|
336
|
+
body: z.ZodOptional<z.ZodString>;
|
|
275
337
|
links: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
276
338
|
tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
277
339
|
}, "strict", z.ZodTypeAny, {
|
|
@@ -280,6 +342,7 @@ declare const KnowledgeEntrySchema: z.ZodObject<{
|
|
|
280
342
|
id: string;
|
|
281
343
|
title: string;
|
|
282
344
|
description?: string | undefined;
|
|
345
|
+
body?: string | undefined;
|
|
283
346
|
links?: string[] | undefined;
|
|
284
347
|
tags?: string[] | undefined;
|
|
285
348
|
}, {
|
|
@@ -288,6 +351,7 @@ declare const KnowledgeEntrySchema: z.ZodObject<{
|
|
|
288
351
|
id: string;
|
|
289
352
|
title: string;
|
|
290
353
|
description?: string | undefined;
|
|
354
|
+
body?: string | undefined;
|
|
291
355
|
links?: string[] | undefined;
|
|
292
356
|
tags?: string[] | undefined;
|
|
293
357
|
}>;
|
|
@@ -328,6 +392,8 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
|
|
|
328
392
|
title: z.ZodString;
|
|
329
393
|
path: z.ZodString;
|
|
330
394
|
description: z.ZodOptional<z.ZodString>;
|
|
395
|
+
/** Flattened body excerpt for full-text search (not for display). */
|
|
396
|
+
body: z.ZodOptional<z.ZodString>;
|
|
331
397
|
links: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
332
398
|
tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
333
399
|
}, "strict", z.ZodTypeAny, {
|
|
@@ -336,6 +402,7 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
|
|
|
336
402
|
id: string;
|
|
337
403
|
title: string;
|
|
338
404
|
description?: string | undefined;
|
|
405
|
+
body?: string | undefined;
|
|
339
406
|
links?: string[] | undefined;
|
|
340
407
|
tags?: string[] | undefined;
|
|
341
408
|
}, {
|
|
@@ -344,6 +411,7 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
|
|
|
344
411
|
id: string;
|
|
345
412
|
title: string;
|
|
346
413
|
description?: string | undefined;
|
|
414
|
+
body?: string | undefined;
|
|
347
415
|
links?: string[] | undefined;
|
|
348
416
|
tags?: string[] | undefined;
|
|
349
417
|
}>, "many">;
|
|
@@ -388,6 +456,19 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
|
|
|
388
456
|
editRoots: z.ZodArray<z.ZodString, "many">;
|
|
389
457
|
checks: z.ZodArray<z.ZodString, "many">;
|
|
390
458
|
humanDoc: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
459
|
+
bridge: z.ZodOptional<z.ZodObject<{
|
|
460
|
+
humanDoc: z.ZodEnum<["linked", "missing", "external"]>;
|
|
461
|
+
action: z.ZodOptional<z.ZodString>;
|
|
462
|
+
bootstrap: z.ZodOptional<z.ZodString>;
|
|
463
|
+
}, "strict", z.ZodTypeAny, {
|
|
464
|
+
humanDoc: "linked" | "missing" | "external";
|
|
465
|
+
action?: string | undefined;
|
|
466
|
+
bootstrap?: string | undefined;
|
|
467
|
+
}, {
|
|
468
|
+
humanDoc: "linked" | "missing" | "external";
|
|
469
|
+
action?: string | undefined;
|
|
470
|
+
bootstrap?: string | undefined;
|
|
471
|
+
}>>;
|
|
391
472
|
playbookPatterns: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
|
|
392
473
|
notes: z.ZodArray<z.ZodString, "many">;
|
|
393
474
|
}, "schemaVersion"> & {
|
|
@@ -409,6 +490,11 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
|
|
|
409
490
|
notes: string[];
|
|
410
491
|
humanDoc?: string | null | undefined;
|
|
411
492
|
schemaVersion?: 1 | undefined;
|
|
493
|
+
bridge?: {
|
|
494
|
+
humanDoc: "linked" | "missing" | "external";
|
|
495
|
+
action?: string | undefined;
|
|
496
|
+
bootstrap?: string | undefined;
|
|
497
|
+
} | undefined;
|
|
412
498
|
playbookPatterns?: string[] | undefined;
|
|
413
499
|
}, {
|
|
414
500
|
type: "agent-handoff";
|
|
@@ -427,6 +513,11 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
|
|
|
427
513
|
notes: string[];
|
|
428
514
|
humanDoc?: string | null | undefined;
|
|
429
515
|
schemaVersion?: 1 | undefined;
|
|
516
|
+
bridge?: {
|
|
517
|
+
humanDoc: "linked" | "missing" | "external";
|
|
518
|
+
action?: string | undefined;
|
|
519
|
+
bootstrap?: string | undefined;
|
|
520
|
+
} | undefined;
|
|
430
521
|
playbookPatterns?: string[] | undefined;
|
|
431
522
|
}>>>;
|
|
432
523
|
lookup: z.ZodOptional<z.ZodObject<{
|
|
@@ -550,6 +641,7 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
|
|
|
550
641
|
id: string;
|
|
551
642
|
title: string;
|
|
552
643
|
description?: string | undefined;
|
|
644
|
+
body?: string | undefined;
|
|
553
645
|
links?: string[] | undefined;
|
|
554
646
|
tags?: string[] | undefined;
|
|
555
647
|
}[];
|
|
@@ -586,6 +678,11 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
|
|
|
586
678
|
notes: string[];
|
|
587
679
|
humanDoc?: string | null | undefined;
|
|
588
680
|
schemaVersion?: 1 | undefined;
|
|
681
|
+
bridge?: {
|
|
682
|
+
humanDoc: "linked" | "missing" | "external";
|
|
683
|
+
action?: string | undefined;
|
|
684
|
+
bootstrap?: string | undefined;
|
|
685
|
+
} | undefined;
|
|
589
686
|
playbookPatterns?: string[] | undefined;
|
|
590
687
|
}> | undefined;
|
|
591
688
|
lookup?: {
|
|
@@ -623,6 +720,7 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
|
|
|
623
720
|
id: string;
|
|
624
721
|
title: string;
|
|
625
722
|
description?: string | undefined;
|
|
723
|
+
body?: string | undefined;
|
|
626
724
|
links?: string[] | undefined;
|
|
627
725
|
tags?: string[] | undefined;
|
|
628
726
|
}[];
|
|
@@ -659,6 +757,11 @@ declare const DocBridgeIndexV1Schema: z.ZodObject<{
|
|
|
659
757
|
notes: string[];
|
|
660
758
|
humanDoc?: string | null | undefined;
|
|
661
759
|
schemaVersion?: 1 | undefined;
|
|
760
|
+
bridge?: {
|
|
761
|
+
humanDoc: "linked" | "missing" | "external";
|
|
762
|
+
action?: string | undefined;
|
|
763
|
+
bootstrap?: string | undefined;
|
|
764
|
+
} | undefined;
|
|
662
765
|
playbookPatterns?: string[] | undefined;
|
|
663
766
|
}> | undefined;
|
|
664
767
|
lookup?: {
|
|
@@ -952,7 +1055,11 @@ declare const DocBridgeIndexV1JsonSchema: {
|
|
|
952
1055
|
};
|
|
953
1056
|
readonly description: {
|
|
954
1057
|
readonly type: "string";
|
|
955
|
-
readonly maxLength:
|
|
1058
|
+
readonly maxLength: 2048;
|
|
1059
|
+
};
|
|
1060
|
+
readonly body: {
|
|
1061
|
+
readonly type: "string";
|
|
1062
|
+
readonly maxLength: 8000;
|
|
956
1063
|
};
|
|
957
1064
|
readonly links: JsonSchema;
|
|
958
1065
|
readonly tags: JsonSchema;
|
|
@@ -1170,7 +1277,11 @@ declare const DocBridgeJsonSchemas: {
|
|
|
1170
1277
|
};
|
|
1171
1278
|
readonly description: {
|
|
1172
1279
|
readonly type: "string";
|
|
1173
|
-
readonly maxLength:
|
|
1280
|
+
readonly maxLength: 2048;
|
|
1281
|
+
};
|
|
1282
|
+
readonly body: {
|
|
1283
|
+
readonly type: "string";
|
|
1284
|
+
readonly maxLength: 8000;
|
|
1174
1285
|
};
|
|
1175
1286
|
readonly links: JsonSchema;
|
|
1176
1287
|
readonly tags: JsonSchema;
|
|
@@ -1423,6 +1534,124 @@ declare const MCP_TOOLS: readonly [{
|
|
|
1423
1534
|
declare const handleMcpRequest: (ctx: McpContext, request: JsonRpcRequest) => unknown;
|
|
1424
1535
|
declare const startMcpStdioServer: (ctx: McpContext) => void;
|
|
1425
1536
|
|
|
1537
|
+
type McpInstallTarget = 'cursor' | 'claude';
|
|
1538
|
+
type McpInstallResult = {
|
|
1539
|
+
readonly ok: boolean;
|
|
1540
|
+
readonly target: McpInstallTarget;
|
|
1541
|
+
readonly configPath: string;
|
|
1542
|
+
readonly created: boolean;
|
|
1543
|
+
readonly serverName: string;
|
|
1544
|
+
readonly nextSteps: readonly string[];
|
|
1545
|
+
};
|
|
1546
|
+
declare const installMcpConfig: (root: string, target: McpInstallTarget) => McpInstallResult;
|
|
1547
|
+
declare const mcpSnippet: (root: string) => string;
|
|
1548
|
+
|
|
1549
|
+
type DoctorBadgeMetrics = {
|
|
1550
|
+
readonly handoffPct: number;
|
|
1551
|
+
readonly bridgePct: number;
|
|
1552
|
+
readonly score: number;
|
|
1553
|
+
readonly grade: DoctorReport['grade'];
|
|
1554
|
+
readonly packages: number;
|
|
1555
|
+
};
|
|
1556
|
+
declare const doctorBadgeMetrics: (report: DoctorReport) => DoctorBadgeMetrics;
|
|
1557
|
+
declare const formatDoctorBadgeMarkdown: (metrics: DoctorBadgeMetrics) => string;
|
|
1558
|
+
declare const formatDoctorBadgeJson: (metrics: DoctorBadgeMetrics) => string;
|
|
1559
|
+
|
|
1560
|
+
type DoctorIssue = {
|
|
1561
|
+
readonly severity: 'error' | 'warn' | 'info';
|
|
1562
|
+
readonly code: string;
|
|
1563
|
+
readonly message: string;
|
|
1564
|
+
readonly action?: string;
|
|
1565
|
+
};
|
|
1566
|
+
type DoctorCoverage = {
|
|
1567
|
+
readonly packages: {
|
|
1568
|
+
readonly total: number;
|
|
1569
|
+
readonly withAgentDoc: number;
|
|
1570
|
+
readonly withHumanDoc: number;
|
|
1571
|
+
readonly missingAgentDoc: readonly string[];
|
|
1572
|
+
readonly missingHumanDoc: readonly string[];
|
|
1573
|
+
};
|
|
1574
|
+
readonly agentDocs: {
|
|
1575
|
+
readonly total: number;
|
|
1576
|
+
readonly indexed: number;
|
|
1577
|
+
readonly unindexed: readonly string[];
|
|
1578
|
+
};
|
|
1579
|
+
readonly freshness: {
|
|
1580
|
+
readonly ok: boolean;
|
|
1581
|
+
readonly message: string;
|
|
1582
|
+
readonly hasIndex: boolean;
|
|
1583
|
+
};
|
|
1584
|
+
readonly gates: GateRunResult;
|
|
1585
|
+
};
|
|
1586
|
+
type DoctorReport = {
|
|
1587
|
+
readonly ok: boolean;
|
|
1588
|
+
readonly score: number;
|
|
1589
|
+
readonly grade: 'A' | 'B' | 'C' | 'D' | 'F';
|
|
1590
|
+
readonly coverage: DoctorCoverage;
|
|
1591
|
+
readonly badge: DoctorBadgeMetrics;
|
|
1592
|
+
readonly issues: readonly DoctorIssue[];
|
|
1593
|
+
readonly nextActions: readonly string[];
|
|
1594
|
+
};
|
|
1595
|
+
declare const runDoctor: (root: string, config: DocBridgeConfigV1) => DoctorReport;
|
|
1596
|
+
declare const formatDoctorText: (report: DoctorReport) => string[];
|
|
1597
|
+
|
|
1598
|
+
type WatchIndexOptions = {
|
|
1599
|
+
readonly root: string;
|
|
1600
|
+
readonly config: DocBridgeConfigV1;
|
|
1601
|
+
readonly configPath?: string;
|
|
1602
|
+
readonly debounceMs?: number;
|
|
1603
|
+
readonly onRebuild?: (summary: {
|
|
1604
|
+
knowledgeCount: number;
|
|
1605
|
+
handoffCount: number;
|
|
1606
|
+
hash: string;
|
|
1607
|
+
}) => void;
|
|
1608
|
+
};
|
|
1609
|
+
declare const watchDocBridgeIndex: (opts: WatchIndexOptions) => Promise<number>;
|
|
1610
|
+
|
|
1611
|
+
type MemoryRoute = 'agent' | 'human' | 'playbook' | 'discard';
|
|
1612
|
+
type MemoryClassification = {
|
|
1613
|
+
readonly candidate: MemoryCandidateV1;
|
|
1614
|
+
readonly route: MemoryRoute;
|
|
1615
|
+
readonly reason: string;
|
|
1616
|
+
readonly target?: string;
|
|
1617
|
+
readonly duplicateOf?: string;
|
|
1618
|
+
};
|
|
1619
|
+
type SafetyFinding = {
|
|
1620
|
+
readonly candidateId: string;
|
|
1621
|
+
readonly kind: 'secret' | 'private-email';
|
|
1622
|
+
readonly message: string;
|
|
1623
|
+
};
|
|
1624
|
+
type MemoryPromotionDraft = {
|
|
1625
|
+
readonly ok: boolean;
|
|
1626
|
+
readonly title: string;
|
|
1627
|
+
readonly body: string;
|
|
1628
|
+
readonly findings: SafetyFinding[];
|
|
1629
|
+
readonly classifications: MemoryClassification[];
|
|
1630
|
+
};
|
|
1631
|
+
declare const classifyMemoryCandidates: (candidates: readonly MemoryCandidateV1[], index: DocBridgeIndexV1) => MemoryClassification[];
|
|
1632
|
+
declare const scanMemorySafety: (classifications: readonly MemoryClassification[]) => SafetyFinding[];
|
|
1633
|
+
declare const draftMemoryPromotion: (classifications: readonly MemoryClassification[]) => MemoryPromotionDraft;
|
|
1634
|
+
|
|
1635
|
+
type GithubPrOptions = {
|
|
1636
|
+
readonly dryRun?: boolean;
|
|
1637
|
+
readonly force?: boolean;
|
|
1638
|
+
readonly branch?: string;
|
|
1639
|
+
readonly base?: string;
|
|
1640
|
+
};
|
|
1641
|
+
type GithubPrResult = {
|
|
1642
|
+
readonly ok: boolean;
|
|
1643
|
+
readonly dryRun: boolean;
|
|
1644
|
+
readonly draftPath: string;
|
|
1645
|
+
readonly branch: string;
|
|
1646
|
+
readonly prUrl?: string;
|
|
1647
|
+
readonly previewUrl?: string;
|
|
1648
|
+
readonly commands: readonly string[];
|
|
1649
|
+
readonly message: string;
|
|
1650
|
+
};
|
|
1651
|
+
declare const defaultPromotionDraftPath: (root: string) => string;
|
|
1652
|
+
declare const writePromotionDraft: (root: string, draft: MemoryPromotionDraft, path?: string) => string;
|
|
1653
|
+
declare const promoteMemoryToGithubPr: (root: string, draft: MemoryPromotionDraft, options?: GithubPrOptions) => GithubPrResult;
|
|
1654
|
+
|
|
1426
1655
|
declare const sha256NormalizedV1: (payload: unknown) => string;
|
|
1427
1656
|
|
|
1428
1657
|
declare class IndexNotFoundError extends Error {
|
|
@@ -1459,30 +1688,6 @@ declare const ingestCursorRules: (root: string) => MemoryCandidateV1[];
|
|
|
1459
1688
|
declare const ingestAgentMemory: (root: string) => MemoryCandidateV1[];
|
|
1460
1689
|
declare const ingestMemoryCandidates: (root: string) => MemoryCandidateV1[];
|
|
1461
1690
|
|
|
1462
|
-
type MemoryRoute = 'agent' | 'human' | 'playbook' | 'discard';
|
|
1463
|
-
type MemoryClassification = {
|
|
1464
|
-
readonly candidate: MemoryCandidateV1;
|
|
1465
|
-
readonly route: MemoryRoute;
|
|
1466
|
-
readonly reason: string;
|
|
1467
|
-
readonly target?: string;
|
|
1468
|
-
readonly duplicateOf?: string;
|
|
1469
|
-
};
|
|
1470
|
-
type SafetyFinding = {
|
|
1471
|
-
readonly candidateId: string;
|
|
1472
|
-
readonly kind: 'secret' | 'private-email';
|
|
1473
|
-
readonly message: string;
|
|
1474
|
-
};
|
|
1475
|
-
type MemoryPromotionDraft = {
|
|
1476
|
-
readonly ok: boolean;
|
|
1477
|
-
readonly title: string;
|
|
1478
|
-
readonly body: string;
|
|
1479
|
-
readonly findings: SafetyFinding[];
|
|
1480
|
-
readonly classifications: MemoryClassification[];
|
|
1481
|
-
};
|
|
1482
|
-
declare const classifyMemoryCandidates: (candidates: readonly MemoryCandidateV1[], index: DocBridgeIndexV1) => MemoryClassification[];
|
|
1483
|
-
declare const scanMemorySafety: (classifications: readonly MemoryClassification[]) => SafetyFinding[];
|
|
1484
|
-
declare const draftMemoryPromotion: (classifications: readonly MemoryClassification[]) => MemoryPromotionDraft;
|
|
1485
|
-
|
|
1486
1691
|
type DocBridgeRetrieverOptions = {
|
|
1487
1692
|
readonly property?: string;
|
|
1488
1693
|
readonly limit?: number;
|
|
@@ -1517,7 +1722,7 @@ declare const chunksFromMarkdown: (property: string, raw: string, sourceUrl: str
|
|
|
1517
1722
|
declare const loadFederatedChunks: (root: string, config: DocBridgeConfigV1, options?: FederatedRetrieverOptions) => Promise<DocBridgeRetrievedChunk[]>;
|
|
1518
1723
|
declare const retrieveHybridChunks: (root: string, config: DocBridgeConfigV1, index: DocBridgeIndexV1, query: string, options?: FederatedRetrieverOptions) => Promise<DocBridgeRetrievedChunk[]>;
|
|
1519
1724
|
|
|
1520
|
-
declare const PACKAGE_VERSION = "
|
|
1725
|
+
declare const PACKAGE_VERSION = "1.0.0";
|
|
1521
1726
|
|
|
1522
1727
|
type FrontmatterValue = string | boolean | readonly string[];
|
|
1523
1728
|
type FrontmatterData = Record<string, FrontmatterValue>;
|
|
@@ -1606,4 +1811,29 @@ declare class PeerMissingError extends Error {
|
|
|
1606
1811
|
}
|
|
1607
1812
|
declare const layer1InstallHint: () => string;
|
|
1608
1813
|
|
|
1609
|
-
|
|
1814
|
+
declare const DOC_BRIDGE_PATTERN_ID: "doc-bridge-pattern";
|
|
1815
|
+
declare const DOC_BRIDGE_PATTERN_META: {
|
|
1816
|
+
readonly id: "doc-bridge-pattern";
|
|
1817
|
+
readonly title: "Doc Bridge Pattern";
|
|
1818
|
+
readonly slug: "pillars/ai-collaboration/doc-bridge-pattern";
|
|
1819
|
+
readonly license: "CC-BY-4.0";
|
|
1820
|
+
readonly visibility: "public";
|
|
1821
|
+
readonly playbookUrl: "https://playbook.agentskit.io/patterns/doc-bridge-pattern";
|
|
1822
|
+
readonly npmPackage: "@agentskit/doc-bridge";
|
|
1823
|
+
readonly cli: "ak-docs";
|
|
1824
|
+
};
|
|
1825
|
+
declare const docBridgePatternMarkdown: () => string;
|
|
1826
|
+
declare const docBridgePatternPayload: () => {
|
|
1827
|
+
format: string;
|
|
1828
|
+
body: string;
|
|
1829
|
+
id: "doc-bridge-pattern";
|
|
1830
|
+
title: "Doc Bridge Pattern";
|
|
1831
|
+
slug: "pillars/ai-collaboration/doc-bridge-pattern";
|
|
1832
|
+
license: "CC-BY-4.0";
|
|
1833
|
+
visibility: "public";
|
|
1834
|
+
playbookUrl: "https://playbook.agentskit.io/patterns/doc-bridge-pattern";
|
|
1835
|
+
npmPackage: "@agentskit/doc-bridge";
|
|
1836
|
+
cli: "ak-docs";
|
|
1837
|
+
};
|
|
1838
|
+
|
|
1839
|
+
export { AgentHandoffLegacySchema, type AgentHandoffV1, AgentHandoffV1JsonSchema, AgentHandoffV1Schema, type AgentSearchV1, AgentSearchV1Schema, type BuildIndexOptions, type BuildIndexResult, DOC_BRIDGE_PATTERN_ID, DOC_BRIDGE_PATTERN_META, DocBridgeConfigV1, type DocBridgeIndexV1, DocBridgeIndexV1JsonSchema, DocBridgeIndexV1Schema, DocBridgeJsonSchemas, type DocBridgeRetrievedChunk, type DocBridgeRetriever, type DocBridgeRetrieverOptions, type DoctorBadgeMetrics, type DoctorCoverage, type DoctorIssue, type DoctorReport, type FederatedRetrieverOptions, type FetchText, type GateId, type GateResult, type GateRunResult, type GithubPrOptions, type GithubPrResult, HANDOFF_SCHEMA_VERSION, type HandoffBridge, HandoffBridgeSchema, type HandoffTarget, type HandoffTargetType, HandoffTargetTypeSchema, type HumanDocMap, type HumanDocRecord, INDEX_SCHEMA_VERSION, IndexNotFoundError, type KnowledgeEntry, KnowledgeEntrySchema, MCP_TOOLS, MEMORY_CANDIDATE_SCHEMA_VERSION, type McpInstallResult, type McpInstallTarget, type MemoryCandidateV1, MemoryCandidateV1JsonSchema, MemoryCandidateV1Schema, type MemoryClassification, type MemoryPromotionDraft, type MemoryRoute, PACKAGE_VERSION, type ParseIssue, type ParseResult, PeerMissingError, type QueryKind, type QueryRequest, type QueryResult, type SafetyFinding, type SearchMatch, type WatchIndexOptions, buildDocBridgeIndex, buildLookup, chunksFromMarkdown, classifyMemoryCandidates, collectPackages, createDocBridgeRag, createDocBridgeRetriever, defaultPromotionDraftPath, docBridgePatternMarkdown, docBridgePatternPayload, doctorBadgeMetrics, draftMemoryPromotion, formatDoctorBadgeJson, formatDoctorBadgeMarkdown, formatDoctorText, handleMcpRequest, indexFilePath, ingestAgentMemory, ingestCursorRules, ingestMemoryCandidates, installMcpConfig, layer1InstallHint, loadDocBridgeIndex, loadFederatedChunks, mcpSnippet, normalizeAgentHandoff, parseAgentHandoff, parseAgentSearch, parseDocBridgeConfig, parseDocBridgeIndex, parseLlmsTxtLinks, parseMemoryCandidate, promoteMemoryToGithubPr, resolveGateIds, resolveRoot, retrieveDocBridgeChunks, retrieveHybridChunks, runChatOnce, runDoctor, runGate, runGates, runQuery, safeParseAgentHandoff, scanHumanDocRecords, scanHumanDocs, scanMemorySafety, searchIndex, sha256NormalizedV1, startInkChat, startMcpStdioServer, watchDocBridgeIndex, writePromotionDraft };
|