🚀 Vectorize 在 VS Code 中的配置与使用指南

本指南将详细介绍如何在 VS Code 中配置和使用 Vectorize，帮助你快速上手并高效使用该工具。

🚀 快速开始

✨ 主要特性

• 支持一键安装和手动安装两种方式，方便不同需求的用户。
• 可在多个平台（Claude/Windsurf/Cursor/Cline）上进行配置。
• 提供多种工具功能，如文档检索、多语言处理和文档处理等。

📦 安装指南

使用一键安装按钮

在本节顶部有一对“一键安装”按钮，点击即可快速完成安装。

手动安装

将以下 JSON 代码添加到 VS Code 的用户设置（JSON）文件中。可以通过按 Ctrl + Shift + P 并输入“首选项：打开用户设置 (JSON)”来实现。

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "org_id",
        "description": "Vectorize 组织 ID"
      },
      {
        "type": "promptString",
        "id": "token",
        "description": "Vectorize Token",
        "password": true
      },
      {
        "type": "promptString",
        "id": "pipeline_id",
        "description": "Vectorize 管道 ID"
      }
    ],
    "servers": {
      "vectorize": {
        "command": "npx",
        "args": ["-y", "@vectorize-io/vectorize-mcp-server@latest"],
        "env": {
          "VECTORIZE_ORG_ID": "${input:org_id}",
          "VECTORIZE_TOKEN": "${input:token}",
          "VECTORIZE_PIPELINE_ID": "${input:pipeline_id}"
        }
      }
    }
  }
}

工作区配置（可选）

在工作区中创建一个名为 .vscode/mcp.json 的文件，与其他用户共享配置：

{
  "inputs": [
    {
      "type": "promptString",
      "id": "org_id",
      "description": "Vectorize 组织 ID"
    },
    {
      "type": "promptString",
      "id": "token",
      "description": "Vectorize Token",
      "password": true
    },
    {
      "type": "promptString",
      "id": "pipeline_id",
      "description": "Vectorize 管道 ID"
    }
  ],
  "servers": {
    "vectorize": {
      "command": "npx",
      "args": ["-y", "@vectorize-io/vectorize-mcp-server@latest"],
      "env": {
        "VECTORIZE_ORG_ID": "${input:org_id}",
        "VECTORIZE_TOKEN": "${input:token}",
        "VECTORIZE_PIPELINE_ID": "${input:pipeline_id}"
      }
    }
  }
}

📚 详细文档

配置说明

在 Claude/Windsurf/Cursor/Cline 上配置：

{
  "mcpServers": {
    "vectorize": {
      "command": "npx",
      "args": ["-y", "@vectorize-io/vectorize-mcp-server@latest"],
      "env": {
        "VECTORIZE_ORG_ID": "your-org-id",
        "VECTORIZE_TOKEN": "your-token",
        "VECTORIZE_PIPELINE_ID": "your-pipeline-id"
      }
    }
  }
}

💻 使用示例

基础用法

检索文档

执行向量搜索并检索文档（参考官方 API）：

{
  "name": "retrieve",
  "arguments": {
    "question": "公司的财务状况",
    "k": 5
  }
}

高级用法

多语言处理

使用以下命令进行多语言文本处理（参考官方 API）：

npx vectorize translate --source-lang zh --target-lang en "你好，世界！"
# 输出：Hello, world!

npx vectorize detect-language "Bonjour, le monde!"
# 输出：法语

npx vectorize sentence-similarity \
    --text1 "我今天天气不错。" \
    --text2 "今天阳光明媚。"
# 输出：相似度分数

文档处理工具

使用以下命令对文档进行处理（参考官方 API）：

npx vectorize split-document --input-file ./example.pdf
# 将 PDF 文件分割成多个文本块

npx vectorize extract-entities --text "在 2023 年的全球峰会上，来自 50 多个国家的领导人齐聚一堂。"
# 提取实体信息：地点、人名、组织等

🔧 技术细节

开发与发布

安装依赖

运行以下命令安装开发所需的依赖项：

npm install @vectorize/core @vectorize/mcp-server

运行示例

在项目根目录下创建一个 package.json 文件，内容如下：

{
  "name": "vectorize-app",
  "version": "1.0.0",
  "scripts": {
    "start": "node index.js"
  }
}

然后运行以下命令启动应用：

npm run start

发布版本

按照以下步骤进行发布：

1. 更新 package.json 中的版本号
2. 打包构建：

   npm pack
   

3. 发布到指定仓库或分发平台

📄 许可证

文档未提及许可证相关信息，暂不展示。

其他注意事项

⚠️ 重要提示

• 确保安装 Node.js 和 npm 前置环境
• 配置文件中的占位符需要替换为实际值
• 详细日志和错误信息请参考官方文档