feat(kb): dynamic-kb-* tool family + <kb-block> subblock injection
Openclaw mirror of HarborForge.PlexumPlugin's Phase 2 work. Same tool
names + input schemas + return shapes + storage path layout so a
single ClawSkills workflow text works on both runtimes.
plugin/openclaw.plugin.json:
- 5 new dynamic-kb-* contracts.tools entries
plugin/tools/kbblock.ts (new):
- TS class mirror of Plexum internal/kbblock package
- Storage at <OPENCLAW_PATH>/agents/<agentId>/sessions/<sessionId>/
plugins/harbor-forge/kb-block.json
- Entry shape + Render emit <kb-fact id=N kb=<code>
source=topic:<slug>>...</kb-fact> identical to Plexum side
- Insert-order rendering (§9 #4), no fade in v1 (§9 #3 placeholder)
plugin/tools/kbclient.ts (new):
- TS HTTP client for HF backend KB routes:
GET /knowledge-bases[?project=<code>], /knowledge-bases/{id}/topics,
/knowledge-bases/{id}/tree, /knowledge-facts/{id}
- ListFacts flattens the tree client-side filtered by topic ids
- Bearer auth via plugin-level apiKey (per-agent hf-token resolution
deferred — TODO matching Plexum side)
plugin/tools/dynamic-kb.ts (new):
- 5 tool factories (createListKBs/Topics/Facts/Cache/Evict)
- Each accepts ctx in execute so cache/evict resolve sessionID
- KBDeps bundle wires client + token-for + makeClient + turn-for
plugin/index.ts:
- Register 5 KB tools via the existing wrapped api.registerTool
(already handles MCP content shape + PaddedCell tools-cache gate)
- before_prompt_build hook: when block non-empty, returns
appendSystemContext = <dynamic-block><kb-block>...</kb-block>
</dynamic-block>. Empty block → no append. Limitation: append
only (can't replace openclaw's baked-in static sys-msg content);
the dynamic-block lands at the end rather than slotted into
System[1] like on Plexum
No tests yet — sim verification on dind-t2 next (requires HF backend
container rebuild to expose /knowledge-* routes; current image
predates the KB module).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
278
plugin/tools/dynamic-kb.ts
Normal file
278
plugin/tools/dynamic-kb.ts
Normal file
@@ -0,0 +1,278 @@
|
||||
// dynamic-kb.ts — 5 host tools (dynamic-kb-list-kbs / list-topics /
|
||||
// list-facts / cache / evict) implementing the agent-side knowledge-
|
||||
// base browse + cache flow per DESIGN-DYNAMIC-BLOCK.md §4.4.
|
||||
//
|
||||
// Cross-runtime aligned with Plexum's dynmem/kb_tools.go — same tool
|
||||
// names, same input shapes, same return shapes (so ClawSkills
|
||||
// workflow text reads identically on either runtime).
|
||||
//
|
||||
// Returns ToolResult.content[].text for both ok and error cases. The
|
||||
// `isError: true` flag surfaces errors to the model rather than RPC-
|
||||
// failing the tool call.
|
||||
|
||||
import { Block as KBBlock } from './kbblock.js';
|
||||
import { KBClient } from './kbclient.js';
|
||||
|
||||
interface ToolCtx {
|
||||
agentId?: string;
|
||||
sessionId?: string;
|
||||
}
|
||||
|
||||
interface ToolResult {
|
||||
content: Array<{ type: 'text'; text: string }>;
|
||||
isError?: boolean;
|
||||
}
|
||||
|
||||
function ok(text: string): ToolResult {
|
||||
return { content: [{ type: 'text', text }] };
|
||||
}
|
||||
|
||||
function err(text: string): ToolResult {
|
||||
return { isError: true, content: [{ type: 'text', text }] };
|
||||
}
|
||||
|
||||
/** Dependencies the 5 KB tools share. Built once in index.ts. */
|
||||
export interface KBDeps {
|
||||
/** HF backend KB HTTP client. */
|
||||
client: KBClient | null;
|
||||
/** Resolve hf-token for the agent at call time (via secret-mgr). null → no auth */
|
||||
tokenFor: ((agentId: string) => Promise<string | null>) | null;
|
||||
/** Build new client given a token (so each call gets fresh per-agent client). */
|
||||
makeClient: ((token: string) => KBClient) | null;
|
||||
/** Best-effort current turn number; 0 is acceptable. */
|
||||
turnFor: (agentId: string) => number;
|
||||
}
|
||||
|
||||
/**
|
||||
* Resolve a per-agent KBClient. Returns null with reason if no client
|
||||
* (no agent context / no token / no backend URL).
|
||||
*/
|
||||
async function clientFor(deps: KBDeps, ctx: ToolCtx): Promise<{ c: KBClient | null; reason: string }> {
|
||||
if (!ctx.agentId) return { c: null, reason: 'no agent context' };
|
||||
if (deps.makeClient && deps.tokenFor) {
|
||||
const tok = await deps.tokenFor(ctx.agentId);
|
||||
if (!tok) return { c: null, reason: 'agent has no hf-token in secret-mgr' };
|
||||
return { c: deps.makeClient(tok), reason: '' };
|
||||
}
|
||||
if (deps.client) return { c: deps.client, reason: '' };
|
||||
return { c: null, reason: 'HF KB backend unavailable' };
|
||||
}
|
||||
|
||||
// ----- 5 tool factories -----
|
||||
|
||||
export function createListKBsTool(deps: KBDeps) {
|
||||
return {
|
||||
name: 'dynamic-kb-list-kbs',
|
||||
description: 'List HarborForge Knowledge Bases the agent can access. Optional project-code filter.',
|
||||
parameters: {
|
||||
type: 'object',
|
||||
properties: { 'project-code': { type: 'string' } },
|
||||
},
|
||||
async execute(_id: string, params: any, ctxArg?: ToolCtx): Promise<ToolResult> {
|
||||
const ctx = ctxArg ?? {};
|
||||
const r = await clientFor(deps, ctx);
|
||||
if (!r.c) return err('dynamic-kb-list-kbs: ' + r.reason);
|
||||
const proj = params?.['project-code'];
|
||||
try {
|
||||
const kbs = await r.c.listKBs(typeof proj === 'string' ? proj : undefined);
|
||||
const lines: string[] = [];
|
||||
if (proj) lines.push(`project: ${proj}`);
|
||||
lines.push(`kbs: ${kbs.length}`, '');
|
||||
for (const k of kbs) {
|
||||
lines.push(`[${k.knowledge_base_code}] ${k.title}`);
|
||||
lines.push(` ${k.description || ''}`, '');
|
||||
}
|
||||
lines.push(`Call dynamic-kb-list-topics({kb-code: "<code>"}) to drill into a KB.`);
|
||||
return ok(lines.join('\n'));
|
||||
} catch (e: any) {
|
||||
return err('dynamic-kb-list-kbs: ' + (e?.message || String(e)));
|
||||
}
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export function createListTopicsTool(deps: KBDeps) {
|
||||
return {
|
||||
name: 'dynamic-kb-list-topics',
|
||||
description: 'List topics in one HF KB by code.',
|
||||
parameters: {
|
||||
type: 'object',
|
||||
properties: { 'kb-code': { type: 'string' } },
|
||||
required: ['kb-code'],
|
||||
},
|
||||
async execute(_id: string, params: any, ctxArg?: ToolCtx): Promise<ToolResult> {
|
||||
const ctx = ctxArg ?? {};
|
||||
const r = await clientFor(deps, ctx);
|
||||
if (!r.c) return err('dynamic-kb-list-topics: ' + r.reason);
|
||||
const kbCode = String(params?.['kb-code'] ?? '');
|
||||
if (!kbCode) return err('dynamic-kb-list-topics: kb-code required');
|
||||
try {
|
||||
const ts = await r.c.listTopics(kbCode);
|
||||
const lines = [
|
||||
`kb: ${kbCode}`,
|
||||
`topics: ${ts.length}`,
|
||||
'',
|
||||
...ts.flatMap((t) => [`[${t.id}] ${t.topic}`, ` ${t.description || ''}`, '']),
|
||||
`Call dynamic-kb-list-facts({kb-code: "${kbCode}", topic-ids: [<id>, ...]}) to drill into facts.`,
|
||||
];
|
||||
return ok(lines.join('\n'));
|
||||
} catch (e: any) {
|
||||
return err('dynamic-kb-list-topics: ' + (e?.message || String(e)));
|
||||
}
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export function createListFactsTool(deps: KBDeps) {
|
||||
return {
|
||||
name: 'dynamic-kb-list-facts',
|
||||
description: 'List fact previews (id/topic/title/snippet) in given topics. Feed into dynamic-kb-cache.',
|
||||
parameters: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
'kb-code': { type: 'string' },
|
||||
'topic-ids': { type: 'array', items: { type: 'integer' } },
|
||||
},
|
||||
required: ['kb-code', 'topic-ids'],
|
||||
},
|
||||
async execute(_id: string, params: any, ctxArg?: ToolCtx): Promise<ToolResult> {
|
||||
const ctx = ctxArg ?? {};
|
||||
const r = await clientFor(deps, ctx);
|
||||
if (!r.c) return err('dynamic-kb-list-facts: ' + r.reason);
|
||||
const kbCode = String(params?.['kb-code'] ?? '');
|
||||
const topicIds = Array.isArray(params?.['topic-ids']) ? params['topic-ids'].map((x: any) => Number(x)) : [];
|
||||
if (!kbCode || topicIds.length === 0) {
|
||||
return err('dynamic-kb-list-facts: kb-code + topic-ids required');
|
||||
}
|
||||
try {
|
||||
const facts = await r.c.listFacts(kbCode, topicIds);
|
||||
const lines = [
|
||||
`kb: ${kbCode}`,
|
||||
`topics: [${topicIds.join(', ')}]`,
|
||||
`facts: ${facts.length}`,
|
||||
'',
|
||||
...facts.flatMap((f) => [
|
||||
`[${f.id}] (topic ${f.topic_id}/${f.topic_slug}) ${f.title}`,
|
||||
` ${f.snippet}`,
|
||||
'',
|
||||
]),
|
||||
`Call dynamic-kb-cache({kb-code: "${kbCode}", fact-ids: [<id>, ...]}) to commit selected facts to your kb-block.`,
|
||||
];
|
||||
return ok(lines.join('\n'));
|
||||
} catch (e: any) {
|
||||
return err('dynamic-kb-list-facts: ' + (e?.message || String(e)));
|
||||
}
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export function createCacheTool(deps: KBDeps) {
|
||||
return {
|
||||
name: 'dynamic-kb-cache',
|
||||
description: 'Cache KB facts into your per-session kb-block (visible next turn).',
|
||||
parameters: {
|
||||
type: 'object',
|
||||
properties: {
|
||||
'kb-code': { type: 'string' },
|
||||
'fact-ids': { type: 'array', items: { type: 'integer' } },
|
||||
'previous-dynamic-id': { type: 'string' },
|
||||
},
|
||||
required: ['kb-code', 'fact-ids'],
|
||||
},
|
||||
async execute(_id: string, params: any, ctxArg?: ToolCtx): Promise<ToolResult> {
|
||||
const ctx = ctxArg ?? {};
|
||||
if (!ctx.agentId || !ctx.sessionId) {
|
||||
return err('dynamic-kb-cache: no per-session context');
|
||||
}
|
||||
const r = await clientFor(deps, ctx);
|
||||
if (!r.c) return err('dynamic-kb-cache: ' + r.reason);
|
||||
const kbCode = String(params?.['kb-code'] ?? '');
|
||||
const factIds = Array.isArray(params?.['fact-ids']) ? params['fact-ids'].map((x: any) => Number(x)) : [];
|
||||
if (!kbCode || factIds.length === 0) {
|
||||
return err('dynamic-kb-cache: kb-code + fact-ids required');
|
||||
}
|
||||
let block: KBBlock;
|
||||
try {
|
||||
block = KBBlock.open(ctx.agentId, ctx.sessionId);
|
||||
} catch (e: any) {
|
||||
return err('dynamic-kb-cache: open block: ' + (e?.message || String(e)));
|
||||
}
|
||||
const toFetch: number[] = [];
|
||||
const alreadyCached: number[] = [];
|
||||
for (const id of factIds) {
|
||||
if (block.has(id)) alreadyCached.push(id);
|
||||
else toFetch.push(id);
|
||||
}
|
||||
let fetched: Array<{ id: number; kb_code: string; topic_slug: string; content: string }> = [];
|
||||
if (toFetch.length > 0) {
|
||||
try {
|
||||
fetched = await r.c.getFacts(kbCode, toFetch);
|
||||
} catch (e: any) {
|
||||
return err('dynamic-kb-cache: ' + (e?.message || String(e)));
|
||||
}
|
||||
}
|
||||
const turn = deps.turnFor(ctx.agentId);
|
||||
const fetchedByID = new Map(fetched.map((f) => [f.id, f]));
|
||||
const added: number[] = [];
|
||||
for (const id of toFetch) {
|
||||
const f = fetchedByID.get(id);
|
||||
if (!f) continue;
|
||||
if (block.add(f.id, kbCode, f.topic_slug, f.content, turn)) added.push(f.id);
|
||||
}
|
||||
try {
|
||||
block.save();
|
||||
} catch (e: any) {
|
||||
return err('dynamic-kb-cache: save: ' + (e?.message || String(e)));
|
||||
}
|
||||
const missing = toFetch.filter((id) => !added.includes(id));
|
||||
return ok(
|
||||
JSON.stringify({
|
||||
added: added.sort((a, b) => a - b),
|
||||
already_cached: alreadyCached.sort((a, b) => a - b),
|
||||
missing: missing.length ? missing.sort((a, b) => a - b) : undefined,
|
||||
note: 'Newly cached facts are available starting your next turn.',
|
||||
}),
|
||||
);
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
export function createEvictTool(_deps: KBDeps) {
|
||||
return {
|
||||
name: 'dynamic-kb-evict',
|
||||
description: "Remove cached facts from your kb-block. Takes effect next turn.",
|
||||
parameters: {
|
||||
type: 'object',
|
||||
properties: { 'fact-ids': { type: 'array', items: { type: 'integer' } } },
|
||||
required: ['fact-ids'],
|
||||
},
|
||||
async execute(_id: string, params: any, ctxArg?: ToolCtx): Promise<ToolResult> {
|
||||
const ctx = ctxArg ?? {};
|
||||
if (!ctx.agentId || !ctx.sessionId) {
|
||||
return err('dynamic-kb-evict: no per-session context');
|
||||
}
|
||||
const factIds = Array.isArray(params?.['fact-ids']) ? params['fact-ids'].map((x: any) => Number(x)) : [];
|
||||
if (factIds.length === 0) return err('dynamic-kb-evict: fact-ids required');
|
||||
let block: KBBlock;
|
||||
try {
|
||||
block = KBBlock.open(ctx.agentId, ctx.sessionId);
|
||||
} catch (e: any) {
|
||||
return err('dynamic-kb-evict: open block: ' + (e?.message || String(e)));
|
||||
}
|
||||
const evicted = block.remove(factIds);
|
||||
try {
|
||||
block.save();
|
||||
} catch (e: any) {
|
||||
return err('dynamic-kb-evict: save: ' + (e?.message || String(e)));
|
||||
}
|
||||
const notCached = factIds.filter((id: number) => !evicted.includes(id));
|
||||
return ok(
|
||||
JSON.stringify({
|
||||
evicted: evicted.sort((a, b) => a - b),
|
||||
not_cached: notCached.length ? notCached.sort((a: number, b: number) => a - b) : undefined,
|
||||
note: 'Evictions take effect starting your next turn.',
|
||||
}),
|
||||
);
|
||||
},
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user