article
README
🚀 VikingDB MCP服务端
VikingDB MCP服务端是一个用于VikingDB存储和搜索的服务器,能够助力用户更高效地对VikingDB进行操作。
📚 什么是VikingDB
VikingDB是由字节跳动开发的一款高性能向量数据库。
您可以按照以下文档轻松使用它: https://www.volcengine.com/docs/84313/1254444
🔧 工具
该服务端实现了以下工具:
- vikingdb-colleciton-intro:介绍VikingDB的集合
- vikingdb-index-intro:介绍VikingDB的索引
- vikingdb-upsert-information:将信息插入到VikingDB中以便后续使用
- vikingdb-search-information:在VikingDB中搜索信息
⚙️ 配置
| 属性 | 详情 | |------|------| | vikingdb_host | 使用的VikingDB服务端地址 | | vikingdb_region | 使用的区域 | | vikingdb_ak | 使用的访问密钥 | | vikingdb_sk | 使用的密钥 | | collection_name | 使用的集合名称 | | index_name | 使用的索引名称 |
🚀 快速开始
📦 安装
通过Smithery安装
要自动通过Smithery为Claude Desktop安装VikingDB MCP服务端:
npx -y @smithery/cli install mcp-server-vikingdb --client claude
Claude Desktop配置
- MacOS:
~/Library/Application\ Support/Claude/claude_desktop_config.json - Windows:
%APPDATA%/Claude/claude_desktop_config.json
开发/未发布服务器配置
{
"mcpServers": {
"mcp-server-vikingdb": {
"command": "uv",
"args": [
"--directory",
"dir to mcp-server-vikingdb",
"run",
"mcp-server-vikingdb",
"--vikingdb-host",
"your host",
"--vikingdb-region",
"your region",
"--vikingdb-ak",
"your access key",
"--vikingdb-sk",
"your secret key",
"--collection-name",
"your collection name",
"--index-name",
"your index name"
]
}
}
}
已发布服务器配置
{
"mcpServers": {
"mcp-server-vikingdb": {
"command": "uvx",
"args": [
"mcp-server-vikingdb",
"--vikingdb-host",
"your host",
"--vikingdb-region",
"your region",
"--vikingdb-ak",
"your access key",
"--vikingdb-sk",
"your secret key",
"--collection-name",
"your collection name",
"--index-name",
"your index name"
]
}
}
}
💻 开发
🔨 构建与发布
要准备分发包:
- 同步依赖并更新锁定文件:
uv sync
- 构建和发布:
uv build && uv publish
💡 调试建议
我们推荐使用MCP Inspector工具。下面是使用命令示例:
# 查看日志
uv log mcp-server-vikingdb
# 进入调试界面
uv debug mcp-server-vikingdb
微信扫一扫