README
🚀 松果助理 MCP 服务器
本项目是一个用于从松果助理检索信息的 MCP 服务器实现,能够帮助用户便捷地从松果助理获取所需信息,支持可配置数量的多结果检索。
🚀 快速开始
在使用本服务器前,需要完成一些准备工作,确保系统满足以下先决条件:
- 系统上已安装 Docker
- 拥有松果 API 密钥,可在 松果控制台 获取
- 知晓松果助理 API 主机地址,创建一个 Assistant 后,在 Assistant 详情页面可以找到主机地址
✨ 主要特性
- 从松果助理检索信息
- 支持可配置结果数量的多结果检索
📦 安装指南
使用 Docker 构建
构建 Docker 镜像,可使用以下命令:
docker build -t pinecone/assistant-mcp .
使用 Docker 运行
使用你的松果 API 密钥运行服务器,命令如下:
docker run -i --rm \
-e PINECONE_API_KEY=<YOUR_PINECONE_API_KEY_HERE> \
-e PINECONE_ASSISTANT_HOST=<YOUR_PINECONE_ASSISTANT_HOST_HERE> \
pinecone/assistant-mcp
环境变量
| 属性 | 详情 |
|------|------|
| PINECONE_API_KEY | 必需,你的松果 API 密钥 |
| PINECONE_ASSISTANT_HOST | 可选,松果助理 API 主机地址(默认值:https://prod-1-data.ke.pinecone.io) |
| LOG_LEVEL | 可选,日志级别(默认值:info) |
从源代码构建
如果你希望不使用 Docker 从源代码构建,可按以下步骤操作:
- 确保你已经安装了 Rust(https://rustup.rs/)
- 克隆此仓库
- 运行
cargo build --release - 可执行文件将位于
target/release/assistant-mcp
💻 使用示例
基础用法
使用 inspector 测试
export PINECONE_API_KEY=<YOUR_PINECONE_API_KEY_HERE>
export PINECONE_ASSISTANT_HOST=<YOUR_PINECONE_ASSISTANT_HOST_HERE>
# 单独运行 inspector
npx @modelcontextprotocol/inspector cargo run
# 或通过 inspector 使用 Docker 直接运行
npx @modelcontextprotocol/inspector -- docker run -i --rm -e PINECONE_API_KEY -e PINECONE_ASSISTANT_HOST pinecone/assistant-mcp
高级用法
与 Claude Desktop 集成
在你的 claude_desktop_config.json 中添加以下内容:
{
"mcpServers": {
"pinecone-assistant": {
"command": "docker",
"args": [
"run",
"-i",
"--rm",
"-e",
"PINECONE_API_KEY",
"-e",
"PINECONE_ASSISTANT_HOST",
"pinecone/assistant-mcp"
],
"env": {
"PINECONE_API_KEY": "<YOUR_PINECONE_API_KEY_HERE>",
"PINECONE_ASSISTANT_HOST": "<YOUR_PINECONE_ASSISTANT_HOST_HERE>"
}
}
}
}
📄 许可证
该项目的许可信息请参阅 LICENSE 文件。
Scan to contact