Skip to content

fix(filesystem): describe input schema properties #4165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Lubrsy706 wants to merge 1 commit into
base: main
Choose a base branch
from
+51 −34
Open

fix(filesystem): describe input schema properties #4165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/filesystem/__tests__/structured-content.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,4 +155,21 @@ describe('structuredContent schema compliance', () => {
expect(Array.isArray(structuredContent.content)).toBe(false);
});
});

describe('tool schemas', () => {
it('should describe every top-level input property exposed to clients', async () => {
const { tools } = await client.listTools();

for (const tool of tools) {
const properties = tool.inputSchema.properties ?? {};
for (const [propertyName, propertySchema] of Object.entries(properties)) {
expect(propertySchema, `${tool.name}.${propertyName}`).toEqual(
expect.objectContaining({
description: expect.any(String),
})
);
}
}
});
});
});
68 changes: 34 additions & 34 deletions src/filesystem/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,13 +94,13 @@ setAllowedDirectories(allowedDirectories);

// Schema definitions
const ReadTextFileArgsSchema = z.object({
path: z.string(),
path: z.string().describe('Absolute or relative path to a text file within the allowed directories.'),
tail: z.number().optional().describe('If provided, returns only the last N lines of the file'),
head: z.number().optional().describe('If provided, returns only the first N lines of the file')
});

const ReadMediaFileArgsSchema = z.object({
path: z.string()
path: z.string().describe('Absolute or relative path to an image or audio file within the allowed directories.')
});

const ReadMultipleFilesArgsSchema = z.object({
Expand All @@ -111,8 +111,8 @@ const ReadMultipleFilesArgsSchema = z.object({
});

const WriteFileArgsSchema = z.object({
path: z.string(),
content: z.string(),
path: z.string().describe('Absolute or relative path where the file should be written within the allowed directories.'),
content: z.string().describe('Complete text content to write to the file. Existing files are overwritten.'),
});

const EditOperation = z.object({
Expand All @@ -121,42 +121,42 @@ const EditOperation = z.object({
});

const EditFileArgsSchema = z.object({
path: z.string(),
edits: z.array(EditOperation),
path: z.string().describe('Absolute or relative path to the text file to edit within the allowed directories.'),
edits: z.array(EditOperation).describe('Ordered list of exact text replacements to apply.'),
dryRun: z.boolean().default(false).describe('Preview changes using git-style diff format')
});

const CreateDirectoryArgsSchema = z.object({
path: z.string(),
path: z.string().describe('Absolute or relative path of the directory to create within the allowed directories.'),
});

const ListDirectoryArgsSchema = z.object({
path: z.string(),
path: z.string().describe('Absolute or relative path of the directory to list within the allowed directories.'),
});

const ListDirectoryWithSizesArgsSchema = z.object({
path: z.string(),
path: z.string().describe('Absolute or relative path of the directory to list within the allowed directories.'),
sortBy: z.enum(['name', 'size']).optional().default('name').describe('Sort entries by name or size'),
});

const DirectoryTreeArgsSchema = z.object({
path: z.string(),
excludePatterns: z.array(z.string()).optional().default([])
path: z.string().describe('Absolute or relative root directory path for the recursive tree within the allowed directories.'),
excludePatterns: z.array(z.string()).optional().default([]).describe('Optional glob patterns to exclude from the tree, matched against relative paths.')
});

const MoveFileArgsSchema = z.object({
source: z.string(),
destination: z.string(),
source: z.string().describe('Absolute or relative source path of the file or directory to move within the allowed directories.'),
destination: z.string().describe('Absolute or relative destination path within the allowed directories. The destination must not already exist.'),
});

const SearchFilesArgsSchema = z.object({
path: z.string(),
pattern: z.string(),
excludePatterns: z.array(z.string()).optional().default([])
path: z.string().describe('Absolute or relative directory path to recursively search within the allowed directories.'),
pattern: z.string().describe('Glob pattern to match file and directory names, such as "*.ts" or "**/*.md".'),
excludePatterns: z.array(z.string()).optional().default([]).describe('Optional glob patterns to exclude from search results, matched against relative paths.')
});

const GetFileInfoArgsSchema = z.object({
path: z.string(),
path: z.string().describe('Absolute or relative path to the file or directory whose metadata should be read.'),
});

// Server setup
Expand Down Expand Up @@ -235,7 +235,7 @@ server.registerTool(
"the last N lines of a file. Operates on the file as text regardless of extension. " +
"Only works within allowed directories.",
inputSchema: {
path: z.string(),
path: z.string().describe("Absolute or relative path to a text file within the allowed directories."),
tail: z.number().optional().describe("If provided, returns only the last N lines of the file"),
head: z.number().optional().describe("If provided, returns only the first N lines of the file")
},
Expand All @@ -253,7 +253,7 @@ server.registerTool(
"Read an image or audio file. Returns the base64 encoded data and MIME type. " +
"Only works within allowed directories.",
inputSchema: {
path: z.string()
path: z.string().describe("Absolute or relative path to an image or audio file within the allowed directories.")
},
outputSchema: {
content: z.array(z.object({
Expand Down Expand Up @@ -345,8 +345,8 @@ server.registerTool(
"Use with caution as it will overwrite existing files without warning. " +
"Handles text content with proper encoding. Only works within allowed directories.",
inputSchema: {
path: z.string(),
content: z.string()
path: z.string().describe("Absolute or relative path where the file should be written within the allowed directories."),
content: z.string().describe("Complete text content to write to the file. Existing files are overwritten.")
},
outputSchema: { content: z.string() },
annotations: { readOnlyHint: false, idempotentHint: true, destructiveHint: true }
Expand All @@ -371,11 +371,11 @@ server.registerTool(
"with new content. Returns a git-style diff showing the changes made. " +
"Only works within allowed directories.",
inputSchema: {
path: z.string(),
path: z.string().describe("Absolute or relative path to the text file to edit within the allowed directories."),
edits: z.array(z.object({
oldText: z.string().describe("Text to search for - must match exactly"),
newText: z.string().describe("Text to replace with")
})),
})).describe("Ordered list of exact text replacements to apply."),
dryRun: z.boolean().default(false).describe("Preview changes using git-style diff format")
},
outputSchema: { content: z.string() },
Expand All @@ -401,7 +401,7 @@ server.registerTool(
"this operation will succeed silently. Perfect for setting up directory " +
"structures for projects or ensuring required paths exist. Only works within allowed directories.",
inputSchema: {
path: z.string()
path: z.string().describe("Absolute or relative path of the directory to create within the allowed directories.")
},
outputSchema: { content: z.string() },
annotations: { readOnlyHint: false, idempotentHint: true, destructiveHint: false }
Expand All @@ -427,7 +427,7 @@ server.registerTool(
"prefixes. This tool is essential for understanding directory structure and " +
"finding specific files within a directory. Only works within allowed directories.",
inputSchema: {
path: z.string()
path: z.string().describe("Absolute or relative path of the directory to list within the allowed directories.")
},
outputSchema: { content: z.string() },
annotations: { readOnlyHint: true }
Expand Down Expand Up @@ -455,7 +455,7 @@ server.registerTool(
"prefixes. This tool is useful for understanding directory structure and " +
"finding specific files within a directory. Only works within allowed directories.",
inputSchema: {
path: z.string(),
path: z.string().describe("Absolute or relative path of the directory to list within the allowed directories."),
sortBy: z.enum(["name", "size"]).optional().default("name").describe("Sort entries by name or size")
},
outputSchema: { content: z.string() },
Expand Down Expand Up @@ -534,8 +534,8 @@ server.registerTool(
"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.",
inputSchema: {
path: z.string(),
excludePatterns: z.array(z.string()).optional().default([])
path: z.string().describe("Absolute or relative root directory path for the recursive tree within the allowed directories."),
excludePatterns: z.array(z.string()).optional().default([]).describe("Optional glob patterns to exclude from the tree, matched against relative paths.")
},
outputSchema: { content: z.string() },
annotations: { readOnlyHint: true }
Expand Down Expand Up @@ -604,8 +604,8 @@ server.registerTool(
"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.",
inputSchema: {
source: z.string(),
destination: z.string()
source: z.string().describe("Absolute or relative source path of the file or directory to move within the allowed directories."),
destination: z.string().describe("Absolute or relative destination path within the allowed directories. The destination must not already exist.")
},
outputSchema: { content: z.string() },
annotations: { readOnlyHint: false, idempotentHint: false, destructiveHint: true }
Expand Down Expand Up @@ -634,9 +634,9 @@ server.registerTool(
"Returns full paths to all matching items. Great for finding files when you don't know their exact location. " +
"Only searches within allowed directories.",
inputSchema: {
path: z.string(),
pattern: z.string(),
excludePatterns: z.array(z.string()).optional().default([])
path: z.string().describe("Absolute or relative directory path to recursively search within the allowed directories."),
pattern: z.string().describe("Glob pattern to match file and directory names, such as \"*.ts\" or \"**/*.md\"."),
excludePatterns: z.array(z.string()).optional().default([]).describe("Optional glob patterns to exclude from search results, matched against relative paths.")
},
outputSchema: { content: z.string() },
annotations: { readOnlyHint: true }
Expand All @@ -662,7 +662,7 @@ server.registerTool(
"and type. This tool is perfect for understanding file characteristics " +
"without reading the actual content. Only works within allowed directories.",
inputSchema: {
path: z.string()
path: z.string().describe("Absolute or relative path to the file or directory whose metadata should be read.")
},
outputSchema: { content: z.string() },
annotations: { readOnlyHint: true }
Expand Down
Loading