Skip to main content

a mcp server for vikingdb store and search

Project description

VikingDB MCP server

smithery badge an mcp server for vikingdb store and search

What is VikingDB

VikingDB is a high-performance vector database developed by ByteDance.

You can easily use it following the doc bellow: https://www.volcengine.com/docs/84313/1254444

Tools

The server implements the following tools:

  • vikingdb-colleciton-intro: introduce the collection of vikingdb

  • vikingdb-index-intro: introduce the index of vikingdb

  • vikingdb-upsert-information: upsert information to vikingdb for later use

  • vikingdb-search-information: searche for information in the VikingDB

Configuration

  • vikingdb_host: The host to use for the VikingDB server.

  • vikingdb_region: The region to use for the VikingDB server.

  • vikingdb_ak: The Access Key to use for the VikingDB server.

  • vikingdb_sk: The Secret Key to use for the VikingDB server.

  • collection_name: The name of the collection to use.

  • index_name: The name of the index to use.

Quickstart

Install

Installing via Smithery

To install VikingDB MCP server for Claude Desktop automatically via Smithery:

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

Claude Desktop

On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json

On Windows: %APPDATA%/Claude/claude_desktop_config.json

Development/Unpublished Servers Configuration

{
  "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"
      ]
    }
  }
}

Published Servers Configuration

{
  "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"
    ]
   }
  }
} 

Development

Building and Publishing

To prepare the package for distribution:

  1. Sync dependencies and update lockfile:
uv sync
  1. Build package distributions:
uv build

This will create source and wheel distributions in the dist/ directory.

  1. Publish to PyPI:
uv publish

Note: You'll need to set PyPI credentials via environment variables or command flags:

  • Token: --token or UV_PUBLISH_TOKEN
  • Or username/password: --username/UV_PUBLISH_USERNAME and --password/UV_PUBLISH_PASSWORD

Debugging

Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.

You can launch the MCP Inspector via npm with this command:

npx @modelcontextprotocol/inspector uv --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

Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mseep_mcp_server_vikingdb-0.1.3.tar.gz (3.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mseep_mcp_server_vikingdb-0.1.3-py3-none-any.whl (3.0 kB view details)

Uploaded Python 3

File details

Details for the file mseep_mcp_server_vikingdb-0.1.3.tar.gz.

File metadata

File hashes

Hashes for mseep_mcp_server_vikingdb-0.1.3.tar.gz
Algorithm Hash digest
SHA256 2f6e66f1dfd4b8430485e76a42c1e8e8673cccdf105ce4716f679b32c619496c
MD5 956208fc7aa6f179a46c544a7489b93d
BLAKE2b-256 bbfbbfb6cf1a49d4e315b397b906f99680a36168f3562b6bfb2c6b4cdb041fc2

See more details on using hashes here.

File details

Details for the file mseep_mcp_server_vikingdb-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for mseep_mcp_server_vikingdb-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5c5fb80b2173c6cee862716f2c5b3fca25b3792474baeec53aa99c155216096c
MD5 2d044e77497d8cecfd6abd2725c23827
BLAKE2b-256 82d94362084924bb3253f3ab36c4eb0ef306948a71b0b9561175aef76722c3ed

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page