Keboola Explorer

🚀 项目文档

本项目的 keboola-mcp-server 提供了丰富的工具和功能，可用于与 Keboola 平台进行交互，如管理存储桶、执行 SQL 查询、管理组件配置和作业等，方便开发者在项目中集成和使用。

🚀 快速开始

你可以按照以下步骤快速使用本项目。

📦 安装指南

使用以下命令安装 keboola-mcp-server：

pip install keboola-mcp-server

💻 使用示例

基础用法

运行 MCP 服务器，可选择不同的传输方式：

python -m keboola_mcp_server.cli --transport sse --api-url https://connection.YOUR_REGION.keboola.com

或者使用 STDIO 传输方式：

python -m keboola_mcp_server.cli --transport stdio --api-url https://connection.YOUR_REGION.keboola.com

高级用法

设置以下环境变量以配置 MCP 服务器：

• KBC_PROJECT_ID：你的 Keboola 项目 ID
• KBC_STORAGE_TOKEN：你的 Keboola 存储令牌
• KBC_WORKSPACE_SCHEMA（可选）：你的工作区模式（snowflake 或 bigquery）

📚 详细文档

可用工具

存储工具

• retrieve_buckets：列出项目中的所有存储桶
• get_bucket_detail：获取特定存储桶的详细信息
• retrieve_bucket_tables：列出特定存储桶中的所有表
• get_table_detail：获取特定表的详细信息
• update_bucket_description：更新存储桶的描述
• update_table_description：更新表的描述

SQL 工具

• query_table：在工作区上执行 SQL 查询
• get_sql_dialect：获取工作区使用的 SQL 方言（Snowflake 或 BigQuery）

组件工具

• retrieve_components：列出所有可用组件及其配置
• retrieve_transformations：列出转换配置
• get_component_details：获取特定组件的详细信息
• create_sql_transformation：创建新的 SQL 转换配置

作业工具

• retrieve_jobs：列出项目中的所有作业
• get_job_detail：获取特定作业的详细信息
• start_job：为组件配置启动新作业

文档工具

• docs_query：查询文档和帮助信息

开发

运行测试

pytest

格式化代码

black .
isort .

类型检查

mypy .

📄 许可证

本项目采用 MIT 许可证，详见 LICENSE 文件。