article
README
🚀 钟表蒸汽机服务器
本项目的钟表蒸汽机服务器为用户提供了便捷的服务管理功能,支持多种方式安装与配置,能满足不同场景下的使用需求,助力高效开发与部署。
🚀 快速开始
你可以按照以下步骤完成服务器的安装与启动。
📦 安装指南
使用 Make
make dev
# 或者手动运行
mcp dev src/steampipe_mcp_server/cli.py
使用 CLI
# 使用 Make
make server
# 或者指定数据库 URL
steampipe-mcp-server --database-url postgresql://steampipe:password@localhost:9193/steampipe
# 或者使用环境变量
export STEAMPIPE_MCP_DATABASE_URL=postgresql://steampipe:password@localhost:9193/steampipe
steampipe-mcp-server
📚 详细文档
配置
环境变量
STEAMPIPE_MCP_DATABASE_URL:指定数据库连接 URL。STEAMPIPE_MCP_LOG_LEVEL:设置日志级别(可选值:debug, info, warning, error, critical)。
工具
query
steampipe-mcp-server query --help
list-all-tables
steampipe-mcp-server list-all-tables
贡献
- 叉取仓库
- 创建新分支
- 提交更改
- 提交拉取请求
发布
- 更新
pyproject.toml中的版本号。 - 运行所有检查:
make check test - 在 GitHub 上打标签:
git tag v0.1.0 # 使用适当的版本号 git push origin v0.1.0
问题排查
数据库连接问题
检查数据库 URL 是否正确,确保数据库正在运行并且有权限。
日志信息不足
查看日志文件或设置更详细的日志级别:
export STEAMPIPE_MCP_LOG_LEVEL=debug
steampipe-mcp-server
插件加载失败
检查插件路径是否正确,确保插件文件存在且格式正确。
💻 使用示例
配置示例
[database]
url = "postgresql://steampipe:password@localhost:9193/steampipe"
基础用法
# 获取 query 命令的帮助信息
steampipe-mcp-server query --help
📄 附录
常见问题
-
Q: 如何安装依赖?
-
A: 使用
pip install -r requirements.txt。 -
Q: 如何运行测试?
-
A: 运行
pytest tests/. -
Q: 如何生成文档?
-
A: 使用
make docs.
Scan to contact