项目简介

WAII数据库MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端。它利用WAII平台的能力，使支持MCP协议的大型语言模型（LLM）能够通过自然语言与各种数据库进行交互，执行查询、检索数据和理解数据库结构。

主要功能点

• 自然语言数据库交互： 允许LLM使用自然语言提问，服务器将其通过WAII转换为数据库操作。
• 自然语言转SQL： 利用WAII的能力将用户的自然语言问题转化为可执行的SQL查询。
• 数据库结构理解： 帮助LLM理解数据库的Schema、表和列信息。
• 查询执行与结果处理： 执行生成的SQL查询，并格式化结果以便LLM理解和使用。
• 会话历史管理： 在与LLM的交互中维护查询会话历史。

安装步骤

要运行此MCP服务器，您需要Python 3.10或更高版本，一个WAII账户以及相应的数据库连接信息。

推荐使用pip进行安装：

1. 确保您已安装Python 3.10或更高版本。

2. 打开终端或命令行工具。

3. 运行以下命令安装服务器：

   pip install mcp-server-waii
   

服务器配置（供MCP客户端使用）

此服务器需要配置才能被支持MCP的LLM客户端（如Claude.app）启动和连接。您需要在MCP客户端的配置中指定如何启动此服务器。

通常，MCP客户端的配置文件（常为JSON格式）会有一个部分用于配置MCP服务器，例如命名为 'mcpServers'。您需要在此部分添加一个条目，指定该服务器的名称（例如 '"waii"'）以及启动它的命令和参数。

配置信息通常包括：

• 'command': 指定执行服务器的命令。如果您使用pip安装，这通常是 '"python"'。
• 'args': 一个列表，包含传递给命令的参数。对于此服务器，这些参数是：
  • '"-m"': Python模块运行标志。
  • '"mcp_server_waii"': 要运行的Python模块名。
  • '"--url"': 指定WAII API的URL端点，例如 '"http://WAII_URL/api/"'。
  • '"YOUR_WAII_URL"': 替换为您的实际WAII服务地址。
  • '"--api-key"': 指定您的WAII API密钥。
  • '"YOUR_API_KEY"': 替换为您的实际WAII API密钥。
  • '"--database-key"': 指定您的数据库连接字符串或标识符。
  • '"YOUR_DATABASE_CONNECTION_STRING"': 替换为您的实际数据库连接字符串。

请将上述占位符替换为您从WAII平台和数据库获取的实际连接信息。具体的配置格式请参考您的MCP客户端的文档。

基本使用方法

在MCP客户端（如Claude.app）中完成服务器配置后，启动客户端。客户端会自动启动配置好的MCP服务器并通过Stdio建立连接。

一旦连接成功，LLM将能够感知到由该服务器提供的工具（通常名为 'waii_chatbot'）。当您向LLM提出与数据库相关的问题时，LLM将识别出可以使用此工具来获取信息或执行操作。LLM会通过MCP协议调用 'waii_chatbot' 工具，将您的自然语言问题作为参数传递给服务器。服务器通过WAII处理请求，并将结果返回给LLM，最终由LLM呈现给您。

简单来说，配置完成后，您就可以直接向LLM提问关于已连接数据库的问题，就像与一个了解数据库的助手对话一样。