mcp-bauplan

一个极简的模型上下文协议 MCP 服务器，用于与数据表和正在运行的 Bauplan 查询进行交互。

Bauplan 管理着 S3 中 Iceberg 表的数据存储。

功能

• 获取已配置命名空间中的 Bauplan 数据表及其模式
• 使用 SQL 查询 Bauplan 数据表（仅限 SELECT）

它支持 SSE 和 STDIO 传输。

工具

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

• list_tables:
  • 列出已配置命名空间中的所有表
• get_schema:
  • 获取数据表的模式
• run_query:
  • 在指定的表上运行 SELECT 查询

配置

1. 创建或编辑 Claude Desktop 配置文件，该文件位于：

   • 在 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",
        // Optional
        "BAUPLAN_TIMEOUT": "query-timeout-secs" // default 30 seconds
      }
    }
  }
}

3. 将 /path/to/uvx 替换为 uvx 可执行文件的绝对路径。 在终端中使用 which uvx 命令查找路径。 这确保在启动服务器时使用正确版本的 uvx。

4. 重新启动 Claude Desktop 以应用更改。

运行独立的 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。

然后打开浏览器访问 MCP Inspector 指示的 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

• 默认情况下，使用 SSE 传输在端口 9090 上运行。

然后打开浏览器访问 MCP Inspector 指示的 URL。 选择 SSE 传输类型。