Pinecone Vector Db MCP Server

🚀 MCP Pinecone向量数据库服务器

该项目实现了一个模型上下文协议（MCP）服务器，可实现对Pinecone向量数据库的读写操作。它能有效处理PDF数据以及Confluence数据，为相关数据处理提供了便捷的解决方案。

🚀 快速开始

本项目实现的MCP服务器允许对Pinecone向量数据库进行读写操作。下面为你介绍快速启动项目的步骤。

✨ 主要特性

• 使用文本查询搜索相似文档。
• 可带有自定义元数据添加新向量到数据库。
• 支持批量处理并上传Confluence数据。
• 能够通过ID删除向量。
• 原本计划提供数据库基本统计信息，但目前暂不可用。

📦 安装指南

先决条件

• 需要安装Bun运行时环境。
• 准备好Pinecone API密钥。
• 准备好OpenAI API密钥（用于生成嵌入）。

安装步骤

1. 克隆此仓库。
2. 安装依赖：

   bun install
   

3. 创建一个.env文件，内容如下：

   PINECONE_API_KEY=你的Pinecone API密钥
   OPENAI_API_KEY=你的OpenAI API密钥
   PINECONE_HOST=你的Pinecone主机地址
   PINECONE_INDEX_NAME=你的索引名称
   DEFAULT_NAMESPACE=默认命名空间
   

💻 使用示例

基础用法

运行MCP服务器

启动服务器：

bun src/index.ts

服务器将启动并监听stdio上的MCP命令。

运行示例客户端

使用示例客户端测试服务器：

bun examples/client.ts

处理Confluence数据

Confluence处理脚本提供详细的日志记录和验证：

bun src/scripts/process-confluence.ts <文件路径> [集合] [范围]

参数说明：

• 文件路径：指向你的Confluence JSON文件（必填）。
• 集合：文档集合名称（默认为"documentation"）。
• 范围：文档范围（默认为"documentation"）。

示例：

bun src/scripts/process-confluence.ts ./data/confluence-export.json "tech-docs" "engineering"

脚本将执行以下操作：

1. 验证输入参数。
2. 处理并矢量化内容。
3. 批量上传向量。
4. 验证上传成功。
5. 提供详细的过程日志。

高级用法

服务器提供了以下工具，可根据不同需求灵活使用：

1. search-vectors - 使用文本查询搜索相似文档，参数包括：
   • query：字符串（搜索查询文本）。
   • topK：数字（1 - 100，默认为5）。
   • filter：对象（可选过滤条件）。
2. add-vector - 添加单个文档，参数包括：
   • text：字符串（内容以供矢量化）。
   • metadata：对象（向量元数据）。
   • id：字符串（可选自定义ID）。
3. process-confluence - 处理Confluence JSON数据，参数包括：
   • filePath：字符串（文件路径）。
   • namespace：字符串（可选，默认为"capella - document - search"）。
4. delete-vectors - 删除向量，参数包括：
   • ids：字符串数组（向量ID列表）。
   • namespace：字符串（可选，默认为"capella - document - search"）。
5. get-stats - 获取数据库统计信息（暂不可用）。

📚 详细文档

数据库配置

服务器需要Pinecone向量数据库。在.env文件中配置连接参数：

PINECONE_API_KEY=你的API密钥
PINECONE_HOST=你的主机地址
PINECONE_INDEX_NAME=你的索引名称
DEFAULT_NAMESPACE=默认命名空间

元数据模式

Confluence文档

ID: confluence-[page-id]-[item-id]
title: [标题]
pageId: [页面ID]
spaceKey: [空间键]
type: [类型]
content: [文本内容]
author: [作者姓名]
source: [来源]