Modal MCP Server

Modal MCP 服务

用于在 Cursor 中与 Modal 卷交互并部署 Modal 应用的 MCP 服务实现。

安装

1. 克隆此仓库：

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

2. 使用 uv 安装依赖：

uv sync

配置

要在 Cursor 中使用此 MCP 服务，请将以下配置添加到 ~/.cursor/mcp.json：

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

将 /path/to/modal-mcp-server 替换为克隆仓库的绝对路径。

要求

• Python 3.11 或更高版本
• uv 包管理器
• 已配置有效凭据的 Modal CLI
• 要支持 Modal 部署：
  • 要部署的项目必须使用 uv 管理依赖
  • 必须在项目的虚拟环境中安装 Modal

支持的工具

Modal 卷操作

1. 列出 Modal 卷（list_modal_volumes）

   • 列出环境中的所有 Modal 卷
   • 返回 JSON 格式的卷信息
   • 参数：无

2. 列出卷内容（list_modal_volume_contents）

   • 列出 Modal 卷中的文件和目录
   • 参数：
     • volume_name：Modal 卷的名称
     • path：卷内路径（默认值：/）

3. 复制文件（copy_modal_volume_files）

   • 在 Modal 卷内复制文件
   • 参数：
     • volume_name：Modal 卷的名称
     • paths：路径列表，最后一个路径为目标位置
   • 示例：["source.txt", "dest.txt"] 或 ["file1.txt", "file2.txt", "dest_dir/"]

4. 删除文件（remove_modal_volume_file）

   • 从 Modal 卷中删除文件或目录
   • 参数：
     • volume_name：Modal 卷的名称
     • remote_path：要删除的文件或目录路径
     • recursive：递归删除的布尔标志（默认值：false）

5. 上传文件（put_modal_volume_file）

   • 将文件或目录上传到 Modal 卷
   • 参数：
     • volume_name：Modal 卷的名称
     • local_path：要上传的本地文件或目录路径
     • remote_path：卷内的上传目标路径（默认值：/）
     • force：覆盖现有文件的布尔标志（默认值：false）

6. 下载文件（get_modal_volume_file）

   • 从 Modal 卷下载文件
   • 参数：
     • volume_name：Modal 卷的名称
     • remote_path：要下载的卷内文件或目录路径
     • local_destination：保存下载文件的本地路径（默认值：当前目录）
     • force：覆盖现有文件的布尔标志（默认值：false）
   • 注意：将 - 用作 local_destination，可将文件内容写入 stdout

Modal 部署

1. 部署 Modal 应用（deploy_modal_app）
   • 部署 Modal 应用
   • 参数：
     • absolute_path_to_app：Modal 应用文件的绝对路径
   • 注意：包含 Modal 应用的项目必须：
     • 使用 uv 管理依赖
     • 在其虚拟环境中安装 modal CLI

响应格式

所有工具都以标准化格式返回响应，具体形式会根据操作类型略有不同：

# JSON operations (list volumes, list contents):
{
    "success": True,
    "data": {...}  # JSON data from Modal CLI
}

# File operations (put, get, copy, remove):
{
    "success": True,
    "message": "Operation successful message",
    "command": "executed command string",
    "stdout": "command output",  # if any
    "stderr": "error output"     # if any
}

# Error case (all operations):
{
    "success": False,
    "error": "Error message describing what went wrong",
    "command": "executed command string",  # for file operations
    "stdout": "command output",  # if available
    "stderr": "error output"     # if available
}

贡献

欢迎贡献！请随时提交 Pull Request。

许可证

本项目基于 MIT License 授权，详情请参阅 LICENSE 文件。