使用说明

项目简介

'mcp-turso' 是一个 Model Context Protocol (MCP) 服务器，它充当 LLM 客户端和 Turso 数据库之间的桥梁。通过 'mcp-turso'，LLM 可以安全、便捷地访问 Turso 数据库中的数据，用于知识检索、数据分析等应用场景。

主要功能点

列出数据库表: 获取 Turso 数据库中所有表的名称列表。
获取数据库 Schema: 获取数据库中所有表的结构定义（SQL 创建语句）。
查看表 Schema: 查看指定表的详细结构信息，包括列名、数据类型等。
执行 SQL 查询: 执行 SELECT SQL 查询语句，从数据库中检索数据。

安装步骤

前提条件: 确保您的开发环境已安装 Node.js 和 npm (或 yarn)。

克隆仓库: 将 'mcp-turso' 仓库克隆到本地：

git clone https://github.com/nbbaier/mcp-turso.git

进入目录: 导航到项目目录：
```
cd mcp-turso
```
安装依赖: 安装项目所需的 npm 依赖包：
```
npm install
```

服务器配置

要将 'mcp-turso' 服务器配置到 MCP 客户端（例如 Claude Desktop），您需要提供服务器的启动命令和必要的环境变量。以下是配置示例，请根据您的实际情况进行调整：

{
   "mcpServers": {
      "turso": {  // 服务器名称，客户端配置中引用，可以自定义
         "command": "npx", // 启动命令，通常使用 npx 运行 npm 包
         "args": ["-y", "mcp-turso"], // 命令参数，-y 自动确认安装 mcp-turso，mcp-turso 是入口脚本
         "env": {
            "TURSO_DATABASE_URL": "your_turso_database_url",  // **[请替换为您的 Turso 数据库 URL]** 从 Turso 控制台或 CLI 获取
            "TURSO_AUTH_TOKEN": "your_turso_auth_token"     // **[请替换为您的 Turso 数据库认证 Token]** 从 Turso 控制台或 CLI 创建
         }
      }
   }
}

配置参数说明:

'server name': 'turso' (服务器名称，用于在 MCP 客户端中标识和引用此服务器，可以自定义)
'command': 'npx' (指定用于启动服务器的命令，'npx' 允许您运行未全局安装的 npm 包)
'args': '["-y", "mcp-turso"]' (传递给 'npx' 的参数：
- '-y': (可选) 自动确认 'npx' 可能需要的任何包安装。
- 'mcp-turso': 指定要执行的 npm 包名称，即 'mcp-turso'，它指向服务器的入口脚本。)
'env': 环境变量配置，用于服务器运行时访问 Turso 数据库：
- 'TURSO_DATABASE_URL': [必填] 您的 Turso 数据库连接 URL。您需要从 Turso 数据库控制台或使用 Turso CLI 获取此 URL。
- 'TURSO_AUTH_TOKEN': [必填] 用于身份验证的 Turso 数据库访问令牌。您需要在 Turso 控制台或使用 Turso CLI 创建数据库令牌。

重要提示: 请务必将 'your_turso_database_url' 和 'your_turso_auth_token' 替换为您自己的 Turso 数据库 URL 和有效的认证 Token。

基本使用方法

配置 MCP 客户端: 打开您的 MCP 客户端（例如 Claude Desktop）的配置文件，按照上述 "服务器配置" 部分的说明，添加 'mcp-turso' 服务器的配置信息。
启动 MCP 客户端: 启动您的 MCP 客户端应用程序。客户端将尝试连接到配置的 MCP 服务器。
在 LLM 中使用工具: 在 LLM 应用中，您可以使用以下工具名称来调用 'mcp-turso' 服务器提供的功能：
- 'list_tables': 列出数据库表
- 'get_db_schema': 获取数据库 Schema
- 'describe_table': 查看表 Schema (需要 'table_name' 参数，指定要查看的表名)
- 'query': 执行 SQL 查询 (需要 'sql' 参数，指定要执行的 SELECT SQL 查询语句)
例如，您可以指示 LLM 执行类似以下的操作：
- "列出数据库中的所有表" (对应 'list_tables' 工具)
- "获取名为 'customers' 表的 schema 信息" (对应 'describe_table' 工具，参数 'table_name' 为 '"customers"')
- "查询 'customers' 表中所有客户的姓名和邮箱" (对应 'query' 工具，参数 'sql' 为 '"SELECT name, email FROM customers"')
LLM 将根据您的指示，调用相应的 MCP 工具，并将结果返回给您。

关键词