Volcengine Knowledge Base

🚀 Volcengine Knowledge Base MCP Server

The Volcengine Knowledge Base MCP server for Claude Desktop, offering knowledge base search and conversation capabilities.

✨ Features

• 🔍 Knowledge base search
• 💬 Conversation completion
• 🔐 Secure credential management
• 🚀 Simple and easy-to-use configuration

🚀 Quick Start

Prerequisites

• Python 3.10 or higher
• Claude Desktop
• You need to register a Volcengine account, activate the knowledge base service, and create a knowledge base.

📦 Installation

1. Clone the code repository:

git clone git@github.com:suqidan/volc-kb-mcp.git
cd volc-kb-mcp

2. Install the dependencies:

pip install -r requirements.txt

Configure Claude Desktop

Edit the Claude Desktop configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json

Add the following configuration:

{
    "mcpServers": {
        "kb": {
            "command": "python",
            "args": [
                "/path/to/kb_mcp.py"
            ]
        }
    }
}

Usage Instructions

After setting the Claude MCP JSON configuration, simply tell Claude to use the knowledge base, and it will prompt you to enter relevant credential information, including ak, sk, account_id, and collection_name.

💻 Usage Examples

Basic Usage

# Configure credentials for the first use
await configure(
    access_key="your_access_key",
    secret_key="your_secret_key",
    account_id=your_account_id,
    collection_name="your_collection_name"
)

# Search the knowledge base
result = await search_knowledge("your_query")

# Conversation completion
messages = [
    {"role": "system", "content": "You are a helpful assistant"},
    {"role": "user", "content": "Hello"}
]
response = await chat_completion(messages)

📚 Documentation

📄 API Documentation

configure

Configure Volcengine credentials and knowledge base settings.

Parameters:

• access_key (str): Volcengine access key
• secret_key (str): Volcengine secret key
• account_id (int): Volcengine account ID
• collection_name (str): Knowledge base collection name

search_knowledge

Search the knowledge base.

Parameters:

• query (str): Search query string

chat_completion

Get a conversation completion response.

Parameters:

• messages (List[dict]): List of conversation messages
• stream (bool, optional): Whether to use a streaming response
• temperature (float, optional): Temperature parameter

🔧 Technical Details

Security Precautions

• All credentials are securely stored on the local device.
• The configuration file permissions are restricted to the current user.
• Credentials are not passed outside of the Volcengine API.

Troubleshooting

When encountering issues:

1. Confirm that the credential information is correct.
2. Check the configuration file permission settings.
3. View the Claude Desktop log information.
4. Contact technical support for assistance if necessary.

📄 License

This project is licensed under the MIT License.

Acknowledgments

Thanks to the support of the following projects and teams:

• Volcengine
• Claude