Keboola MCP Server

🚀 Keboola MCP 服務器手冊

Keboola 的 MCP（管理控制檯）服務器是一款用於與 Keboola 進行連接互動的實用工具。它提供了豐富的功能，能幫助用戶高效地管理項目中的存儲、執行 SQL 查詢、操作組件、管理作業以及查詢文檔等。

✨ 主要特性

存儲工具

• 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 - 查詢文檔和幫助信息

📦 安裝指南

安裝 MCP 服務器

1. 克隆 Keboola MCP 服務器代碼庫到本地。
2. 激活虛擬環境並安裝依賴項：

   python -m pip install -r requirements.txt
   

配置 MCP 服務器

• 設置以下環境變量：
  • KBC_API_URL：Keboola API 的 URL（例如，https://connection.YOUR_REGION.keboola.com）
  • KBC_STORAGE_TOKEN：你的存儲令牌
  • KBC_WORKSPACE_SCHEMA：你的工作區模式（Snowflake 或 BigQuery）

💻 使用示例

啟動 MCP 服務器

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

支持的傳輸類型包括：

• http：通過 HTTP 端點訪問
• stdio：通過標準輸入輸出交互
• sse：通過服務器發送事件（Server-Sent Events）

使用 MCP 工具

基礎用法

以下是一些常用工具的操作示例：

存儲工具示例

# 檢索所有存儲桶
python -m keboola_mcp_server.cli retrieve-buckets --transport stdio

# 獲取特定存儲桶的詳細信息
python -m keboola_mcp_server.cli get-bucket-detail <bucket-id> --transport stdio

SQL 工具示例

# 執行 SQL 查詢
python -m keboola_mcp_server.cli query-table <table-id> "<your-sql-query>" --transport stdio

# 獲取 SQL 方言
python -m keboola_mcp_server.cli get-sql-dialect --transport stdio

組件工具示例

# 檢索所有組件
python -m keboola_mcp_server.cli retrieve-components --transport stdio

# 創建新的 SQL 轉換配置
python -m keboola_mcp_server.cli create-sql-transformation <component-id> "<transformation-query>" --transport stdio

⚠️ 重要提示

• 在生產環境中使用 MCP 服務器前，請確保所有環境變量正確設置。
• 定期更新依賴項以獲取最新功能和安全補丁。

🔧 開發與測試

運行測試

python -m pytest tests/

提交代碼

遵循標準的 Git 流程進行提交：

1. 創建新功能或修復問題。
2. 提交更改到本地倉庫。
3. 推送到遠程倉庫並創建 Pull Request。

❓ 故障排除

如果遇到問題，請參考Keboola 文檔或聯繫支持團隊。

通過以上步驟，你可以順利安裝、配置和使用 Keboola MCP 服務器，並根據需要進行開發和擴展。