|
48 | 48 | "Search", |
49 | 49 | "Image" |
50 | 50 | ], |
51 | | - "description": "The operation mode" |
| 51 | + "description": "The operation mode to run in: `Line`, `Directory`, `Search`. `Line` and `Search` are only for text files, and `Directory` is only for directories. `Image` is for image files, in this mode `image_paths` is required." |
52 | 52 | }, |
53 | 53 | "path": { |
54 | 54 | "type": "string", |
55 | | - "description": "Path to file or directory (required for Line, Directory, Search modes)" |
| 55 | + "description": "Path to the file or directory. The path should be absolute, or otherwise start with ~ for the user's home (required for Line, Directory, Search modes)." |
56 | 56 | }, |
57 | 57 | "image_paths": { |
58 | 58 | "type": "array", |
59 | 59 | "items": { |
60 | 60 | "type": "string" |
61 | 61 | }, |
62 | | - "description": "Paths to images (required for Image mode)" |
| 62 | + "description": "List of paths to the images. This is currently supported by the Image mode." |
63 | 63 | }, |
64 | 64 | "start_line": { |
65 | 65 | "type": "integer", |
66 | | - "description": "Starting line number (optional for Line mode)", |
| 66 | + "description": "Starting line number (optional, for Line mode). A negative index represents a line number starting from the end of the file.", |
67 | 67 | "default": 1 |
68 | 68 | }, |
69 | 69 | "end_line": { |
70 | 70 | "type": "integer", |
71 | | - "description": "Ending line number (optional for Line mode)", |
| 71 | + "description": "Ending line number (optional, for Line mode). A negative index represents a line number starting from the end of the file.", |
72 | 72 | "default": -1 |
73 | 73 | }, |
74 | 74 | "pattern": { |
75 | 75 | "type": "string", |
76 | | - "description": "Search pattern (required for Search mode)" |
| 76 | + "description": "Pattern to search for (required, for Search mode). Case insensitive. The pattern matching is performed per line." |
77 | 77 | }, |
78 | 78 | "context_lines": { |
79 | 79 | "type": "integer", |
80 | | - "description": "Context lines around matches (optional for Search mode)", |
| 80 | + "description": "Number of context lines around search results (optional, for Search mode)", |
81 | 81 | "default": 2 |
82 | 82 | }, |
83 | 83 | "depth": { |
84 | 84 | "type": "integer", |
85 | | - "description": "Directory traversal depth (optional for Directory mode)", |
| 85 | + "description": "Depth of a recursive directory listing (optional, for Directory mode)", |
86 | 86 | "default": 0 |
87 | 87 | } |
88 | 88 | }, |
|
0 commit comments