Pdfsearch Zed

🚀 PDF 搜索 for Zed

這是一個專為 Zed 設計的文檔搜索擴展，能對 PDF 文檔進行語義搜索，並將搜索結果提供給 Zed 的 AI 助手使用，極大提升了在 Zed 中查找文檔信息的效率。

🚀 快速開始

1. 克隆倉庫

git clone https://github.com/freespirit/pdfsearch-zed.git

2. 為 MCP 服務器設置 Python 環境

cd pdfsearch-zed/pdf_rag
uv venv
uv sync

3. 安裝開發擴展

將擴展安裝到 Zed。

4. 構建搜索數據庫

cd /path/to/pdfsearch-zed/pdf_rag

echo "OPENAI_API_KEY=sk-..." > src/pdf_rag/.env

# 根據文檔大小，這可能需要幾分鐘。
# 您可以提供多個文件和目錄作為參數。
# - 文件將被分塊處理。
# - 目錄中的文件被視為已分塊。
uv run src/pdf_rag/rag.py build "file1.pdf" "dir1" "file2.md" ...

5. 配置 Zed

"context_servers": {
    "pdfsearch-context-server": {
        "settings": {
            "extension_path": "/path/to/pdfsearch-zed"
        }
    }
}

✨ 主要特性

• 可對 PDF 文檔進行語義搜索，並將結果用於 Zed 的 AI 助手。
• 支持多個 PDF 文件，還可選支持除 PDF 以外的其他文件格式。
• 具備自包含向量存儲功能。

📦 安裝指南

先決條件

當前版本需要以下內容：

1. OpenAI API 鍵（用於生成嵌入）
2. 系統上已安裝 uv

⚠️ 重要提示

當前實現雖然需要 OpenAI API 鍵來生成嵌入，但我們計劃在未來版本中實現自包含替代方案。社區反饋將幫助我們優先改進。

💻 使用示例

基礎用法

1. 打開 Zed 的 AI 助手面板。
2. 輸入 /pdfsearch 加上您的搜索查詢。
3. 該擴展將搜索 PDF 並將相關部分添加到 AI 助手的上下文中。

📚 詳細文檔

未來改進

• [x] 自包含向量存儲
• [ ] 自包含嵌入
• [ ] 首次運行時自動構建索引
• [ ] 可配置結果大小
• [x] 支持多個 PDF 文件
• [x] 可選：除 PDF 以外的其他文件格式

項目結構

• pdf_rag/: 基於 Python 的 MCP 服務器實現。
• src/: Zed 擴展代碼。
• extension.toml 和 Cargo.toml: Zed 擴展配置文件。

已知限制

• 首次使用前需要手動構建索引。
• 需要外部服務（OpenAI）。