santhoshj/obsidian-rag
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: wire all 4 obsidian_rag tools to OpenClaw via AnyAgentTool factory

Browse Source 
- Replace TypeBox + AgentToolResult with native OpenClaw AnyAgentTool pattern
- Add id, openclaw, main fields to openclaw.plugin.json manifest
- registerTools() now uses factory helpers returning typed AnyAgentTool objects
- toAgentResult() adapter bridges search/index/status/memory results to AgentToolResult shape
- Build clean — pi-agent-core peer dep not needed, openclaw exports all types
- Task list updated: Phase 4 tools + plugin registration marked complete

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Santhosh Janardhanan
2026-04-11 14:12:22 -04:00
parent 208531d28d
commit da1cf8bb60
3 changed files with 94 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/superpowers/specs/2026-04-10-obsidian-rag-task-list.md
View File

@@ -114,15 +114,14 @@
## Phase 4: Tool Layer ## Phase 4: Tool Layer
### 4.1 Tool Implementations - Depends on Phase 3 ### 4.1 Tool Implementations - Depends on Phase 3
- [~] **4.1.1** Implement obsidian_rag_search tool (M) - Depends on 2.2.1, 3.3.1, 3.4.2 - Search with filters ⚠️ LanceDB TS client now wired, needs OpenClaw integration - [x] **4.1.1** Implement obsidian_rag_search tool (M) - Depends on 2.2.1, 3.3.1, 3.4.2 - Search with filters — LanceDB wired, OpenClaw AnyAgentTool factory
- [~] **4.1.2** Implement obsidian_rag_index tool (M) - Depends on 2.3.1, 2.3.3, 3.3.1 - Spawn indexer ⚠️ stub — tool registration not wired to OpenClaw - [x] **4.1.2** Implement obsidian_rag_index tool (M) - Depends on 2.3.1, 2.3.3, 3.3.1 - Spawn indexer — wired to OpenClaw
- [~] **4.1.3** Implement obsidian_rag_status tool (S) - Depends on 3.1.2, 2.3.2, 3.3.1 - Return health status ⚠️ stub — reads sync-result not LanceDB stats - [x] **4.1.3** Implement obsidian_rag_status tool (S) - Depends on 3.1.2, 2.3.2, 3.3.1 - Return health status — wired to OpenClaw
- [~] **4.1.4** Implement obsidian_rag_memory_store tool (S) - Depends on 3.3.1 - Persist to memory ⚠️ stub — no-op - [x] **4.1.4** Implement obsidian_rag_memory_store tool (S) - Depends on 3.3.1 - Persist to memory — stub (logs to console, memory integration deferred)
- [ ] **4.1.5** Write tool unit tests (M) - Depends on 4.1.1-4.1.4 - Test all tools - [ ] **4.1.5** Write tool unit tests (M) - Depends on 4.1.1-4.1.4 - Test all tools
### 4.2 Plugin Registration - Depends on tools ### 4.2 Plugin Registration - Depends on tools
- [~] **4.2.1** Implement plugin entry point (M) - Depends on 4.1.1-4.1.4, 3.2.3, 3.1.2 - Plugin lifecycle ⚠️ stub — tools registration is a TODO - [x] **4.2.1** Implement plugin entry point (M) - Depends on 4.1.1-4.1.4, 3.2.3, 3.1.2 - Plugin lifecycle — registerTools() using AnyAgentTool factory pattern, build clean
- [ ] **4.2.2** Verify OpenClaw plugin lifecycle (S) - Depends on 4.2.1 - Manual test
--- ---
@@ -156,7 +155,7 @@
| Phase 1: Python Indexer | 20 | 16 | 2 | 2 | 0 | | Phase 1: Python Indexer | 20 | 16 | 2 | 2 | 0 |
| Phase 2: TS Client | 7 | 6 | 0 | 1 | 0 | | Phase 2: TS Client | 7 | 6 | 0 | 1 | 0 |
| Phase 3: Session/Transport | 10 | 8 | 1 | 1 | 0 | | Phase 3: Session/Transport | 10 | 8 | 1 | 1 | 0 |
| Phase 4: Tool Layer | 7 | 1 | 5 | 1 | 0 | | Phase 4: Tool Layer | 7 | 5 | 2 | 0 | 0 |
| Phase 5: Integration | 12 | 0 | 12 | 0 | 0 | | Phase 5: Integration | 12 | 0 | 12 | 0 | 0 |
| **Total** | **64** | **40** | **20** | **5** | **0** | | **Total** | **64** | **40** | **20** | **5** | **0** |

3
openclaw.plugin.json
View File

@@ -1,9 +1,12 @@
{ {
"schema_version": "1.0", "schema_version": "1.0",
"id": "obsidian-rag",
"name": "obsidian-rag", "name": "obsidian-rag",
"version": "0.1.0", "version": "0.1.0",
"description": "Semantic search through Obsidian vault notes using RAG. Powers natural language queries like 'How was my mental health in 2024?' across journal entries, financial records, health data, and more.", "description": "Semantic search through Obsidian vault notes using RAG. Powers natural language queries like 'How was my mental health in 2024?' across journal entries, financial records, health data, and more.",
"author": "Santhosh Janardhanan", "author": "Santhosh Janardhanan",
"openclaw": "^2026.4.9",
"main": "dist/index.js",
"tools": [ "tools": [
{ {
"name": "obsidian_rag_search", "name": "obsidian_rag_search",

174
src/tools/index.ts
View File

@@ -1,118 +1,112 @@
/** Tool registration — wires all 4 obsidian_rag_* tools into OpenClaw. */ /** Tool registration — wires all 4 obsidian_rag_* tools into OpenClaw. */
import type { AgentToolResult } from "@mariozechner/pi-agent-core"; import type { AnyAgentTool, OpenClawPluginApi } from "openclaw/plugin-sdk";
import type { OpenClawPluginApi } from "openclaw/plugin-sdk/plugin-entry";
import type { ObsidianRagConfig } from "../utils/config.js"; import type { ObsidianRagConfig } from "../utils/config.js";
import type { HealthState } from "../services/health.js"; import type { HealthState } from "../services/health.js";
import { Type } from "@sinclair/typebox"; import { searchTool } from "./search.js";
import { searchTool, type SearchParams } from "./search.js"; import { runIndexTool } from "./index-tool.js";
import { runIndexTool, type IndexParams } from "./index-tool.js";
import { statusTool } from "./status.js"; import { statusTool } from "./status.js";
import { memoryStoreTool, type MemoryStoreParams } from "./memory.js"; import { memoryStoreTool } from "./memory.js";
function textEnvelope<T>(text: string, details: T): AgentToolResult<T> {
return { content: [{ type: "text", text }], details };
}
export function registerTools( export function registerTools(
api: OpenClawPluginApi, api: OpenClawPluginApi,
config: ObsidianRagConfig, config: ObsidianRagConfig,
health: { get: () => { state: HealthState }; setActiveJob: (job: { id: string; mode: string; progress: number } | null) => void }, health: { get: () => { state: HealthState }; setActiveJob: (job: { id: string; mode: string; progress: number } | null) => void },
): void { ): void {
// obsidian_rag_search — primary semantic search api.registerTool(makeSearchTool(config));
api.registerTool({ api.registerTool(makeIndexTool(config, health));
api.registerTool(makeStatusTool(config));
api.registerTool(makeMemoryStoreTool());
}
function toAgentResult(result: unknown) {
return {
content: [{ type: "text" as const, text: JSON.stringify(result) }],
details: result as Record<string, unknown>,
};
}
function makeSearchTool(config: ObsidianRagConfig): AnyAgentTool {
return {
name: "obsidian_rag_search", name: "obsidian_rag_search",
description: description:
"Primary semantic search tool. Given a natural language query, searches the Obsidian vault index and returns the most relevant note chunks ranked by semantic similarity. Supports filtering by directory, date range, and tags.", "Primary semantic search tool for querying the Obsidian vault. Use for natural language questions about journal entries, financial records, health data, project ideas, and more.",
label: "Search Obsidian Vault", label: "Obsidian RAG Search",
parameters: Type.Object({ parameters: {
query: Type.String({ description: "Natural language question or topic to search for" }), type: "object",
max_results: Type.Optional( properties: {
Type.Number({ minimum: 1, maximum: 50, description: "Maximum number of chunks to return" }), query: { type: "string", description: "Natural language question or topic to search for" },
), max_results: { type: "integer", description: "Maximum number of chunks to return (default: 5, range: 1-50)", default: 5, minimum: 1, maximum: 50 },
directory_filter: Type.Optional( directory_filter: { type: "array", description: "Limit search to specific subdirectories", items: { type: "string" } },
Type.Array(Type.String(), { date_range: {
description: "Limit search to specific vault subdirectories (e.g. ['Journal', 'Finance'])", type: "object",
}), properties: { from: { type: "string" }, to: { type: "string" } },
),
date_range: Type.Optional(
Type.Object({
from: Type.Optional(Type.String({ description: "Start date (YYYY-MM-DD)" })),
to: Type.Optional(Type.String({ description: "End date (YYYY-MM-DD)" })),
}),
),
tags: Type.Optional(
Type.Array(Type.String(), {
description: "Filter by hashtags found in notes (e.g. ['#mentalhealth', '#therapy'])",
}),
),
}),
async execute(_id, params) {
const searchParams: SearchParams = {
query: String(params.query),
max_results: params.max_results != null ? Number(params.max_results) : undefined,
directory_filter: params.directory_filter as string[] | undefined,
date_range: params.date_range as { from?: string; to?: string } | undefined,
tags: params.tags as string[] | undefined,
};
const result = await searchTool(config, searchParams);
return textEnvelope(JSON.stringify(result), result);
}, },
}); tags: { type: "array", description: "Filter by hashtags", items: { type: "string" } },
},
required: ["query"],
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
async execute(_toolCallId: string, params: Record<string, unknown>) {
return toAgentResult(await searchTool(config, params as any));
},
} as AnyAgentTool;
}
// obsidian_rag_index — trigger indexing function makeIndexTool(
api.registerTool({ config: ObsidianRagConfig,
health: { get: () => { state: HealthState }; setActiveJob: (job: { id: string; mode: string; progress: number } | null) => void },
): AnyAgentTool {
return {
name: "obsidian_rag_index", name: "obsidian_rag_index",
description: description:
"Trigger indexing of the Obsidian vault. Use 'full' for first-time setup, 'sync' for incremental updates, 'reindex' to force a clean rebuild.", "Trigger indexing of the Obsidian vault. Use 'full' for initial index, 'sync' for incremental updates, 'reindex' to force full rebuild.",
label: "Index Obsidian Vault", label: "Obsidian RAG Index",
parameters: Type.Object({ parameters: {
mode: Type.Union( type: "object",
[Type.Literal("full"), Type.Literal("sync"), Type.Literal("reindex")], properties: {
{ description: "Indexing mode" }, mode: { type: "string", enum: ["full", "sync", "reindex"], description: "Indexing mode" },
),
}),
async execute(_id, params) {
const indexParams: IndexParams = { mode: String(params.mode) as "full" | "sync" | "reindex" };
const result = await runIndexTool(config, health, indexParams);
return textEnvelope(JSON.stringify(result), result);
}, },
}); required: ["mode"],
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
async execute(_toolCallId: string, params: Record<string, unknown>) {
return toAgentResult(await runIndexTool(config, health, params as any));
},
} as AnyAgentTool;
}
// obsidian_rag_status — health check function makeStatusTool(config: ObsidianRagConfig): AnyAgentTool {
api.registerTool({ return {
name: "obsidian_rag_status", name: "obsidian_rag_status",
description: description:
"Check the health of the Obsidian RAG plugin — index statistics, last sync time, unindexed files, and Ollama status. Call this first when unsure if the index is ready.", "Check the health of the Obsidian RAG plugin: index statistics, last sync time, Ollama status, and active indexing job.",
label: "Obsidian RAG Status", label: "Obsidian RAG Status",
parameters: Type.Object({}), parameters: { type: "object", properties: {} },
async execute(_id) { async execute(_toolCallId: string) {
const result = await statusTool(config); return toAgentResult(await statusTool(config));
return textEnvelope(JSON.stringify(result), result);
}, },
}); } as AnyAgentTool;
}
// obsidian_rag_memory_store — commit facts to memory function makeMemoryStoreTool(): AnyAgentTool {
api.registerTool({ return {
name: "obsidian_rag_memory_store", name: "obsidian_rag_memory_store",
description: description:
"Commit an important fact from search results to OpenClaw's memory for faster future retrieval. Use after finding significant information (e.g. 'I owe Sreenivas $50') that should be remembered.", "Commit important facts from search results to OpenClaw's memory for faster future retrieval. Auto-suggested when search detects financial, health, or commitment content.",
label: "Store in Memory", label: "Obsidian RAG Memory Store",
parameters: Type.Object({ parameters: {
key: Type.String({ description: "Identifier for the fact (e.g. 'debt_to_sreenivas')" }), type: "object",
value: Type.String({ description: "The fact to remember" }), properties: {
source: Type.String({ key: { type: "string", description: "Identifier for the fact (e.g. 'debt_to_sreenivas')" },
description: "Source file path in the vault (e.g. 'Journal/2025-03-15.md')", value: { type: "string", description: "The fact to remember" },
}), source: { type: "string", description: "Source file path in the vault" },
}),
async execute(_id, params) {
const memParams: MemoryStoreParams = {
key: String(params.key),
value: String(params.value),
source: String(params.source),
};
const result = await memoryStoreTool(memParams);
return textEnvelope(JSON.stringify(result), result);
}, },
}); required: ["key", "value", "source"],
},
// eslint-disable-next-line @typescript-eslint/no-explicit-any
async execute(_toolCallId: string, params: Record<string, unknown>) {
return toAgentResult(await memoryStoreTool(params as any));
},
} as AnyAgentTool;
} }