松果云模型上下文协议服务器文档

项目概述

为Claude桌面实现一个能够读取和写入松果云索引的MCP（Model Context Protocol）服务器。

组件结构

flowchart TB
    subgraph 客户端["MCP客户端（如Claude桌面）"]
        UI[用户界面]
    end

    subgraph 服务器组件["MCP服务器（pinecone-mcp）"]
        Server[服务器类]

        subgraph 处理器["请求处理器"]
            PineconeIndexHandler[松果云索引处理器]
            FileHandler[文件处理器]
        end
    end

    subgraph 松果云服务["松果云服务"]
        PineconeService[松果云服务]
        APIEndpoint[API端点]
    end

    UI --> Server
    Server --> PineconeIndexHandler
    PineconeIndexHandler --> PineconeService
    PineconeService --> APIEndpoint

快速开始指南

安装与运行

1. 使用以下命令安装服务器：

uv add mcp-pinecone@latest

2. 在项目目录中创建配置文件config.json，添加以下内容：

{
  "pinecone": {
    "indexName": "YOUR_INDEX_NAME",
    "apiKey": "YOUR_API_KEY"
  }
}

3. 启动服务器：

uv run mcp-pinecone

创建索引

使用以下命令创建新的松果云索引：

uv exec mcp-pinecone create-index --name my-index

项目开发

依赖管理与构建

1. 同步依赖项并更新锁文件：

uv sync

2. 构建发行版本：

uv build

3. 发布到PyPI：

uv publish

调试指南

由于MCP服务器通过标准输入输出运行，调试较为困难。推荐使用MCP Inspector进行调试。

安装Inspector并启动：

npx @modelcontextprotocol/inspector uv --directory {project_dir} run mcp-pinecone

许可证

本项目遵循MIT许可证，具体内容请参阅LICENSE文件。

源代码地址

源代码托管在GitHub。

贡献与反馈

欢迎通过Bluesky或提交问题的方式提供反馈和建议。