Text Editing Toolset Documentation#

This toolset provides tools for reading, creating, and modifying text-based files within the current directory.

read_text_file#

Purpose: Reads the content of a specified text-based file in the current directory. Supports plain text, code files, markdown, and other text-based formats.

Parameters#

Success Case Example#

Input:

{
  "file_path": "example.txt"
}

Output:

{
  "file_path": "example.txt",
  "content": "This is the content of example.txt"
}

Error Case Examples#

1. Missing File Path:

   {
     "error": "The required file_path was not specified"
   }

2. Invalid Path:

   {
     "error": "Access to the specified path 'example.txt' is not allowed."
   }

3. File Does Not Exist:

   {
     "error": "The specified file 'example.txt' does not exist."
   }

4. Not a Text File:

   {
     "error": "The specified file 'example.png' is not a text-based file."
   }

5. Read Error:

   {
     "error": "An error occurred while reading the file: Permission denied"
   }

Notes#

• Ensures the file is within the current directory and is not a binary file.
• Supports plain text, code files, markdown, and other text-based formats.

create_text_file#

Purpose: Creates a text file at the specified path with the given content. Ensures the file is created within the current directory and does not overwrite existing files.

Parameters#

Success Case Example#

Input:

{
  "file_path": "new_file.txt",
  "content": "This is the content of new_file.txt"
}

Output:

{
  "message": "File 'new_file.txt' created successfully."
}

Error Case Examples#

1. Missing File Path:

   {
     "error": "The required file_path was not specified"
   }

2. Missing Content:

   {
     "error": "The required content was not specified"
   }

3. Invalid Path:

   {
     "error": "Access to the specified path 'new_file.txt' is not allowed."
   }

4. File Already Exists:

   {
     "error": "The file 'new_file.txt' already exists."
   }

5. Write Error:

   {
     "error": "An error occurred while creating the file: Permission denied"
   }

Notes#

• Ensures the file is created within the current directory.
• Does not overwrite existing files.

replace_text_in_text_file#

Purpose: Searches for the specified text in a text-based file and replaces it with alternative text. Ensures the file is within the current directory and is a text file.

Parameters#

Success Case Example#

Input:

{
  "file_path": "example.txt",
  "search": "old text",
  "replace_with": "new text"
}

Output:

{
  "file_path": "example.txt",
  "new_content": "This is the updated content with new text"
}

Error Case Examples#

1. Missing File Path:

   {
     "error": "The required file_path was not specified"
   }

2. Missing Search Text:

   {
     "error": "The required search_text was not specified"
   }

3. Missing Replacement Text:

   {
     "error": "The required replacement_text was not specified"
   }

4. Invalid Path:

   {
     "error": "The specified path 'example.txt' is not allowed."
   }

5. File Does Not Exist:

   {
     "error": "The specified file 'example.txt' does not exist."
   }

6. Search Text Not Found:

   {
     "error": "An error occurred while modifying the file: Unable to find search text in the file"
   }

7. Write Error:

   {
     "error": "An error occurred while modifying the file: Permission denied"
   }

Notes#

• Ensures the file is within the current directory and is a text file.
• Counts changes made to detect if nothing was modified.