项目简介
Pinecone Assistant MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器,旨在作为 LLM 客户端的后端,提供访问 Pinecone Assistant 知识库的能力。通过此服务器,LLM 应用可以调用预设的工具,检索 Pinecone Assistant 中存储的相关上下文信息,从而增强 LLM 的知识和推理能力。
主要功能点
- 上下文检索工具: 提供 'assistant_context' 工具,允许 LLM 客户端通过指定 Assistant 名称和查询语句,从 Pinecone Assistant 知识库中检索相关的文本片段作为上下文信息。
- 可配置的检索参数: 'assistant_context' 工具支持配置 'top_k' 参数,用于调整返回上下文片段的数量,以满足不同应用场景的需求。
- Docker 部署: 支持使用 Docker 镜像快速部署和运行 MCP 服务器。
- 源码构建: 提供从源代码构建和运行服务器的选项,方便开发者进行定制和扩展。
- 兼容 MCP 协议: 遵循 MCP 协议标准,能够与任何兼容 MCP 协议的 LLM 客户端进行交互,例如 Claude Desktop。
安装步骤
前置条件
- 确保已安装 Docker (如果选择 Docker 部署) 或 Rust 编译环境 (如果选择源码构建)。
- 拥有 Pinecone API Key 和 Pinecone Assistant Host。 您可以从 Pinecone Console 获取 API Key,并在创建 Assistant 后,在 Assistant 详情页找到 Host 信息。
Docker 部署 (推荐)
-
构建 Docker 镜像: 打开终端,克隆仓库代码或下载仓库压缩包并解压,进入仓库根目录,执行以下命令构建 Docker 镜像:
docker build -t pinecone/assistant-mcp . -
运行 Docker 容器: 使用以下命令运行 Docker 容器,替换 '<YOUR_PINECONE_API_KEY_HERE>' 和 '<YOUR_PINECONE_ASSISTANT_HOST_HERE>' 为您的 Pinecone API Key 和 Assistant Host。
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
源码构建
-
安装 Rust: 如果尚未安装 Rust,请根据 Rust 官网 指引安装 Rust 编译环境。
-
构建可执行文件: 克隆仓库代码或下载仓库压缩包并解压,进入仓库根目录,执行以下命令构建可执行文件:
cargo build --release构建成功后,可执行文件 'assistant-mcp' 将位于 'target/release/' 目录下。
-
运行服务器: 在终端中,进入 'target/release/' 目录,设置环境变量 'PINECONE_API_KEY' 和 'PINECONE_ASSISTANT_HOST',然后运行可执行文件 'assistant-mcp'。
export PINECONE_API_KEY=<YOUR_PINECONE_API_KEY_HERE> export PINECONE_ASSISTANT_HOST=<YOUR_PINECONE_ASSISTANT_HOST_HERE> ./assistant-mcp
服务器配置
对于兼容 MCP 协议的 LLM 客户端 (例如 Claude Desktop),您需要配置 MCP 服务器的连接信息。以下是针对 Claude Desktop 的 'claude_desktop_config.json' 配置示例:
{ "mcpServers": { "pinecone-assistant": { // 服务器名称,客户端用以识别和调用 "command": "docker", // 启动服务器的命令,这里使用 Docker "args": [ // 启动命令的参数 "run", "-i", "--rm", "-e", "PINECONE_API_KEY", // 通过环境变量传递 Pinecone API Key "-e", "PINECONE_ASSISTANT_HOST", // 通过环境变量传递 Pinecone Assistant Host "pinecone/assistant-mcp" // Docker 镜像名称 ], "env": { // 环境变量配置,客户端负责在启动服务器时设置 "PINECONE_API_KEY": "<YOUR_PINECONE_API_KEY_HERE>", // 请替换为您的 Pinecone API Key "PINECONE_ASSISTANT_HOST": "<YOUR_PINECONE_ASSISTANT_HOST_HERE>" // 请替换为您的 Pinecone Assistant Host } } } }
注意:
- 请将 '<YOUR_PINECONE_API_KEY_HERE>' 和 '<YOUR_PINECONE_ASSISTANT_HOST_HERE>' 替换为您的实际 Pinecone API Key 和 Assistant Host。
- 上述配置示例适用于 Docker 部署方式。如果您选择源码构建方式,请根据实际情况修改 'command' 和 'args' 字段,例如 'command' 可以设置为可执行文件的路径,'args' 可以为空数组。
基本使用方法
- 启动 Pinecone Assistant MCP Server。
- 在兼容 MCP 协议的 LLM 客户端中配置并连接到该服务器。
- 在 LLM 应用中,可以使用 'assistant_context' 工具,通过指定 Assistant 名称和查询语句,从 Pinecone Assistant 获取上下文信息。 例如,在 Claude Desktop 中,您可以使用类似 '@pinecone-assistant:assistant_context assistant_name="your-assistant-name" query="your query"' 的语法来调用该工具。
更多关于 MCP 协议和工具调用的详细信息,请参考 Model Context Protocol 相关文档。
信息
分类
数据库与文件