MCP Bauplan

🚀 mcp-bauplan

mcp-bauplan是一個簡約的模型上下文協議（MCP）服務器，用於與數據表交互並運行Bauplan查詢。它能夠管理配置namespace中Iceberg表格在S3的數據存儲，為用戶提供便捷的數據操作體驗。

🚀 快速開始

配置

1. 創建或編輯Claude桌面配置文件，不同系統的文件位置如下：
   • macOS：~/Library/Application Support/Claude/claude_desktop_config.json
   • Windows：%APPDATA%/Claude/claude_desktop_config.json
2. 添加以下內容到配置文件中：

{
  "mcpServers": {
    "mcp-bauplan": {
      "command": "/path/to/uvx",
      "args": ["mcp-bauplan"],
      "env": {
        "BAUPLAN_API_KEY": "your-api-key",
        "BAUPLAN_BRANCH": "your-branch",
        "BAUPLAN_NAMESPACE": "your-namespace",
        // 可選
        "BAUPLAN_TIMEOUT": "query-timeout-secs" // 默認30秒
      }
    }
  }
}

3. 將/path/to/uvx替換為uvx可執行文件的絕對路徑。你可以使用終端中的which uvx命令來找到該路徑，以確保在啟動服務器時使用正確的uvx版本。
4. 重新啟動Claude桌面以應用更改。

運行獨立的SSE服務器

從.env.example創建一個.env文件，然後執行以下命令：

$ uvx --env-file /path/to/.env mcp-bauplan --transport sse --port 9090

⚠️ 重要提示

使用nvx而不是uvx將從默認倉庫https://pypi.org獲取mcp-bauplan。

✨ 主要特性

• 獲取配置namespace中的所有Bauplan數據表及其架構。
• 使用SQL（僅選擇）在指定的表上執行查詢。
• 支持SSE和STDIO兩種傳輸方式。

📦 安裝指南

開發環境設置

1. 先決條件：
   • Python 3.10或更高版本。
   • Bauplan API密鑰（在此處請求）。
   • uv包管理器（安裝）。
2. 克隆倉庫：

git clone https://github.com/marcoeg/mcp-bauplan
cd mcp-nvd

3. 設置環境變量： 在項目根目錄中創建一個.env文件，並添加以下內容：

BAUPLAN_API_KEY=your-api-key
BAUPLAN_BRANCH=your-branch
BAUPLAN_NAMESPACE=your-namespace

4. 安裝依賴項：

uv sync
uv pip install -e .

💻 使用示例

工具使用

該服務器實現了以下工具以與Bauplan數據表交互：

• list_tables：列出配置namespace中的所有表格。
• get_schema：獲取指定數據表的架構。
• run_query：在指定表上執行SELECT查詢。

使用MCP Inspector運行

cd /path/to/the/repo
source .env

CLIENT_PORT=8077 SERVER_PORT=8078 npx @modelcontextprotocol/inspector \
     uv run mcp-bauplan

⚠️ 重要提示

如果標準端口不衝突，請省略CLIENT_PORT=8077 SERVER_PORT=8078。

然後在瀏覽器中打開指示的URL，通常為http://localhost:8077?proxyPort=8078。

💡 使用建議

在inspector中可以在stdio和sse傳輸類型之間自由切換。要使用sse，請按照下面的說明運行服務器。

使用SSE傳輸進行測試

運行服務器

cd /path/to/the/repo
source .env

uv run mcp-bauplan --transport sse --port 9090

• 默認在端口9090上使用SSE傳輸運行。

然後在瀏覽器中打開指示的URL，選擇SSE傳輸類型。