Skip to main content

Getting Started with the MCP Server

Beta Feature

The MCP Server is currently in beta. Features and configuration may change.

What is MCP?​

The Model Context Protocol (MCP) is an open standard that enables AI assistants to securely access external tools and data sources.

Vectorize's MCP server integrates with AI assistants like Claude to enable Vector Retrieval and Deep Research capabilities on your private data.

Prerequisites

Before you begin, you'll need:

  1. A Vectorize account
  2. An API access token (create one here)
  3. Your organization ID (see below)
  4. A pipeline ID (see below)

Finding your Organization ID

Your organization ID is in the Vectorize platform URL:

https://platform.vectorize.io/organization/[YOUR-ORG-ID]

For example, if your URL is:

https://platform.vectorize.io/organization/ecf3fa1d-30d0-4df1-8af6-f4852bc851cb

Your organization ID is: ecf3fa1d-30d0-4df1-8af6-f4852bc851cb

Finding your Pipeline ID

Navigate to your pipeline in the Vectorize platform. The pipeline ID is shown in:

  • The URL: https://platform.vectorize.io/organization/[org-id]/pipeline/[PIPELINE-ID]
  • The pipeline details page
  • The "Connect" tab of your pipeline

Configure Your AI Assistant​

Add this configuration to your MCP-compatible AI assistant:

{
  "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"
      }
    }
  }
}

Available Tools​

The Vectorize MCP server provides three powerful tools:

Search and retrieve relevant documents from your pipeline.

{
  "name": "retrieve",
  "arguments": {
    "question": "Financial health of the company",
    "k": 5
  }
}

Document Extraction​

Extract text from a document and chunk it into Markdown format.

{
  "name": "extract",
  "arguments": {
    "base64document": "base64-encoded-document",
    "contentType": "application/pdf"
  }
}

Deep Research​

Generate comprehensive research reports from your private data.

{
  "name": "deep-research",
  "arguments": {
    "query": "Generate a financial status report about the company",
    "webSearch": true
  }
}

Example Usage with Claude​

Here's an example of how to use the Vectorize MCP server with Claude:

  1. Configure the MCP server as shown above
  2. In your conversation with Claude, you can ask it to use the Vectorize tools:
Search information about our company's financial performance in Q2 2024 in Vectorize.

Claude will then use the MCP server to retrieve the relevant information and provide a response based on the retrieved data.

Next Steps​

Was this page helpful?