使用说明

项目简介

LibSQL Model Context Protocol Server 是一个基于 Model Context Protocol (MCP) 协议的服务器应用，它充当 MCP 客户端和 LibSQL 数据库之间的桥梁。通过这个服务器，LLM 应用（MCP 客户端）可以方便地获取 LibSQL 数据库的结构信息、查询表格数据，并执行 SQL 查询，从而实现与数据库的交互。

主要功能点

资源管理: 能够列出 LibSQL 数据库中的所有表，并将每个表的结构（Schema）作为一个资源进行管理和提供。
Prompt 模板: 预置了 Prompt 模板，允许 LLM 客户端通过标准化的 Prompt 快速获取指定表的结构信息或查询表中的数据。
工具调用: 提供 "query" 工具，使 LLM 客户端能够执行自定义的 SQL 查询语句，从而实现更灵活的数据访问。
标准 MCP 协议: 完全遵循 MCP 协议规范，确保与任何兼容 MCP 协议的客户端无缝对接。
基于 Stdio 传输: 使用标准输入输出流 (Stdio) 作为默认的通信协议，易于部署和集成。
灵活的数据库连接: 支持连接本地或远程的 LibSQL 数据库，并允许配置身份验证 Token。

安装步骤

安装 Deno: 首先需要安装 Deno 运行时环境，版本要求 2.1 或更高。请参考 Deno 官网的安装指南完成安装。
```
curl -fsSL https://deno.land/install.sh | sh
```
构建服务器: 克隆或下载此仓库代码后，在仓库根目录下打开终端，运行以下命令编译生成可执行文件 'mcp-server-libsql'。
```
deno run build
```
构建成功后，会在当前目录下生成可执行文件 'mcp-server-libsql' (Linux/macOS) 或 'mcp-server-libsql.exe' (Windows)。

服务器配置

MCP 服务器需要配置在 MCP 客户端中，以便客户端能够连接和使用。以下是 MCP 客户端所需的服务器配置信息（JSON 格式）：

{
  "serverName": "libsql-mcp-server",  // 服务器名称，可以自定义
  "command": "./mcp-server-libsql",   // 启动服务器的命令，指向上一步构建生成的可执行文件，注意根据实际路径调整
  "args": [
    "<database-url>"              // 必须参数：LibSQL 数据库 URL。
                                     //  可以是本地数据库文件路径 (例如 "file:./mydb.db")
                                     //  也可以是远程 Turso 数据库 URL (例如 "libsql://<org>.turso.io")
    // "--auth-token", "<token>"    // 可选参数：LibSQL 数据库身份验证 Token。如果数据库需要身份验证，请取消注释并替换为您的 Token
    // "--log-file", "<log-file-path>" // 可选参数：指定日志文件路径，用于记录服务器运行日志
    // "--debug"                     // 可选参数：启用 Debug 模式，输出更详细的日志信息，通常用于开发调试
  ]
}

参数说明:

'database-url': 必填。LibSQL 数据库的连接 URL。请根据您使用的 LibSQL 数据库类型 (本地文件或远程 Turso 数据库) 填写正确的 URL。
'--auth-token <token>': 可选。如果您的 LibSQL 数据库启用了身份验证，需要提供身份验证 Token。请替换 '<token>' 为您的实际 Token。
'--log-file <log-file-path>': 可选。用于指定服务器日志文件的存储路径。如果不指定，日志将默认输出到用户目录下的日志文件中。
'--debug': 可选。启用 Debug 模式后，服务器会输出更详细的日志信息，有助于开发和调试。生产环境建议关闭 Debug 模式。

请注意:

请将上述 JSON 配置信息填入您的 MCP 客户端的服务器配置中。
确保 '<database-url>' 和 '<token>' 替换为实际的值。
根据需要选择是否添加可选参数 '--log-file' 和 '--debug'。
'command' 字段中的 './mcp-server-libsql' 需要根据实际可执行文件路径进行调整，尤其是在 Windows 系统上可能是 'mcp-server-libsql.exe'。

基本使用方法

启动服务器: 在 MCP 客户端中配置并启动 'libsql-mcp-server'。
客户端交互: 使用 MCP 客户端发送 MCP 请求，例如：
- 列出资源 (ListResourcesRequest): 获取 LibSQL 数据库中所有表的资源列表。
- 读取资源 (ReadResourceRequest): 获取指定表的 Schema 信息。
- 获取 Prompt 模板 (GetPromptRequest): 获取预定义的 Prompt 模板，例如查询表数据的 Prompt。
- 调用工具 (CallToolRequest): 调用 "query" 工具执行自定义 SQL 查询。
查看结果: MCP 服务器会将处理结果以 MCP 响应格式返回给客户端，客户端根据响应内容进行后续处理。

通过以上步骤，您就可以使用 LibSQL Model Context Protocol Server 将 LibSQL 数据库集成到您的 LLM 应用中，实现基于数据库上下文的智能应用。

关键词