Volcengine Knowledge Base

🚀 火山引擎知识库 MCP 服务器

Claude Desktop 的火山引擎知识库 MCP 服务器，可提供知识库搜索和对话功能，为用户带来便捷的知识查询与交流体验。

🚀 快速开始

先决条件

• Python 3.10 或更高版本
• Claude Desktop
• 需要注册火山引擎账号，开通知识库服务，并创建一个知识库

安装步骤

1. 克隆代码仓库：

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

2. 安装依赖项：

pip install -r requirements.txt

配置 Claude Desktop

编辑Claude Desktop配置文件：

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

添加以下配置：

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

使用说明

设置Claude MCP JSON配置后，只需告知Claude使用知识库，它将提示输入相关凭证信息，包括ak, sk, account_id以及collection_name。

1. 首次使用时配置凭证：

await configure(
access_key="your_access_key",
secret_key="your_secret_key",
account_id=your_account_id,
collection_name="your_collection_name"
)

2. 搜索知识库：

result = await search_knowledge("你的查询")

3. 对话补全：

messages = [
{"role": "system", "content": "你是一个有帮助的助手"},
{"role": "user", "content": "你好"}
]
response = await chat_completion(messages)

✨ 主要特性

• 🔍 知识库搜索
• 💬 对话补全
• 🔐 安全凭证管理
• 🚀 简单易用的配置

📚 详细文档

API 文档

configure

配置火山引擎凭证和知识库设置。 参数：

• access_key (str): 火山引擎访问密钥
• secret_key (str): 火山引擎安全密钥
• account_id (int): 火山引擎账户ID
• collection_name (str): 知识库集合名称

search_knowledge

搜索知识库。 参数：

• query (str): 搜索查询字符串

chat_completion

获取对话补全响应。 参数：

• messages (List[dict]): 对话消息列表
• stream (bool, 可选): 是否使用流式响应
• temperature (float, 可选): 温度参数

🔧 技术细节

安全注意事项

• 所有凭证均安全存储于本地设备
• 配置文件权限仅限当前用户访问
• 不会将凭证传递到火山引擎 API 之外的地方

故障排除

遇到问题时：

1. 确认凭证信息无误
2. 检查配置文件权限设置
3. 查看Claude Desktop的日志信息
4. 如果需要，联系技术支持寻求帮助

📄 许可证

本项目采用 MIT 许可证。

致谢

感谢以下项目和团队的支持：

• Volcengine
• Claude