article
README
🚀 Malloy MCP 服务器
Malloy MCP 服务器是一个用于执行 Malloy 查询和管理 Malloy 资源的 MCP 服务器实现,能有效助力用户执行查询和管理资源。
✨ 主要特性
- 通过 MCP 执行 Malloy 查询。
- 可访问 Malloy 项目、包和模型元数据。
- 具备强大的错误处理能力,能提供详细上下文。
- 拥有全面的测试覆盖。
- 实现了类型安全。
📦 安装指南
# 使用 uv 安装(推荐)
uv pip install malloy-mcp-server
# 或使用 pip
pip install malloy-mcp-server
💻 使用示例
基础用法
启动服务器
from malloy_mcp_server import mcp
# 运行服务器
if __name__ == "__main__":
mcp.serve()
配置
服务器可以通过环境变量进行配置:
| 变量 | 描述 | 默认值 |
|------|------|--------|
| MALLOY_PUBLISHER_ROOT_URL | Malloy 发布者 API 的 URL | http://localhost:4000 |
示例:
# 设置发布者 URL
export MALLOY_PUBLISHER_ROOT_URL="http://malloy-publisher:4000"
# 使用自定义配置运行
python -m malloy_mcp_server
执行查询
服务器提供了一个 MCP 工具用于执行 Malloy 查询:
from malloy_mcp_server import ExecuteMalloyQueryTool
# 示例查询执行
result = await ExecuteMalloyQueryTool(
query="select * from users",
model_path="my_package/users"
)
访问资源
服务器提供了以下资源端点:
malloy://project/home/metadata- 项目元数据malloy://project/home/package/{package_name}- 包元数据malloy://project/home/model/{model_path}- 模型元数据
🔧 技术细节
开发设置
- 克隆仓库:
git clone https://github.com/namabile/malloy-mcp-server.git
cd malloy-mcp-server
- 安装依赖项:
uv pip install -e ".[dev]"
运行测试
# 运行所有测试
pytest
# 带覆盖率运行
pytest --cov=malloy_mcp_server
代码质量
项目使用:
black进行代码格式化mypy进行类型检查ruff进行代码检查
运行质量检查:
black .
mypy .
ruff check .
错误处理
服务器提供详细的错误处理和上下文:
from malloy_mcp_server.errors import QueryExecutionError
try:
result = await ExecuteMalloyQueryTool(...)
except QueryExecutionError as e:
print(f"错误: {e.message}")
print("上下文:", e.context)
架构
服务器基于以下构建:
- FastMCP 用于 MCP 服务器实现
- Malloy 发布者客户端 用于 Malloy 交互
- Pydantic 用于数据验证
关键组件:
server.py- 核心服务器实现tools/query_executor.py- 查询执行工具errors.py- 错误处理实用程序
🤝 贡献
- 叉克隆仓库
- 创建功能分支
- 进行修改
- 为新功能添加测试
- 提交拉取请求
📄 许可证
本项目采用 MIT 许可证,详见 LICENSE 文件。
微信扫一扫