Connection & server

list_files

List all files and directories recursively in the Jupyter server's file system.

List all files and directories recursively in the Jupyter server's file system. Used to explore the file system structure of the Jupyter server or to find specific files or directories.

read-only: yes

Parameters

ParameterTypeRequiredDefaultDescription
pathstringno""The starting path to list from (empty string means root directory)
max_depthintegerno1Maximum depth to recurse into subdirectories
start_indexintegerno0Starting index for pagination (0-based)
limitintegerno25Maximum number of items to return (0 means no limit)
patternstringno""Glob pattern to filter file paths

Output

{
  "properties": {
    "result": {
      "description": "Tab-separated table with columns: Path, Type, Size, Last_Modified. Includes pagination info header.",
      "title": "Result",
      "type": "string"
    }
  },
  "required": [
    "result"
  ],
  "title": "list_filesOutput",
  "type": "object"
}

Call it

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_files",
    "arguments": {
      "path": "",
      "max_depth": 1,
      "start_index": 0,
      "limit": 25,
      "pattern": ""
    }
  }
}
result = await session.call_tool("list_files", arguments={"path": "", "max_depth": 1, "start_index": 0, "limit": 25, "pattern": ""})

Source

Registered by the @mcp.tool decorator on list_files in jupyter_mcp_server/server.py.