article
README
🚀 Databricks MCP 服务器
Databricks MCP 服务器是一款强大的工具,用于与 Databricks 平台进行交互。它实现了模型完成协议(MCP),支持通过 REST API 访问 Databricks 的各项功能,既可以直接使用,也能借助 MCP 客户端进行通信。
🚀 快速开始
Databricks MCP 服务器允许你通过 REST API 访问 Databricks 功能。你可以直接使用该工具,也能通过 MCP 客户端进行通信。
✨ 主要特性
功能
- 实现了 MCP 协议。
- 提供了对 Databricks REST API 的访问。
- 支持群集管理、作业提交和其他平台功能。
- 文档生成使用 Sphinx,位于
docs/api目录。
代码标准
- 遵循 PEP 8 标准,最大行长为 100 个字符。
- 使用 4 个空格进行缩进(不使用制表符)。
- 引用字符串时优先使用双引号。
- 所有类、方法和函数必须包含 Google 风格的文档注释。
- 除了测试代码外,所有代码都需要类型提示。
代码审查
使用 Pylint 和 Flake8 进行代码检查,并运行 Mypy 进行静态类型检查。
测试要求
- 所有新增功能必须附带测试用例。
- 最低代码覆盖率为 80%。
- 使用 pytest 并结合覆盖率报告进行测试。
📦 安装指南
系统要求
- Python 3.7 或更高版本。
安装步骤
- 项目克隆
git clone [仓库地址]
cd [项目目录]
- 依赖管理
使用
poetry或其他工具安装依赖项。 - 环境变量设置(可选) 配置 Databricks 凭据:
export DATABRICKS_HOST=[Databricks 服务地址]
export DATABRICKS_TOKEN=[访问令牌]
- 运行服务器
poetry install && poetry run start_server
📚 详细文档
项目结构
.
├── src/
│ ├── main.py # 主程序入口
│ └── cli/ # 命令行工具模块
├── tests/
│ ├── test_clusters.py
│ └── test_jobs.py # 测试用例文件
├── examples/
│ └── example_usage.py
└── docs/
└── api/ # 文档生成目录
更多详细信息,请参见 project_structure.md。
开发指南
贡献流程
- 分支创建
git checkout -b feature/[功能名称]
- 代码提交 提交时请包含清晰的提交信息。
- 拉取请求 提交完成后,生成拉取请求并等待审核。
文档更新
- 在
docs/目录中更新相关文档。 - 使用 Sphinx 生成新文档。
📄 许可证
该项目遵循 MIT 许可证。更多细节请参见 LICENSE 文件。
扫码联系在线客服