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",
        // 可选
        "BAUPLAN_TIMEOUT": "query-timeout-secs" // 默认30秒
      }
    }
  }
}

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. 将Bauplan（SDK和平台）作为资源进行文档化
2. 自动化Bauplan执行 - 更多命令和运行管道
3. 查询生成
4. 使用模板生成代码
5. 数据治理与合规性
6. 测试与验证
7. 集成生态系统

设置

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

在检查器中自由切换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传输类型。