Merge pull request #9 from rust-mcp-stack/feat/imptove-tools-descriptions

feat: improve tools descriptions

Author: hashemix

Cargo.lock

@@ -21,10 +21,7 @@
             <td>
                 <code><b>create_directory</b></code>
             </td>
-            <td>Create a new directory or ensure a directory exists. Can create multiple
-nested directories in one operation. If the directory already exists,
-this operation will succeed silently. Perfect for setting up directory
-structures for projects or ensuring required paths exist. Only works within allowed directories.</td>
+            <td>Create a new directory or ensure a directory exists. Can create multiple nested directories in one operation. If the directory already exists, this operation will succeed silently. Perfect for setting up directory structures for projects or ensuring required paths exist. Only works within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>path</code> : string<br /></li>
@@ -36,10 +33,7 @@ structures for projects or ensuring required paths exist. Only works within allo
             <td>
                 <code><b>directory_tree</b></code>
             </td>
-            <td>Get a recursive tree view of files and directories as a JSON structure.
-Each entry includes <code>name</code>, <code>type</code> (file/directory), and <code>children</code> for directories.
-Files have no children array, while directories always have a children array (which may be empty).
-The output is formatted with 2-space indentation for readability. Only works within allowed directories.</td>
+            <td>Get a recursive tree view of files and directories as a JSON structure. Each entry includes <code>name</code>, <code>type</code> (file/directory), and <code>children</code> for directories. Files have no children array, while directories always have a children array (which may be empty). The output is formatted with 2-space indentation for readability. Only works within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>path</code> : string<br /></li>
@@ -51,9 +45,7 @@ The output is formatted with 2-space indentation for readability. Only works wit
             <td>
                 <code><b>edit_file</b></code>
             </td>
-            <td>Make line-based edits to a text file. Each edit replaces exact line sequences
-with new content. Returns a git-style diff showing the changes made.
-Only works within allowed directories.</td>
+            <td>Make line-based edits to a text file. Each edit replaces exact line sequences with new content. Returns a git-style diff showing the changes made. Only works within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>dryRun</code> : boolean<br /></li>
@@ -67,10 +59,7 @@ Only works within allowed directories.</td>
             <td>
                 <code><b>get_file_info</b></code>
             </td>
-            <td>Retrieve detailed metadata about a file or directory. Returns comprehensive
-information including size, creation time, last modified time, permissions,
-and type. This tool is perfect for understanding file characteristics
-without reading the actual content. Only works within allowed directories.</td>
+            <td>Retrieve detailed metadata about a file or directory. Returns comprehensive information including size, creation time, last modified time, permissions, and type. This tool is perfect for understanding file characteristics without reading the actual content. Only works within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>path</code> : string<br /></li>
@@ -82,9 +71,7 @@ without reading the actual content. Only works within allowed directories.</td>
             <td>
                 <code><b>list_allowed_directories</b></code>
             </td>
-            <td>Returns a list of directories that the server has permission to access.
-    Subdirectories within these allowed directories are also accessible.
-    Use this to identify which directories and their nested paths are available before attempting to access files.</td>
+            <td>Returns a list of directories that the server has permission to access Subdirectories within these allowed directories are also accessible. Use this to identify which directories and their nested paths are available before attempting to access files.</td>
             <td>
                 <ul>
                 </ul>
@@ -95,10 +82,7 @@ without reading the actual content. Only works within allowed directories.</td>
             <td>
                 <code><b>list_directory</b></code>
             </td>
-            <td>Get a detailed listing of all files and directories in a specified path.
-Results clearly distinguish between files and directories with <code>FILE</code> and <code>DIR</code>
-prefixes. This tool is essential for understanding directory structure and
-finding specific files within a directory. Only works within allowed directories.</td>
+            <td>Get a detailed listing of all files and directories in a specified path. Results clearly distinguish between files and directories with <code>FILE</code> and <code>DIR</code> prefixes. This tool is essential for understanding directory structure and finding specific files within a directory. Only works within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>path</code> : string<br /></li>
@@ -110,10 +94,7 @@ finding specific files within a directory. Only works within allowed directories
             <td>
                 <code><b>move_file</b></code>
             </td>
-            <td>Move or rename files and directories. Can move files between directories
-and rename them in a single operation. If the destination exists, the
-operation will fail. Works across different directories and can be used
-for simple renaming within the same directory. Both source and destination must be within allowed directories.</td>
+            <td>Move or rename files and directories. Can move files between directories and rename them in a single operation. If the destination exists, the operation will fail. Works across different directories and can be used for simple renaming within the same directory. Both source and destination must be within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>destination</code> : string<br /></li>
@@ -138,11 +119,7 @@ for simple renaming within the same directory. Both source and destination must
             <td>
                 <code><b>read_multiple_files</b></code>
             </td>
-            <td>Read the contents of multiple files simultaneously. This is more 
-efficient than reading files one by one when you need to analyze 
-or compare multiple files. Each file's content is returned with its 
-path as a reference. Failed reads for individual files won't stop 
-the entire operation. Only works within allowed directories.</td>
+            <td>Read the contents of multiple files simultaneously. This is more efficient than reading files one by one when you need to analyze or compare multiple files. Each file's content is returned with its path as a reference. Failed reads for individual files won't stop the entire operation. Only works within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>paths</code> : string [ ]<br /></li>
@@ -154,11 +131,7 @@ the entire operation. Only works within allowed directories.</td>
             <td>
                 <code><b>search_files</b></code>
             </td>
-            <td>Recursively search for files and directories matching a pattern.
-Searches through all subdirectories from the starting path. The search
-is case-insensitive and matches partial names. Returns full paths to all
-matching items. Great for finding files when you don't know their exact location.
-Only searches within allowed directories.</td>
+            <td>Recursively search for files and directories matching a pattern. Searches through all subdirectories from the starting path. The search is case-insensitive and matches partial names. Returns full paths to all matching items. Great for finding files when you don't know their exact location. Only searches within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>excludePatterns</code> : string [ ]<br /></li>
@@ -172,10 +145,7 @@ Only searches within allowed directories.</td>
             <td>
                 <code><b>unzip_file</b></code>
             </td>
-            <td>Extracts the contents of a ZIP archive to a specified target directory.
-It takes a source ZIP file path and a target extraction directory.
-The tool decompresses all files and directories stored in the ZIP, recreating their structure in the target location. 
-Both the source ZIP file and the target directory should reside within allowed directories.</td>
+            <td>Extracts the contents of a ZIP archive to a specified target directory.<br/>It takes a source ZIP file path and a target extraction directory.<br/>The tool decompresses all files and directories stored in the ZIP, recreating their structure in the target location. <br/>Both the source ZIP file and the target directory should reside within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>target_path</code> : string<br /></li>
@@ -188,9 +158,7 @@ Both the source ZIP file and the target directory should reside within allowed d
             <td>
                 <code><b>write_file</b></code>
             </td>
-            <td>Create a new file or completely overwrite an existing file with new content.
-Use with caution as it will overwrite existing files without warning.
-Handles text content with proper encoding. Only works within allowed directories.</td>
+            <td>Create a new file or completely overwrite an existing file with new content. Use with caution as it will overwrite existing files without warning. Handles text content with proper encoding. Only works within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>content</code> : string<br /></li>
@@ -203,9 +171,7 @@ Handles text content with proper encoding. Only works within allowed directories
             <td>
                 <code><b>zip_directory</b></code>
             </td>
-            <td>Creates a ZIP archive by compressing a directory , including files and subdirectories matching a specified glob pattern.
-It takes a path to the folder and a glob pattern to identify files to compress and a target path for the resulting ZIP file.
-Both the source directory and the target ZIP file should reside within allowed directories.</td>
+            <td>Creates a ZIP archive by compressing a directory , including files and subdirectories matching a specified glob pattern.<br/>It takes a path to the folder and a glob pattern to identify files to compress and a target path for the resulting ZIP file.<br/>Both the source directory and the target ZIP file should reside within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>input_directory</code> : string<br /></li>
@@ -219,9 +185,7 @@ Both the source directory and the target ZIP file should reside within allowed d
             <td>
                 <code><b>zip_files</b></code>
             </td>
-            <td>Creates a ZIP archive by compressing files.
-It takes a list of files to compress and a target path for the resulting ZIP file. 
-Both the source files and the target ZIP file should reside within allowed directories.</td>
+            <td>Creates a ZIP archive by compressing files. It takes a list of files to compress and a target path for the resulting ZIP file. Both the source files and the target ZIP file should reside within allowed directories.</td>
             <td>
                 <ul>
                     <li style="white-space: nowrap;"> <code>input_files</code> : string [ ]<br /></li>

docs/capabilities.md

@@ -7,10 +7,11 @@ use crate::fs_service::FileSystemService;
 
 #[mcp_tool(
     name = "create_directory",
-    description = "Create a new directory or ensure a directory exists. Can create multiple
-nested directories in one operation. If the directory already exists,
-this operation will succeed silently. Perfect for setting up directory
-structures for projects or ensuring required paths exist. Only works within allowed directories."
+    description = concat!("Create a new directory or ensure a directory exists. ",
+    "Can create multiple nested directories in one operation. ",
+    "If the directory already exists, this operation will succeed silently. ",
+    "Perfect for setting up directory structures for projects or ensuring required paths exist. ",
+    "Only works within allowed directories.")
 )]
 #[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug, JsonSchema)]
 pub struct CreateDirectoryTool {

src/tools/create_directory.rs

@@ -8,10 +8,10 @@ use crate::fs_service::FileSystemService;
 
 #[mcp_tool(
     name = "directory_tree",
-    description = "Get a recursive tree view of files and directories as a JSON structure.
-Each entry includes 'name', 'type' (file/directory), and 'children' for directories.
-Files have no children array, while directories always have a children array (which may be empty).
-The output is formatted with 2-space indentation for readability. Only works within allowed directories."
+    description = concat!("Get a recursive tree view of files and directories as a JSON structure. ",
+    "Each entry includes 'name', 'type' (file/directory), and 'children' for directories. ",
+    "Files have no children array, while directories always have a children array (which may be empty). ",
+    "The output is formatted with 2-space indentation for readability. Only works within allowed directories.")
 )]
 #[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug, JsonSchema)]
 pub struct DirectoryTreeTool {

src/tools/directory_tree.rs

@@ -18,9 +18,10 @@ pub struct EditOperation {
 
 #[mcp_tool(
     name = "edit_file",
-    description = "Make line-based edits to a text file. Each edit replaces exact line sequences
-with new content. Returns a git-style diff showing the changes made.
-Only works within allowed directories."
+    description = concat!("Make line-based edits to a text file. ",
+    "Each edit replaces exact line sequences with new content. ",
+    "Returns a git-style diff showing the changes made. ",
+    "Only works within allowed directories.")
 )]
 #[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug, JsonSchema)]
 pub struct EditFileTool {

src/tools/edit_file.rs

@@ -7,10 +7,11 @@ use crate::fs_service::FileSystemService;
 
 #[mcp_tool(
     name = "get_file_info",
-    description = "Retrieve detailed metadata about a file or directory. Returns comprehensive
-information including size, creation time, last modified time, permissions,
-and type. This tool is perfect for understanding file characteristics
-without reading the actual content. Only works within allowed directories."
+    description = concat!("Retrieve detailed metadata about a file or directory. ",
+    "Returns comprehensive information including size, creation time, ",
+    "last modified time, permissions, and type. ",
+    "This tool is perfect for understanding file characteristics without ",
+    "reading the actual content. Only works within allowed directories.")
 )]
 #[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug, JsonSchema)]
 pub struct GetFileInfoTool {

src/tools/get_file_info.rs

@@ -5,9 +5,10 @@ use crate::fs_service::FileSystemService;
 
 #[mcp_tool(
     name = "list_allowed_directories",
-    description = "Returns a list of directories that the server has permission to access.
-    Subdirectories within these allowed directories are also accessible.
-    Use this to identify which directories and their nested paths are available before attempting to access files."
+    description = concat!("Returns a list of directories that the server has permission ",
+    "to access Subdirectories within these allowed directories are also accessible. ",
+    "Use this to identify which directories and their nested paths are available ",
+    "before attempting to access files.")
 )]
 #[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug, JsonSchema)]
 pub struct ListAllowedDirectoriesTool {}

src/tools/list_allowed_directories.rs

@@ -7,10 +7,10 @@ use crate::fs_service::FileSystemService;
 
 #[mcp_tool(
     name = "list_directory",
-    description = "Get a detailed listing of all files and directories in a specified path.
-Results clearly distinguish between files and directories with [FILE] and [DIR]
-prefixes. This tool is essential for understanding directory structure and
-finding specific files within a directory. Only works within allowed directories."
+    description = concat!("Get a detailed listing of all files and directories in a specified path. ",
+"Results clearly distinguish between files and directories with [FILE] and [DIR] ",
+"prefixes. This tool is essential for understanding directory structure and ",
+"finding specific files within a directory. Only works within allowed directories.")
 )]
 #[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug, JsonSchema)]
 pub struct ListDirectoryTool {

src/tools/list_directory.rs

@@ -7,10 +7,11 @@ use crate::fs_service::FileSystemService;
 
 #[mcp_tool(
     name = "move_file",
-    description = "Move or rename files and directories. Can move files between directories
-and rename them in a single operation. If the destination exists, the
-operation will fail. Works across different directories and can be used
-for simple renaming within the same directory. Both source and destination must be within allowed directories."
+    description = concat!("Move or rename files and directories. Can move files between directories ",
+"and rename them in a single operation. If the destination exists, the ",
+"operation will fail. Works across different directories and can be used ",
+"for simple renaming within the same directory. ",
+"Both source and destination must be within allowed directories.")
 )]
 #[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug, JsonSchema)]
 pub struct MoveFileTool {