Skip to main content
Version: 0.22.0

Interface: KnowledgeStore

Defined in: extensions/knowledge/knowledgeStore.ts:87

Where the knowledge base lives. The kit ships one over markdown files (createFileKnowledgeStore()); another one (a database, a vector store) implements this interface and is passed with AgentSpec.knowledgeStore. Pages are never deleted or renamed: their ids are what links point to.

Methods​

check()​

check(): Promise<CheckReport>;

Defined in: extensions/knowledge/knowledgeStore.ts:121

The mechanical problems.

Returns​

Promise<CheckReport>


create()​

create(
type,
slug,
title,
content,
fields?
): Promise<string>;

Defined in: extensions/knowledge/knowledgeStore.ts:95

A new page; fails if the id exists or a link points nowhere. Returns its id.

Parameters​

ParameterType
typestring
slugstring
titlestring
contentstring
fields?FieldChanges

Returns​

Promise<string>


createMany()​

createMany(pages): Promise<string[]>;

Defined in: extensions/knowledge/knowledgeStore.ts:100

Several new pages at once, whose links may point to each other (a summary and the concepts it feeds): all are created, or none. Returns their ids.

Parameters​

ParameterType
pagesreadonly NewPage[]

Returns​

Promise<string[]>


edit()​

edit(
id,
oldText,
newText,
fields?
): Promise<void>;

Defined in: extensions/knowledge/knowledgeStore.ts:102

Replaces the one occurrence of oldText in a page's body; fails if it's missing or appears more than once.

Parameters​

ParameterType
idstring
oldTextstring
newTextstring
fields?FieldChanges

Returns​

Promise<void>


index()​

index(): Promise<string>;

Defined in: extensions/knowledge/knowledgeStore.ts:112

The catalog: every active or superseded page, one line each, by section, linked by id (concept/bowline), as everything the model reads.

Returns​

Promise<string>


list()​

list(): Promise<PageInfo[]>;

Defined in: extensions/knowledge/knowledgeStore.ts:91

Every page but the retired ones.

Returns​

Promise<PageInfo[]>


log()​

log(
operation,
what,
pages?
): Promise<void>;

Defined in: extensions/knowledge/knowledgeStore.ts:114

Adds an entry to the operation log, dated today.

Parameters​

ParameterType
operationstring
whatstring
pages?readonly string[]

Returns​

Promise<void>


overview()​

overview(): Promise<string>;

Defined in: extensions/knowledge/knowledgeStore.ts:123

The overview: a living synthesis of the whole knowledge base ("" if none yet).

Returns​

Promise<string>


read()​

read(id): Promise<KnowledgePage | null>;

Defined in: extensions/knowledge/knowledgeStore.ts:93

A page, retired ones included; null if there's none.

Parameters​

ParameterType
idstring

Returns​

Promise<KnowledgePage | null>


recentLog()?​

optional recentLog(limit?): Promise<string[]>;

Defined in: extensions/knowledge/knowledgeStore.ts:119

The latest entries of the operation log, newest first, as markdown (e.g. "## [2026-10-04] ingest | …"). Optional: a store without it can't show the log to the agent.

Parameters​

ParameterType
limit?number

Returns​

Promise<string[]>


retire()​

retire(id, reason): Promise<void>;

Defined in: extensions/knowledge/knowledgeStore.ts:108

Takes a page out of the index and the search (it's kept, and can be restored).

Parameters​

ParameterType
idstring
reasonstring

Returns​

Promise<void>


rewrite()​

rewrite(
id,
content,
fields?
): Promise<void>;

Defined in: extensions/knowledge/knowledgeStore.ts:104

Replaces a page's whole body, keeping its id.

Parameters​

ParameterType
idstring
contentstring
fields?FieldChanges

Returns​

Promise<void>


search(query, limit?): Promise<SearchHit[]>;

Defined in: extensions/knowledge/knowledgeStore.ts:110

Pages matching words of query in their title, aliases or body, best first.

Parameters​

ParameterType
querystring
limit?number

Returns​

Promise<SearchHit[]>


supersede()​

supersede(
id,
by,
reason?
): Promise<void>;

Defined in: extensions/knowledge/knowledgeStore.ts:106

Marks a page superseded by another, with a notice at its top.

Parameters​

ParameterType
idstring
bystring
reason?string

Returns​

Promise<void>


types()​

types(): readonly PageType[];

Defined in: extensions/knowledge/knowledgeStore.ts:89

The page types it holds, the kit's and the agent's.

Returns​

readonly PageType[]


writeOverview()​

writeOverview(content): Promise<void>;

Defined in: extensions/knowledge/knowledgeStore.ts:125

Replaces the overview.

Parameters​

ParameterType
contentstring

Returns​

Promise<void>