Databricks MCP 服务器

一个用于 Databricks 的模型补全协议 (MCP) 服务器，它通过 MCP 协议提供对 Databricks 功能的访问。这允许 LLM 驱动的工具与 Databricks 集群、作业、笔记本等进行交互。

特性

• MCP 协议支持: 实现 MCP 协议，允许 LLM 与 Databricks 交互
• Databricks API 集成: 提供对 Databricks REST API 功能的访问
• 工具注册: 将 Databricks 功能公开为 MCP 工具
• 异步支持: 使用 asyncio 构建，以实现高效运行

可用工具

Databricks MCP 服务器公开了以下工具：

• list_clusters: 列出所有 Databricks 集群
• create_cluster: 创建一个新的 Databricks 集群
• terminate_cluster: 终止一个 Databricks 集群
• get_cluster: 获取关于特定 Databricks 集群的信息
• start_cluster: 启动一个已终止的 Databricks 集群
• list_jobs: 列出所有 Databricks 作业
• run_job: 运行一个 Databricks 作业
• list_notebooks: 列出工作区目录中的笔记本
• export_notebook: 从工作区导出笔记本
• list_files: 列出 DBFS 路径中的文件和目录
• execute_sql: 执行 SQL 语句

安装

前提条件

• Python 3.10 或更高版本
• uv 包管理器 (推荐用于 MCP 服务器)

设置

1. 如果您还没有安装 uv，请安装它：

   # MacOS/Linux
   curl -LsSf https://astral.sh/uv/install.sh | sh
   
   # Windows (在 PowerShell 中)
   irm https://astral.sh/uv/install.ps1 | iex
   

   安装后重启您的终端。

2. 克隆仓库：

   git clone https://github.com/JustTryAI/databricks-mcp-server.git
   cd databricks-mcp-server
   

3. 使用 uv 设置项目：

   # 创建并激活虚拟环境
   uv venv
   
   # 在 Windows 上
   .\.venv\Scripts\activate
   
   # 在 Linux/Mac 上
   source .venv/bin/activate
   
   # 以开发模式安装依赖
   uv pip install -e .
   
   # 安装开发依赖
   uv pip install -e ".[dev]"
   

4. 设置环境变量：

   # Windows
   set DATABRICKS_HOST=https://your-databricks-instance.azuredatabricks.net
   set DATABRICKS_TOKEN=your-personal-access-token
   
   # Linux/Mac
   export DATABRICKS_HOST=https://your-databricks-instance.azuredatabricks.net
   export DATABRICKS_TOKEN=your-personal-access-token
   

   您也可以基于 .env.example 模板创建一个 .env 文件。

运行 MCP 服务器

要启动 MCP 服务器，请运行：

# Windows
.\start_mcp_server.ps1

# Linux/Mac
./start_mcp_server.sh

这些包装脚本将执行位于 scripts 目录中的实际服务器脚本。服务器将启动并准备好接受 MCP 协议连接。

您也可以直接从 scripts 目录运行服务器脚本：

# Windows
.\scripts\start_mcp_server.ps1

# Linux/Mac
./scripts/start_mcp_server.sh

查询 Databricks 资源

该仓库包含实用程序脚本，可以快速查看 Databricks 资源：

# 查看所有集群
uv run scripts/show_clusters.py

# 查看所有笔记本
uv run scripts/show_notebooks.py

项目结构

databricks-mcp-server/
├── src/                             # 源代码
│   ├── __init__.py                  # 使 src 成为一个包
│   ├── __main__.py                  # 包的主要入口点
│   ├── main.py                      # MCP 服务器的入口点
│   ├── api/                         # Databricks API 客户端
│   ├── core/                        # 核心功能
│   ├── server/                      # 服务器实现
│   │   ├── databricks_mcp_server.py # 主要 MCP 服务器
│   │   └── app.py                   # 用于测试的 FastAPI 应用
│   └── cli/                         # 命令行界面
├── tests/                           # 测试目录
├── scripts/                         # 辅助脚本
│   ├── start_mcp_server.ps1         # 服务器启动脚本 (Windows)
│   ├── run_tests.ps1                # 测试运行器脚本
│   ├── show_clusters.py             # 显示集群的脚本
│   └── show_notebooks.py            # 显示笔记本的脚本
├── examples/                        # 使用示例
├── docs/                            # 文档
└── pyproject.toml                   # 项目配置

有关项目结构的更详细视图，请参见 project_structure.md。

开发

代码标准

• Python 代码遵循 PEP 8 风格指南，最大行长度为 100 个字符
• 使用 4 个空格进行缩进（无制表符）
• 使用双引号表示字符串
• 所有类、方法和函数都应具有 Google 风格的文档字符串
• 所有代码（测试除外）都需要类型提示

Linting

该项目使用以下 linting 工具：

# 运行所有 linters
uv run pylint src/ tests/
uv run flake8 src/ tests/
uv run mypy src/

测试

该项目使用 pytest 进行测试。要运行测试：

# 使用我们方便的脚本运行所有测试
.\scripts\run_tests.ps1

# 运行并生成覆盖率报告
.\scripts\run_tests.ps1 -Coverage

# 运行特定测试并显示详细输出
.\scripts\run_tests.ps1 -Verbose -Coverage tests/test_clusters.py

您也可以直接使用 pytest 运行测试：

# 运行所有测试
uv run pytest tests/

# 运行并生成覆盖率报告
uv run pytest --cov=src tests/ --cov-report=term-missing

该项目的目标是至少达到 80% 的代码覆盖率。

文档

• API 文档使用 Sphinx 生成，可以在 docs/api 目录中找到
• 所有代码都包含 Google 风格的文档字符串
• 有关使用示例，请参见 examples/ 目录

示例

查看 examples/ 目录以获取使用示例。要运行示例：

# 使用 uv 运行示例脚本
uv run examples/direct_usage.py
uv run examples/mcp_client_usage.py

贡献

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

1. 确保您的代码遵循项目的编码标准
2. 为任何新功能添加测试
3. 根据需要更新文档
4. 在提交之前验证所有测试是否通过

许可证

该项目根据 MIT 许可证获得许可 - 有关详细信息，请参见 LICENSE 文件。