Nile MCP Server 使用说明

项目简介

Nile MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器，它充当 LLM 应用和 Nile 数据库平台之间的桥梁。通过标准化的 MCP 接口，LLM 应用可以安全、便捷地访问和操作 Nile 数据库的资源和功能。

主要功能点

数据库管理: 支持创建、列出、获取详情和删除 Nile 数据库。
SQL 查询: 允许 LLM 应用执行 SQL 查询，直接操作 Nile 数据库中的数据。
凭据管理: 支持创建和列出数据库访问凭据。
区域管理: 提供 Nile 数据库支持的可用区域列表。
资源管理: 支持列出和读取数据库资源（如表）的结构信息。
租户管理: 支持在数据库中创建、列出和删除租户。
多传输协议: 支持 STDIO 和 SSE 两种传输协议，兼容 Claude Desktop 和 Cursor 等 LLM 客户端。
环境配置: 通过 '.env' 文件加载 Nile API 密钥和工作区 Slug，方便配置管理。

安装步骤

安装 Nile MCP Server 包: 打开终端，运行以下命令安装稳定版本或 Alpha/预览版本：

npm install @niledatabase/nile-mcp-server

或

npm install @niledatabase/nile-mcp-server@alpha

手动安装 (可选): 如果选择手动安装，请克隆仓库并构建项目：

git clone https://github.com/niledatabase/nile-mcp-server.git
cd nile-mcp-server
npm install
npm run build

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令及其参数才能连接。以下是 Nile MCP Server 在 Claude Desktop 和 Cursor 中的配置示例。

Claude Desktop 配置 (JSON 格式)

{
  "mcpServers": {
    "nile-database": {
      "command": "node",
      "args": [
        "/path/to/your/nile-mcp-server/dist/index.js"
      ],
      "env": {
        "NILE_API_KEY": "your_api_key_here",
        "NILE_WORKSPACE_SLUG": "your_workspace_slug"
      }
    }
  }
}

'"command": "node"': 指定启动命令为 Node.js。
'"args": ["/path/to/your/nile-mcp-server/dist/index.js"]': 指定服务器启动脚本的绝对路径，请替换为实际路径。
'"env": { ... }"': 配置环境变量。
- '"NILE_API_KEY": "your_api_key_here"': 替换为你的 Nile API 密钥。
- '"NILE_WORKSPACE_SLUG": "your_workspace_slug"': 替换为你的 Nile 工作区 Slug。

Cursor 配置 (命令格式)

env NILE_API_KEY=your_key NILE_WORKSPACE_SLUG=your_workspace node /absolute/path/to/nile-mcp-server/dist/index.js

'env NILE_API_KEY=your_key NILE_WORKSPACE_SLUG=your_workspace': 设置环境变量，替换 'your_key' 和 'your_workspace' 为你的 Nile API 密钥和工作区 Slug。
'node /absolute/path/to/nile-mcp-server/dist/index.js': 指定服务器启动命令和脚本路径，请替换为实际路径。

配置 Nile 凭据: 在项目根目录下创建 '.env' 文件，并填入你的 Nile API 密钥和工作区 Slug：

NILE_API_KEY=your_api_key_here
NILE_WORKSPACE_SLUG=your_workspace_slug

基本使用方法

启动服务器: 根据你的选择，使用以下命令启动服务器：
- 直接执行 Node.js: 'node dist/index.js'
- 开发模式 (自动重启): 'npm run dev'
在 LLM 客户端中使用: 在 Claude Desktop 或 Cursor 等 MCP 客户端中，根据上述 服务器配置 部分的说明，添加并配置 Nile MCP Server。
通过自然语言与 Nile 数据库交互: 配置完成后，即可在 LLM 客户端中使用自然语言指令，例如：
- 'Create a new database named "my_app" in AWS_US_WEST_2 region' (创建数据库)
- 'List all my databases' (列出数据库)
- 'Execute SELECT * FROM users LIMIT 5 on database "my_app"' (执行 SQL 查询)
- 'Show me the schema for the users table in my_app database' (查看表结构)
更多示例指令，请参考仓库 README 文档中的 Example Prompts 和 Example Usage 部分。

关键词