|
|
@@ -37,6 +37,26 @@ Knowledge tools:
|
|
|
- `searchKnowledge({ query, userId?, limit? })`
|
|
|
- `writeKnowledge({ text, userId? })`
|
|
|
|
|
|
+## Quickstart (example flow)
|
|
|
+1) List books:
|
|
|
+```js
|
|
|
+await plugin.listKnowledgeSources();
|
|
|
+```
|
|
|
+
|
|
|
+2) Pick a book and inspect scope:
|
|
|
+```js
|
|
|
+await plugin.describeKnowledgeBook({ sourceFile: "the-psychedelic-experience.pdf" });
|
|
|
+```
|
|
|
+
|
|
|
+3) Search inside that book:
|
|
|
+```js
|
|
|
+await plugin.searchKnowledgeBook({
|
|
|
+ sourceFile: "the-psychedelic-experience.pdf",
|
|
|
+ query: "Timothy Leary quote",
|
|
|
+ limit: 5,
|
|
|
+});
|
|
|
+```
|
|
|
+
|
|
|
## Skill (Knowledge RAG Policy)
|
|
|
This repo bundles a policy skill that tells the LLM when to use knowledge tools:
|
|
|
- Skill source: `skills/knowledge-rag-policy/SKILL.md`
|
