Files
simstudioai--sim/apps/sim/tools/obsidian/search.ts
T
wehub-resource-sync d25d482dc2
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
Publish CLI Package / publish-npm (push) Has been cancelled
Publish Python SDK / publish-pypi (push) Has been cancelled
Publish TypeScript SDK / publish-npm (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

96 lines
2.8 KiB
TypeScript

import type { ToolConfig } from '@/tools/types'
import type { ObsidianSearchParams, ObsidianSearchResponse } from './types'
export const searchTool: ToolConfig<ObsidianSearchParams, ObsidianSearchResponse> = {
id: 'obsidian_search',
name: 'Obsidian Search',
description: 'Search for text across notes in your Obsidian vault',
version: '1.0.0',
params: {
apiKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'API key from Obsidian Local REST API plugin settings',
},
baseUrl: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'Base URL for the Obsidian Local REST API',
},
query: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'Text to search for across vault notes',
},
contextLength: {
type: 'number',
required: false,
visibility: 'user-or-llm',
description: 'Number of characters of context around each match (default: 100)',
},
},
request: {
url: (params) => {
const base = params.baseUrl.replace(/\/$/, '')
const contextParam = params.contextLength ? `&contextLength=${params.contextLength}` : ''
return `${base}/search/simple/?query=${encodeURIComponent(params.query)}${contextParam}`
},
method: 'POST',
headers: (params) => ({
Authorization: `Bearer ${params.apiKey}`,
Accept: 'application/json',
}),
},
transformResponse: async (response) => {
if (!response.ok) {
const error = await response.json().catch(() => ({ message: 'Unknown error' }))
throw new Error(`Search failed: ${error.message ?? response.statusText}`)
}
const data = await response.json()
return {
success: true,
output: {
results:
data?.map(
(item: {
filename: string
score: number
matches: Array<{ match: { start: number; end: number }; context: string }>
}) => ({
filename: item.filename ?? '',
score: item.score ?? 0,
matches:
item.matches?.map((m: { context: string }) => ({
context: m.context ?? '',
})) ?? [],
})
) ?? [],
},
}
},
outputs: {
results: {
type: 'json',
description: 'Search results with filenames, scores, and matching contexts',
properties: {
filename: { type: 'string', description: 'Path to the matching note' },
score: { type: 'number', description: 'Relevance score' },
matches: {
type: 'json',
description: 'Matching text contexts',
properties: {
context: { type: 'string', description: 'Text surrounding the match' },
},
},
},
},
},
}