- Home
- MCP servers
- Volcengine Knowledge Base
Volcengine Knowledge Base
- python
0
GitHub Stars
python
Language
3 months ago
First Indexed
3 weeks ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"mcp-mirror-suqidan_volcengine_knowledgebase_mcp": {
"command": "python",
"args": [
"/path/to/kb_mcp.py"
]
}
}
}You deploy an MCP server that lets you search a Volcengine knowledge base and generate conversational responses. This server integrates with your MCP client to perform knowledge retrieval and chat-style interaction, all while keeping credentials securely local on your machine.
How to use
You configure your MCP client to connect to the knowledge base MCP server, then use the provided functions to search the knowledge base or generate chat completions. You will supply credentials and the target collection name once, and then you can perform queries and receive contextual responses.
# 1) Configure your Volcano Engine credentials and knowledge base
await configure(
access_key="your_access_key",
secret_key="your_secret_key",
account_id=your_account_id,
collection_name="your_collection_name"
)
# 2) Search the knowledge base with a query
result = await search_knowledge("your query here")
# 3) Get a chat completion using a structured message list
messages = [
{"role": "system", "content": "You are a helpful assistant"},
{"role": "user", "content": "Hello"}
]
response = await chat_completion(messages)
How to install
Prerequisites: Python 3.10 or newer and Claude Desktop. You also need a Volcano Engine account with knowledge base services and a created knowledge base.
Step 1: Clone the MCP server repository and enter the project directory.
git clone git@github.com:suqidan/volc-kb-mcp.git
cd volc-kb-mcp
Step 2: Install the Python dependencies.
pip install -r requirements.txt
Step 3: Configure Claude Desktop to use the MCP server. Add the following in your Claude Desktop configuration to point to the knowledge base MCP entry.
{
"mcpServers": {
"kb": {
"command": "python",
"args": [
"/path/to/kb_mcp.py"
]
}
}
}
Additional important content
Configuration notes: The MCP server is exposed as a stdio-based local process. You start it by running Python with the path to the kb_mcp.py script as shown in the example above. You will configure credentials and the knowledge base collection once, and then you can perform searches and chat completions via your MCP client.
Security: All credentials stay securely stored on your local device, and the configuration file is accessible only to you. No credentials are sent to any external service beyond Volcano Engine APIs.
Troubleshooting: If you run into issues, verify that your credentials are correct, confirm the configuration file has proper permissions, check the Claude Desktop logs, and if needed, reset the configuration by removing the config file at your local path (for example, the path under your user config directory).
Available tools
configure
Set up Volcano Engine credentials and knowledge base settings so that subsequent searches and chat completions can access the knowledge base.
search_knowledge
Query the knowledge base to retrieve relevant documents or facts that can be presented to the user.
chat_completion
Generate a contextual, chat-style response using the knowledge base content and the provided conversational messages.