使用说明

项目简介

VikingDB MCP服务器是一个基于 Model Context Protocol (MCP) 构建的应用后端，旨在为大型语言模型（LLM）客户端提供与 VikingDB 向量数据库交互的桥梁。通过此服务器，LLM 可以利用预定义的工具，安全、便捷地访问和操作 VikingDB 中的数据，实现知识检索、信息存储等功能。

主要功能点

向量数据库集成: 无缝连接 ByteDance 开发的高性能向量数据库 VikingDB。
信息检索: 支持通过自然语言查询在 VikingDB 中检索相关信息。
信息存储: 允许将新的信息添加到 VikingDB 数据库中，以便后续检索和使用。
数据库信息查询: 提供工具查询 VikingDB 数据库中 Collection 和 Index 的基本信息。
标准化接口: 遵循 MCP 协议，提供标准的 JSON-RPC 接口与 LLM 客户端通信。

安装步骤

使用 Smithery CLI 安装 (推荐 Claude Desktop 用户使用): 打开终端，运行以下命令，即可自动安装 VikingDB MCP server 并配置 Claude Desktop 客户端：

npx @smithery/cli install mcp-server-vikingdb --client claude

服务器配置

MCP 服务器需要配置在 MCP 客户端中才能使用。以 Claude Desktop 为例，您需要在 Claude 的配置文件中添加 VikingDB MCP Server 的配置信息。

配置文件位置：

MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

配置内容 (添加到 'mcpServers' 字段中):

{
  "mcpServers": {
    "mcp-server-vikingdb": {
      "command": "uv",
      "args": [
        "--directory",
        "dir to mcp-server-vikingdb",
        "run",
        "mcp-server-vikingdb",
        "--vikingdb-host",
        "<VikingDB Host>",  //  请替换为您的 VikingDB 服务 Host 地址
        "--vikingdb-region",
        "<VikingDB Region>", // 请替换为您的 VikingDB 服务 Region
        "--vikingdb-ak",
        "<VikingDB Access Key>", // 请替换为您的 VikingDB Access Key
        "--vikingdb-sk",
        "<VikingDB Secret Key>",  // 请替换为您的 VikingDB Secret Key
        "--collection-name",
        "<Collection Name>", // 请替换为您要使用的 Collection 名称
        "--index-name",
        "<Index Name>"      // 请替换为您要使用的 Index 名称
      ]
    }
  }
}

参数说明:

command: 运行 MCP 服务器的命令，这里使用 'uv' (建议使用 uv 运行 Python 项目以获得更好的性能)。
args: 传递给 'command' 的参数列表。
- '--directory "dir to mcp-server-vikingdb"': 指向 'mcp-server-vikingdb' 仓库代码所在目录的路径。请将 '"dir to mcp-server-vikingdb"' 替换为实际的目录路径。
- 'run mcp-server-vikingdb': 运行 'mcp-server-vikingdb' 入口点。
- '--vikingdb-host': VikingDB 服务的主机地址。
- '--vikingdb-region': VikingDB 服务所在的区域。
- '--vikingdb-ak': 访问 VikingDB 服务的 Access Key。
- '--vikingdb-sk': 访问 VikingDB 服务的 Secret Key。
- '--collection-name': 要使用的 VikingDB Collection 名称。
- '--index-name': 要使用的 VikingDB Index 名称。

注意: 请务必将 '<VikingDB Host>', '<VikingDB Region>', '<VikingDB Access Key>', '<VikingDB Secret Key>', '<Collection Name>', '<Index Name>' 替换为您的实际 VikingDB 服务配置信息。以及将 '"dir to mcp-server-vikingdb"' 替换为实际的代码目录路径。

基本使用方法

配置完成后，LLM 客户端（如 Claude Desktop）即可识别并连接到 VikingDB MCP 服务器。您可以通过自然语言指令，指示 LLM 使用以下工具与 VikingDB 交互：

vikingdb-collection-intro: 查询 VikingDB Collection 的基本信息。
vikingdb-index-intro: 查询 VikingDB Index 的基本信息。
vikingdb-upsert-information: 将新的信息添加到 VikingDB 中。
vikingdb-search-information: 在 VikingDB 中搜索信息。

具体工具的使用方法和参数，请参考工具的描述信息或咨询 LLM 客户端的相关文档。

关键词