Vectorize

🚀 Vectorize Configuration and Usage Guide in VS Code

This guide provides a detailed introduction to the installation, configuration, and usage of Vectorize in VS Code, as well as development and release processes.

📦 Installation

One-Click Installation

At the top of this section, there is a pair of "One-Click Installation" buttons. Clicking on them will quickly complete the installation.

Manual Installation

Add the following JSON code to your VS Code user settings (JSON) file. You can do this by pressing Ctrl + Shift + P and entering "Preferences: Open User Settings (JSON)".

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "org_id",
        "description": "Vectorize Organization ID"
      },
      {
        "type": "promptString",
        "id": "token",
        "description": "Vectorize Token",
        "password": true
      },
      {
        "type": "promptString",
        "id": "pipeline_id",
        "description": "Vectorize Pipeline 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}"
        }
      }
    }
  }
}

Workspace Configuration (Optional)

Create a file named .vscode/mcp.json in your workspace to share configurations with other users:

{
  "inputs": [
    {
      "type": "promptString",
      "id": "org_id",
      "description": "Vectorize Organization ID"
    },
    {
      "type": "promptString",
      "id": "token",
      "description": "Vectorize Token",
      "password": true
    },
    {
      "type": "promptString",
      "id": "pipeline_id",
      "description": "Vectorize Pipeline 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}"
      }
    }
  }
}

🛠️ Configuration Instructions

Configuration on 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"
      }
    }
  }
}

💻 Usage Examples

Document Retrieval

Perform a vector search and retrieve documents (refer to the official API):

{
  "name": "retrieve",
  "arguments": {
    "question": "The company's financial situation",
    "k": 5
  }
}

Multilingual Processing

Use the following commands for multilingual text processing (refer to the official API):

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

npx vectorize detect-language "Bonjour, le monde!"
# Output: French

npx vectorize sentence-similarity \
    --text1 "我今天天气不错。" \
    --text2 "今天阳光明媚。"
# Output: Similarity score

Document Processing Tools

Use the following commands to process documents (refer to the official API):

npx vectorize split-document --input-file ./example.pdf
# Split a PDF file into multiple text chunks

npx vectorize extract-entities --text "在 2023 年的全球峰会上，来自 50 多个国家的领导人齐聚一堂。"
# Extract entity information: locations, person names, organizations, etc.

🚧 Development and Release

Install Dependencies

Run the following command to install the dependencies required for development:

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

Run Examples

Create a package.json file in the project root directory with the following content:

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

Then run the following command to start the application:

npm run start

Release a Version

Follow these steps to release a version:

1. Update the version number in package.json.
2. Package and build:

   npm pack
   

3. Publish to the specified repository or distribution platform.

⚠️ Other Notes

⚠️ Important Note

• Ensure that the Node.js and npm pre - environments are installed.
• Replace the placeholders in the configuration file with actual values.
• Refer to the official documentation for detailed logs and error information.