使用说明
项目简介
Pinecone MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在为大型语言模型 (LLM) 客户端(如 Claude Desktop)提供与 Pinecone 向量数据库集成的知识库服务。通过此服务器,LLM 客户端可以利用 Pinecone 的强大向量搜索能力,实现语义搜索、文档检索和知识存储等功能,从而增强 LLM 应用的上下文理解和知识应用能力。
主要功能点
- 资源管理: 允许客户端访问和读取存储在 Pinecone 向量数据库中的文档资源。
- 语义搜索工具: 提供 'semantic-search' 工具,支持客户端通过自然语言查询在 Pinecone 知识库中进行高效的语义搜索,检索相关文档。
- 文档操作工具: 包含 'read-document'、'list-documents' 和 'process-document' 工具,支持客户端读取指定文档、列出文档列表以及将文档处理后存储到 Pinecone 数据库中。
- Pinecone 统计工具: 提供 'pinecone-stats' 工具,允许客户端获取 Pinecone 索引的统计信息,如向量数量、维度等。
- Prompt 模板: 预置 'pinecone-query' 和 'pinecone-store' Prompt 模板,简化客户端与 Pinecone 知识库的交互流程,支持用户通过自然语言指令进行知识查询和存储。
安装步骤
-
安装服务器: 推荐使用 'uv' 工具安装 'mcp-pinecone' 服务器。打开终端并执行以下命令:
uv pip install mcp-pinecone或者使用 'uvx':
uvx install mcp-pinecone -
配置 Pinecone:
- 访问 Pinecone 官网 注册并登录账号。
- 创建一个新的 Pinecone 索引,并获取您的 Index Name (索引名称) 和 API Key (API 密钥)。
服务器配置
为了让 MCP 客户端(例如 Claude Desktop)能够连接到 Pinecone MCP Server,您需要在客户端的配置文件中添加服务器配置信息。以下是针对 Claude Desktop 的配置示例,请根据您的 MCP 客户端类型进行相应配置。
Claude Desktop 配置文件路径:
- MacOS: '~/Library/Application\ Support/Claude/claude_desktop_config.json'
- Windows: '%APPDATA%/Claude/claude_desktop_config.json'
配置信息 (JSON 格式):
请根据您的需求选择以下两种配置方式之一,并将配置添加到 'claude_desktop_config.json' 文件的 '"mcpServers"' 字段下。
开发/未发布服务器配置 (Development/Unpublished Servers Configuration):
适用于本地开发和测试环境。
"mcpServers": { "mcp-pinecone": { "command": "uv", "args": [ "--directory", "{project_dir}", "run", "mcp-pinecone" ] } }
参数说明:
- 'command': 启动服务器的命令,这里使用 'uv'。如果 'uv' 不在 PATH 环境变量中,请使用 'which uv' 命令查找 'uv' 的完整路径并替换。
- 'args': 传递给 'uv' 命令的参数。
- '--directory': 指定项目目录,'{project_dir}' 需要替换为您的 'mcp-pinecone' 项目的实际路径。
- 'run mcp-pinecone': 运行 'mcp-pinecone' 服务器。
已发布服务器配置 (Published Servers Configuration):
适用于部署后的服务器,需要指定 Pinecone 索引名称和 API 密钥。
"mcpServers": { "mcp-pinecone": { "command": "uvx", "args": [ "--index-name", "{your-index-name}", "--api-key", "{your-secret-api-key}", "mcp-pinecone" ] } }
参数说明:
- 'command': 启动服务器的命令,这里使用 'uvx'。如果 'uvx' 不在 PATH 环境变量中,请使用 'which uvx' 命令查找 'uvx' 的完整路径并替换。
- 'args': 传递给 'uvx' 命令的参数。
- '--index-name': 您的 Pinecone 索引名称,请将 '{your-index-name}' 替换为实际的索引名称。
- '--api-key': 您的 Pinecone API 密钥,请将 '{your-secret-api-key}' 替换为实际的 API 密钥。
- 'mcp-pinecone': 运行 'mcp-pinecone' 服务器。
重要提示: 请务必将 '{your-index-name}' 和 '{your-secret-api-key}' 替换为您在 Pinecone 官网获取的真实索引名称和 API 密钥。
基本使用方法
- 启动 MCP 客户端: 启动配置了 Pinecone MCP Server 的 MCP 客户端,例如 Claude Desktop。
- 使用工具和 Prompt: 在 MCP 客户端中,您可以访问 Pinecone MCP Server 提供的工具(如 'semantic-search', 'process-document' 等)和 Prompt 模板(如 'pinecone-query', 'pinecone-store')。根据您的需求选择合适的工具或 Prompt,并提供相应的输入参数,即可与 Pinecone 知识库进行交互,实现语义搜索、文档存储等功能。
例如,在 Claude Desktop 中,您可以使用 '@tools/semantic-search' 工具进行语义搜索,或者使用 '@prompts/pinecone-query' Prompt 模板进行知识查询。具体使用方式请参考您的 MCP 客户端的文档。
信息
分类
数据库与文件