import { BaseTool, ToolMetadata, ToolResponse } from './base.js';
import { PathValidationUtil, PathValidationError } from '../utils/PathValidationUtil.js';
import { GetFileContentsArgs } from './types/GetFileContentsArgs.js';
import { FILE_PATH_SCHEMA } from '../utils/validation.js';
import { defaultCachedHandlers } from '../resources/CachedConcreteHandlers.js';
export class GetFileContentsTool extends BaseTool<GetFileContentsArgs> {
name = 'obsidian_get_file_contents';
description = 'Read vault note. Returns preview by default, or specify format (content/metadata/frontmatter/plain/html).';
metadata: ToolMetadata = {
category: 'file-operations',
keywords: ['read', 'get', 'content', 'file', 'note'],
version: '1.1.0'
};
inputSchema = {
type: 'object' as const,
properties: {
filepath: FILE_PATH_SCHEMA,
format: {
type: 'string',
enum: ['content', 'metadata', 'frontmatter', 'plain', 'html'],
description: 'Format to retrieve: content (full markdown), metadata (file info only), frontmatter (YAML only), plain (no markdown), html (rendered). If not specified, returns preview mode with frontmatter + first 200 chars + statistics (optimal performance)'
}
},
required: ['filepath']
};
async executeTyped(args: GetFileContentsArgs): Promise<ToolResponse> {
try {
// Validate the filepath using new utility
try {
PathValidationUtil.validate(args.filepath, 'filepath');
} catch (error) {
if (error instanceof PathValidationError) {
return this.handleSimplifiedError(
error,
'Provide a valid filepath to read. Use obsidian_list_files_in_vault to browse available files first',
{
filepath: 'notes/example.md',
format: 'content'
}
);
}
throw error;
}
// Performance optimization: Use cached resource handler when possible
// - No format specified: Use vault://note/{path} resource with 2 min cache (returns preview mode)
// - Format specified: Use direct client call for specific formats
let result;
if (!args.format) {
result = await defaultCachedHandlers.note.handleRequest(`vault://note/${args.filepath}`);
} else {
const client = this.getClient();
result = await client.getFileContents(args.filepath, args.format);
}
return this.formatResponse(result);
} catch (error: unknown) {
// Use the new handleHttpError method with custom handlers for specific status codes
if (error && typeof error === 'object' && 'response' in error && (error as any).response?.status) {
return this.handleHttpError(error, {
404: {
message: 'File not found',
suggestion: 'Alternative options: Browse files in your vault (tool: obsidian_list_files_in_vault), Search for files by content (tool: obsidian_simple_search)',
example: { query: 'search term' }
}
});
}
// Fallback to basic error handling for non-HTTP errors
return this.handleSimplifiedError(
error,
'Alternative options: Browse files in your vault (tool: obsidian_list_files_in_vault), Search for files by content (tool: obsidian_simple_search)',
{ query: 'search term' }
);
}
}
}
