JinDaGe - waii-mcp-server MCP Details

article

README

🚀 WAII MCP 服务器

WAII MCP 服务器是一个模型上下文协议（MCP）服务器，借助 WAII 实现数据库交互功能。它允许语言模型通过自然语言与数据库进行交互、执行查询并处理数据库内容。

mcp

🚀 快速开始

本服务器可使语言模型借助自然语言与数据库交互，为数据处理提供便利。下面为您详细介绍使用前的准备。

✨ 主要特性

自然语言到 SQL 转换
数据库模式理解和管理
查询执行和结果格式化
自动查询优化建议
数据可视化功能

📦 安装指南

使用 uv/uvx（推荐）

使用 uv/uvx 无需任何特定安装，您可以直接运行服务器：

uv run -m mcp_server_waii \
  --url "YOUR_WAII_URL" \
  --api-key "YOUR_API_KEY" \
  --database-key "YOUR_DATABASE_CONNECTION_STRING"

使用 pip

您也可以通过 pip 安装 mcp-server-waii：

pip install mcp-server-waii

安装后，将其作为模块运行：

python -m mcp_server_waii \
  --url "YOUR_WAII_URL" \
  --api-key "YOUR_API_KEY" \
  --database-key "YOUR_DATABASE_CONNECTION_STRING"

📚 详细文档

可用工具

数据库

通过 WAII 的自然语言接口与数据库交互。 | 属性 | 详情 | |------|------| | 参数 | - database-key（字符串，必填）：您的数据库连接字符串
- api-key（字符串，必填）：您的 WAII API 密钥
- url（字符串，必填）：WAII API 端点 URL |

要求

Python 3.10 或更高版本
具有 API 访问权限的 WAII 账户
支持 WAII 的数据库凭证

配置

配置用于 Claude.app

有几种方法可以配置服务器以供 Claude 使用：

1. 使用 uvx（推荐）

{
    "mcpServers": {
        "waii": {
            "command": "uvx",
            "args": [
                "mcp_server_waii",
                "--url",
                "YOUR_WAII_URL",
                "--api-key",
                "YOUR_API_KEY",
                "--database-key",
                "YOUR_DATABASE_CONNECTION_STRING"
            ]
        }
    }
}

2. 使用 Python 安装

{
    "mcpServers": {
        "waii": {
            "command": "python",
            "args": [
                "-m",
                "mcp_server_waii",
                "--url",
                "YOUR_WAII_URL",
                "--api-key",
                "YOUR_API_KEY",
                "--database-key",
                "YOUR_DATABASE_CONNECTION_STRING"
            ]
        }
    }
}

示例值：

YOUR_WAII_URL：例如，“http://WAII_URL/api/”
YOUR_API_KEY：您的 WAII API 密钥
YOUR_DATABASE_CONNECTION_STRING：例如，“snowflake://USER@HOST/DB?role=ROLE&warehouse=WAREHOUSE”

开发

要设置开发环境，可按以下步骤操作：

克隆仓库

git clone https://github.com/waii-ai/mcp-server-waii.git
cd mcp-server-waii

以开发模式安装：

uv pip install -e .

支持

若您需要寻求帮助，可按以下步骤操作：

检查GitHub 问题
联系 WAII 支持以获取 API 相关问题解答
发现错误时提交新问题

📄 许可证

本项目采用 Apache License 2.0，有关详细信息，请参阅 LICENSE 文件。

waii-mcp-server