mirror of
https://github.com/andy-stack/vaultkeeper-ai.git
synced 2026-07-22 06:42:03 +00:00
Restructure all AI function descriptions to use consistent "Call this function:" and "Do NOT use this function:" sections for improved clarity and scannability.
34 lines
No EOL
1.4 KiB
TypeScript
34 lines
No EOL
1.4 KiB
TypeScript
import { AIFunction } from "Enums/AIFunction";
|
|
import type { IAIFunctionDefinition } from "../IAIFunctionDefinition";
|
|
|
|
export const WriteVaultFile: IAIFunctionDefinition = {
|
|
name: AIFunction.WriteVaultFile,
|
|
description: `Writes content to a file, creating it if it doesn't exist or replacing its contents if it does.
|
|
|
|
Call this function:
|
|
- When creating new notes, documents, or files from scratch
|
|
- When completely rewriting a file's contents (when most/all content needs to change)
|
|
- When generating new files from templates or structured data
|
|
|
|
Do NOT use this function:
|
|
- When making small, targeted edits to existing files
|
|
- Before reading existing file content to avoid accidentally overwriting important data`,
|
|
parameters: {
|
|
type: "object",
|
|
properties: {
|
|
file_path: {
|
|
type: "string",
|
|
description: "The full path to the file within the vault (e.g., 'folder/note.md')"
|
|
},
|
|
content: {
|
|
type: "string",
|
|
description: "The complete content to write to the file. This will replace any existing content."
|
|
},
|
|
user_message: {
|
|
type: "string",
|
|
description: "A short message to be displayed to the user explaining what you're writing and why (e.g., 'Creating your daily note for today')"
|
|
}
|
|
},
|
|
required: ["file_path", "content", "user_message"]
|
|
}
|
|
} |