使用说明

项目简介

Astra DB MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的服务器端应用,旨在桥接大型语言模型 (LLM) 与 DataStax Astra DB 云数据库。它允许 LLM 客户端通过标准化的 MCP 协议,安全、便捷地访问和操作 Astra DB 中的数据,从而扩展 LLM 的上下文理解和数据处理能力。

主要功能点

  • 数据库交互工具: 提供一系列预定义的工具,使 LLM 能够执行常见的 Astra DB 数据库操作,包括:
    • 集合管理: 创建、更新、删除和列出数据库中的集合(Collections)。
    • 记录管理: 在集合中创建、读取、更新、删除和查找记录(Records)。
  • 向量数据库支持: 支持 Astra DB 的向量数据库功能,允许创建和操作向量集合,为 LLM 应用提供强大的向量检索能力。
  • JSON-RPC 协议通信: 通过 JSON-RPC 协议与 MCP 客户端进行通信,接收请求并返回响应。
  • Stdio 传输协议: 使用 Stdio 作为默认的传输协议,方便集成到各种 LLM 客户端环境中。

安装步骤

  1. 前提条件:

    • 确保您已拥有一个 Astra DB 数据库。如果没有,请访问 Astra DB 注册页面 创建一个免费数据库。
    • 获取 Astra DB 的 应用 Token (Application Token)API Endpoint。您可以在 Astra DB 控制台中找到这些信息,具体获取方法请参考 Astra DB 官方文档
  2. 安装 Astra DB MCP 服务器: 打开终端,使用 npm (或 npx) 命令全局安装 '@datastax/astra-db-mcp' 包:

    npm install -g @datastax/astra-db-mcp

    或者使用 npx 直接运行,无需全局安装:

    npx -y @datastax/astra-db-mcp

服务器配置

MCP 服务器需要配置 Astra DB 的连接信息才能正常工作。您需要在运行服务器时设置以下环境变量:

  • 'ASTRA_DB_APPLICATION_TOKEN': 您的 Astra DB 应用 Token。
  • 'ASTRA_DB_API_ENDPOINT': 您的 Astra DB API Endpoint。

MCP 客户端配置示例 (JSON 格式):

以下 JSON 配置示例展示了如何在 MCP 客户端 (如 Claude Desktop, Cursor) 中配置 Astra DB MCP 服务器。请根据您的实际情况替换 'your_astra_db_token' 和 'your_astra_db_endpoint'。

{
  "mcpServers": {
    "astra-db-mcp": {
      "command": "npx",
      "args": ["-y", "@datastax/astra-db-mcp"],
      "env": {
        "ASTRA_DB_APPLICATION_TOKEN": "your_astra_db_token",
        "ASTRA_DB_API_ENDPOINT": "your_astra_db_endpoint"
      }
    }
  }
}

配置参数说明:

  • '"astra-db-mcp"': 服务器名称,您可以自定义。
  • '"command": "npx"': 运行服务器的命令,这里使用 'npx' 来执行 npm 包。
  • '"args": ["-y", "@datastax/astra-db-mcp"]': 传递给 'npx' 的参数,'-y' 表示自动确认安装,'@datastax/astra-db-mcp' 是要执行的 npm 包名。
  • '"env"': 环境变量配置,用于传递 Astra DB 的连接信息。
    • '"ASTRA_DB_APPLICATION_TOKEN"': 设置为您的 Astra DB 应用 Token。
    • '"ASTRA_DB_API_ENDPOINT"': 设置为您的 Astra DB API Endpoint。

Windows PowerShell 用户注意:

如果使用 Windows PowerShell,'npx' 可能需要通过 'cmd /k npx' 运行,请修改 '"command"' 和 '"args"' 配置如下:

  "command": "cmd",
  "args": ["/k", "npx", "-y", "@datastax/astra-db-mcp"],

基本使用方法

  1. 启动 MCP 服务器: 配置完成后,当 MCP 客户端尝试连接到 "astra-db-mcp" 服务器时,会自动启动该服务器。
  2. 在 LLM 客户端中使用工具: 在支持 MCP 协议的 LLM 客户端中,您可以使用预定义的工具与 Astra DB 数据库进行交互。例如,您可以指示 LLM 列出数据库中的集合,或者创建一个新的记录。具体的工具列表和使用方法可以参考仓库的 'README.md' 或 'tools.ts' 文件。
  3. 示例 (在 Claude Desktop 或 Cursor 中): 将上述 JSON 配置添加到 Claude Desktop 的 'claude_desktop_config.json' 或 Cursor 的 'mcp.json' 文件中。重启客户端后,即可在客户端中使用 Astra DB 数据库相关的工具。

信息

分类

数据库与文件