Supavec MCP Server
Enables fetching relevant content and embeddings from Supavec via the Model Context Protocol, allowing AI assistants like Claude to access vector search capabilities.
README Documentation
Supavec MCP Server
A Model Context Protocol (MCP) server that enables AI assistants to fetch relevant embeddings and content from Supavec.
Features
- 🔍 Fetch Embeddings: Search and retrieve relevant content from Supavec files using embeddings
- 🤖 AI Integration: Works with Cursor, Claude, VS Code Copilot, and other MCP-compatible tools
- 🔑 Flexible Authentication: Support for both command-line arguments and environment variables
- ⚡ Easy Setup: One-command installation via npx
Installation
Quick Start with npx (Recommended)
No installation required! Use directly with npx:
npx @supavec/mcp-server --api-key your_api_key
Global Installation
npm install -g @supavec/mcp-server
supavec-mcp --api-key your_api_key
Configuration
Cursor
Add to your .cursor/mcp.json
:
{
"mcpServers": {
"supavec": {
"command": "npx",
"args": [
"-y",
"@supavec/mcp-server@latest",
"--api-key",
"your_supavec_api_key"
]
}
}
}
VS Code (Copilot)
Add to your .vscode/mcp.json
:
{
"servers": {
"supavec": {
"command": "npx",
"args": [
"-y",
"@supavec/mcp-server@latest",
"--api-key",
"your_supavec_api_key"
]
}
}
}
Claude Desktop
Add to your Claude configuration:
{
"mcpServers": {
"supavec": {
"command": "npx",
"args": [
"-y",
"@supavec/mcp-server@latest",
"--api-key",
"your_supavec_api_key"
]
}
}
}
Environment Variables
Alternatively, set your API key as an environment variable:
export SUPAVEC_API_KEY=your_supavec_api_key
Then use in your MCP configuration without the --api-key
argument:
{
"mcpServers": {
"supavec": {
"command": "npx",
"args": ["-y", "@supavec/mcp-server@latest"]
}
}
}
Authentication
Get Your API Key
- Visit Supavec
- Sign up or log in to your account
- Navigate to your API settings
- Generate a new API key
Usage Priority
The server checks for API keys in this order:
--api-key
command line argument (highest priority)SUPAVEC_API_KEY
environment variable
Available Tools
fetch-embeddings
Fetch embeddings for a file by ID and query.
Parameters:
file_id
(string, required): ID of the file to get embeddings forquery
(string, required): Query to search for in the file
Example:
Ask your AI assistant: "Using Supavec, find information about 'authentication' in file abc123"
list-user-files
List all files uploaded to Supavec for the current user.
Parameters:
limit
(number, optional): Number of files to fetch (default: 10)offset
(number, optional): Offset for pagination (default: 0)order_dir
(string, optional): Order direction for results - "asc" or "desc" (default: "desc")
Example:
Ask your AI assistant: "List my Supavec files" or "Show me the first 20 files from my Supavec account"
Response includes:
- File ID and name
- File type and creation date
- Team ID
- Pagination information
Command Line Usage
Help
supavec-mcp --help
With API Key
supavec-mcp --api-key your_api_key_here
With Environment Variable
export SUPAVEC_API_KEY=your_api_key_here
supavec-mcp
Examples
Using with Cursor
- Configure Supavec MCP in
.cursor/mcp.json
- Open Cursor and start a new chat
- Ask: "Search for 'database setup' information in my Supavec file xyz789"
- The AI will use the Supavec MCP to fetch relevant content
Using with Claude
- Configure Supavec MCP in Claude settings
- In a conversation, ask: "Find documentation about API endpoints in file abc123"
- Claude will search your Supavec files and return relevant information
Troubleshooting
Common Issues
"Error: Supavec API key is required"
- Ensure you've provided an API key via
--api-key
orSUPAVEC_API_KEY
environment variable
"Failed to fetch data: status 401"
- Your API key may be invalid or expired. Check your Supavec account settings
"Failed to fetch data: status 404"
- The file ID may not exist or you may not have access to it
Debug Mode
Run with environment variables to see more details:
DEBUG=1 supavec-mcp --api-key your_key
Development
Requirements
- Node.js 16.0.0 or higher
- TypeScript
Setup
git clone https://github.com/supavec/mcp-server.git
cd supavec-mcp-server
npm install
npm run build
Testing
# Test with MCP Inspector
npm run inspector
# Test command line
npm run build
node build/index.js --help
Contributing
- Fork the repository
- Create a feature branch:
git checkout -b feature-name
- Make your changes and add tests
- Commit your changes:
git commit -am 'Add feature'
- Push to the branch:
git push origin feature-name
- Submit a pull request
License
MIT License - see LICENSE for details.