import { BaseTool, ToolResponse, ToolMetadata } from './base.js';
import { PathValidationUtil, PathValidationType } from '../utils/PathValidationUtil.js';
import { FILE_PATH_SCHEMA } from '../utils/validation.js';
import { SimpleReplaceArgs } from './types/SimpleReplaceArgs.js';
import { hasHttpResponse } from '../utils/errorTypeGuards.js';
export class SimpleReplaceTool extends BaseTool<SimpleReplaceArgs> {
name = 'obsidian_simple_replace';
description = 'Replace text in Obsidian vault notes. Simple find-and-replace.';
metadata: ToolMetadata = {
category: 'editing',
keywords: ['replace', 'find', 'substitute', 'edit', 'text'],
version: '1.0.0'
};
inputSchema = {
type: 'object' as const,
properties: {
filepath: FILE_PATH_SCHEMA,
find: {
type: 'string' as const,
description: 'Text to find (exact match)'
},
replace: {
type: 'string' as const,
description: 'Text to replace with'
}
},
required: ['filepath', 'find', 'replace']
};
async executeTyped(args: SimpleReplaceArgs): Promise<ToolResponse> {
const { filepath, find, replace } = args;
// Input validation
if (!filepath || !find || replace === undefined) {
return this.handleSimplifiedError(
new Error('Missing required parameters'),
'Provide filepath, find, and replace parameters',
{ filepath: 'notes.md', find: 'old text', replace: 'new text' }
);
}
try {
// Validate the filepath
PathValidationUtil.validate(filepath, 'filepath', { type: PathValidationType.FILE });
const client = this.getClient();
// Get the current content
const currentContent = await client.getFileContents(filepath);
// Type assertion is safe here because we're not passing a format parameter
const contentString = currentContent as string;
// Check if text to find exists
if (!contentString.includes(find)) {
return this.handleSimplifiedError(
new Error(`Text "${find}" not found in ${filepath}`),
'Check the exact text to replace. Text search is case-sensitive.'
);
}
// Perform the replacement
const newContent = contentString.replace(find, replace);
// Update the file
await client.updateFile(filepath, newContent);
// Notify that file was updated
this.notifyFileOperation('update', filepath, {
operation: 'replace',
findLength: find.length,
replaceLength: replace.length,
contentLengthChange: replace.length - find.length
});
return this.formatResponse({
success: true,
message: `Successfully replaced "${find}" with "${replace}" in ${filepath}`,
operation: 'replace',
filepath,
find,
replace
});
} catch (error: unknown) {
// Use the new handleHttpError method with custom handlers
if (hasHttpResponse(error) && error.response?.status) {
return this.handleHttpError(error, {
404: {
message: 'File not found',
suggestion: 'File does not exist. Verify the path and use obsidian_list_files_in_vault to browse available files',
example: { filepath: 'existing-file.md', find: 'text to find', replace: 'replacement text' }
}
});
}
return this.handleSimplifiedError(error);
}
}
}
