mcp-bauplan

一个 minimalist的模型上下文协议(MCP)服务器，用于与数据表和运行Bauplan查询交互。

Bauplan管理配置 namespace中的Iceberg表格在S3中的数据存储。

功能

• 获取配置 namespace中的所有Bauplan数据表及其架构
• 使用SQL（仅选择）在指定的表上执行查询

支持SSE和STDIO两种传输方式。

工具

该服务器实现以下工具以与Bauplan数据表交互：

• list_tables:
  • 列出配置 namespace中的所有表格
• get_schema:
  • 获取指定数据表的架构
• run_query:
  • 在指定表上执行SELECT查询

配置

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。

开发

设置

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 .

使用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传输类型。