Modal MCP Server

🚀 Modal MCP Server

A Modal server implementation for interacting with Modal volumes and deploying Modal applications from within Cursor.

🚀 Quick Start

This Modal MCP Server enables interaction with Modal volumes and deployment of Modal applications from Cursor. Here's how to get started.

📦 Installation

1. Clone this repository:

git clone https://github.com/smehmood/modal-mcp-server.git
cd modal-mcp-server

2. Install dependencies using uv:

uv sync

🛠️ Configuration

To use this MCP server in Cursor, add the following configuration to your ~/.cursor/mcp.json file:

{
  "mcpServers": {
    "modal-mcp-server": {
      "command": "uv",
      "args": [
        "--project", "/path/to/modal-mcp-server",
        "run", "/path/to/modal-mcp-server/src/modal_mcp/server.py"
      ]
    }
  }
}

Replace /path/to/modal-mcp-server with the actual absolute path where you cloned the repository.

📋 Prerequisites

• Python 3.11 or higher
• uv package manager
• Modal CLI configured with valid credentials
• For Modal deployment support:
  • The project to be deployed must use uv for dependency management.
  • Modal must be installed in the project's virtual environment.

🌟 Features

Modal Volume Operations

1. List Modal Volumes (list_modal_volumes)
   • Lists all Modal volumes in the environment.
   • Returns volume information in JSON format.
   • Parameters: None
2. List Volume Contents (list_modal_volume_contents)
   • Lists files and directories in a Modal volume.
   • Parameters:
     • volume_name: Name of the volume.
     • path: Path within the volume (default: "/")
3. Copy Files (copy_modal_volume_files)
   • Copies files within a Modal volume.
   • Parameters:
     • volume_name: Name of the volume.
     • paths: List of paths, with the last path as the destination.
   • Example: ["source.txt", "dest.txt"] or ["file1.txt", "file2.txt", "dest_dir/"]
4. Delete Files (remove_modal_volume_file)
   • Deletes a file or directory from a Modal volume.
   • Parameters:
     • volume_name: Name of the volume.
     • remote_path: Path of the file/directory to delete.
     • recursive: Boolean flag for recursive deletion (default: false)
5. Upload Files (put_modal_volume_file)
   • Uploads a file or directory to a Modal volume.
   • Parameters:
     • volume_name: Name of the volume.
     • local_path: Local path of the file/directory to upload.
     • remote_path: Destination path within the volume (default: current directory)
6. Download Files (get_modal_volume_file)
   • Downloads a file or directory from a Modal volume.
   • Parameters:
     • volume_name: Name of the volume.
     • remote_path: Path within the volume to download.
     • local_path: Local path to save the downloaded file/directory (default: current directory)

📄 Response Format

• Success Response:

{
  "status": "success",
  "result": {}
}

• Error Response:

{
  "status": "error",
  // Error details will be provided here
}