使用说明
Supavec MCP服务器
A. 模型上下文协议（MCP） 服务器，使AI助手能够从中获取相关的嵌入和内容 Supavec.
特性
- 🔍 获取嵌入：使用嵌入从Supavec文件中搜索和检索相关内容
- 🤖 人工智能集成：适用于Cursor、Claude、VS Code Copilot和其他MCP兼容工具
- 🔑 灵活的身份验证：支持命令行参数和环境变量
- ⚡ 轻松设置：通过npx安装一个命令
安装
npx快速入门（推荐）
无需安装！直接与npx一起使用：
npx @supavec/mcp-server --api-key your_api_key
全球安装
npm install -g @supavec/mcp-server
supavec-mcp --api-key your_api_key
配置
光标
添加到您的 .cursor/mcp.json:
{
"mcpServers": {
"supavec": {
"command": "npx",
"args": [
"-y",
"@supavec/mcp-server@latest",
"--api-key",
"your_supavec_api_key"
]
}
}
}
VS代码（副本）
添加到您的 .vscode/mcp.json:
{
"servers": {
"supavec": {
"command": "npx",
"args": [
"-y",
"@supavec/mcp-server@latest",
"--api-key",
"your_supavec_api_key"
]
}
}
}
克劳德桌面
添加到您的Claude配置中：
{
"mcpServers": {
"supavec": {
"command": "npx",
"args": [
"-y",
"@supavec/mcp-server@latest",
"--api-key",
"your_supavec_api_key"
]
}
}
}
环境变量
或者，将API键设置为环境变量：
export SUPAVEC_API_KEY=your_supavec_api_key
然后在MCP配置中使用，无需 --api-key 论点：
{
"mcpServers": {
"supavec": {
"command": "npx",
"args": ["-y", "@supavec/mcp-server@latest"]
}
}
}
认证
获取API密钥
- 访问 Supavec
- 注册或登录您的帐户
- 导航到API设置
- 生成新的API密钥
使用优先级
服务器按以下顺序检查API密钥：
--api-key命令行参数（最高优先级）SUPAVEC_API_KEY环境变量
可用工具
fetch-embeddings
通过ID和查询获取文件的嵌入。
参数：
file_id（string，必填）：要获取嵌入的文件的IDquery（string，必填）：在文件中搜索的查询
例子：
Ask your AI assistant: "Using Supavec, find information about 'authentication' in file abc123"
list-user-files
列出当前用户上传到Supavec的所有文件。
参数：
limit（number，可选）：要获取的文件数（默认值：10）offset（数字，可选）：分页偏移量（默认值：0）order_dir（字符串，可选）：结果的排序方向-“asc”或“desc”（默认值：“desc“）
例子：
Ask your AI assistant: "List my Supavec files" or "Show me the first 20 files from my Supavec account"
答复包括：
- 文件ID和名称
- 文件类型和创建日期
- 团队ID
- 分页信息
命令行用法
帮助
supavec-mcp --help
使用API密钥
supavec-mcp --api-key your_api_key_here
带环境变量
export SUPAVEC_API_KEY=your_api_key_here
supavec-mcp
例子
与光标一起使用
- 在中配置Supavec MCP
.cursor/mcp.json - 打开Cursor并开始新的聊天
- 问： “在我的Supavec文件xyz789中搜索‘数据库设置’信息”
- AI将使用Supavec MCP获取相关内容
与克劳德一起使用
- 在Claude设置中配置Supavec MCP
- 在对话中，问： “在文件abc123中查找有关API终结点的文档”
- Claude将搜索您的Supavec文件并返回相关信息
故障排除
常见问题
“错误：需要Supavec API密钥”
- 确保您已通过提供API密钥
--api-key或SUPAVEC_API_KEY环境变量
“无法获取数据：状态401”
- 您的API密钥可能无效或已过期。检查您的Supavec帐户设置
“无法获取数据：状态404”
- 文件ID可能不存在，或者您可能无法访问它
调试模式
使用环境变量运行以查看更多详细信息：
DEBUG=1 supavec-mcp --api-key your_key
发展
需求
- Node.js 16.0.0或更高版本
- TypeScript
设置
git clone https://github.com/supavec/mcp-server.git
cd supavec-mcp-server
npm install
npm run build
测试
# Test with MCP Inspector
npm run inspector
# Test command line
npm run build
node build/index.js --help
贡献
- 分叉存储库
- 创建要素分支：
git checkout -b feature-name - 进行更改并添加测试
- 提交您的更改：
git commit -am 'Add feature' - 推到分支：
git push origin feature-name - 提交拉取请求
许可证
MIT许可证-请参阅 许可证 了解详情。
