list_files
Read-only
List files in a directory with optional pattern filtering to find specific files quickly.
Instructions
List files in a directory
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| directory | Yes | Path to the directory to list files from | |
| pattern | No | Pattern to filter files by (e.g., *.txt) |
Implementation Reference
- Core handler function that lists files in a directory, filtering by optional pattern using fs.readdir.
public async listFiles(dirPath: string, pattern?: string): Promise<string[]> { try { const entries = await readdir(dirPath, { withFileTypes: true }); let files = entries .filter(entry => entry.isFile()) .map(entry => path.join(dirPath, entry.name)); if (pattern) { const regex = new RegExp(pattern); files = files.filter(file => regex.test(file)); } return files; } catch (error: any) { throw new Error(`Failed to list files in ${dirPath}: ${error.message}`); } } - src/index.ts:191-212 (registration)Registers the 'list_files' tool with the MCP server, providing description, input schema, and annotations.
mcpServer.registerTool({ name: 'list_files', description: 'List files in a directory', inputSchema: { type: 'object', properties: { directory: { type: 'string', description: 'Path to the directory to list files from' }, pattern: { type: 'string', description: 'Pattern to filter files by (e.g., *.txt)' } }, required: ['directory'] }, annotations: { readOnlyHint: true, openWorldHint: false } }); - src/index.ts:194-206 (schema)Input schema definition for the list_files tool, specifying directory (required) and optional pattern.
inputSchema: { type: 'object', properties: { directory: { type: 'string', description: 'Path to the directory to list files from' }, pattern: { type: 'string', description: 'Pattern to filter files by (e.g., *.txt)' } }, required: ['directory'] - Router dispatch for 'list_files' tool calls, delegating to FileSystemManager.listFiles.
case 'list_files': return this.fileSystemManager.listFiles(operation.params.directory, operation.params.pattern);