关于 vaiz
vaiz-mcp 是一个已归档、弃用的连接器,可让 AI 助手访问 Vaiz 工作区数据并执行任务操作。其文档涵盖任务搜索与管理,以及项目、看板、文档和里程碑;Vaiz 现已引导用户改用托管 MCP 服务。
主要功能
- 01搜索任务、项目和用户
- 02创建和编辑任务
- 03添加任务评论
- 04查看看板和项目
- 05访问文档和里程碑
适用场景
- 01搜索 Vaiz 工作区中的任务
- 02通过助手创建或更新任务
- 03查看项目看板和里程碑
MCP 相关
此弃用程序包曾通过本地进程和 API 令牌将 Cursor、Claude 等 MCP 客户端连接到 Vaiz。Vaiz 现提供带 OAuth 的托管 MCP 服务:https://api.vaiz.com/mcp。
配置
本地服务的配置在各客户端中通用,复制后粘贴到客户端的 MCP 配置文件即可。
工具
33收录的工具列表 · 更新于 2 周前
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
| limit | number | 否 | |
| query | string | 是 | |
| entityType | enum | 否 | task | project | user | comment | board | document |
详细介绍
vaiz-mcp
已弃用。 此软件包不再维护,且此代码库已归档。
Vaiz 现在提供带 OAuth 的托管 MCP 服务,地址为
https://api.vaiz.com/mcp。您不再需要本地npx代理或VAIZ_API_TOKEN。Cursor 用户: 从 Cursor Marketplace 安装官方 Vaiz 插件 — https://github.com/vaizcom/vaiz-cursor-plugin
任何 MCP 客户端: 直接连接到远程服务。
{ "mcpServers": { "Vaiz": { "url": "https://api.vaiz.com/mcp" } } }然后按提示进行身份验证(在 Cursor 中:Settings → Tools & MCPs → Authenticate)。
指南:https://vaiz.com/help/tutorials/how-to-connect-vaiz-to-mcp · 支持:https://vaiz.com/support
现有的
vaiz-mcp安装目前仍可继续使用,但不会收到更新或安全修复。请迁移。
以下保留原始文档以供参考。
Vaiz 的 MCP(Model Context Protocol)客户端 — 将 Cursor/Claude 连接到您的 Vaiz 工作区。
安装
npm install -g vaiz-mcp
或者通过 npx 直接使用:
npx vaiz-mcp
配置
环境变量
| 变量 | 必需 | 说明 |
|---|---|---|
VAIZ_API_TOKEN | 是 | 您的 Vaiz API 密钥(Bearer 令牌) |
VAIZ_SPACE_ID | 否 | 您的 Vaiz Space ID |
VAIZ_API_URL | 否 | MCP API URL(默认:https://api.vaiz.com/mcp) |
VAIZ_DEBUG | 否 | 设置为 true,将调试输出写入 stderr |
Cursor 配置
创建或编辑 ~/.cursor/mcp.json:
{
"mcpServers": {
"vaiz": {
"command": "npx",
"args": ["vaiz-mcp@latest"],
"env": {
"VAIZ_API_TOKEN": "your-api-key",
"VAIZ_SPACE_ID": "your-space-id"
}
}
}
}
或者在全局安装后(npm install -g vaiz-mcp):
{
"mcpServers": {
"vaiz": {
"command": "vaiz-mcp@latest",
"env": {
"VAIZ_API_TOKEN": "your-api-key",
"VAIZ_SPACE_ID": "your-space-id"
}
}
}
}
Claude Desktop 配置
添加到 claude_desktop_config.json:
{
"mcpServers": {
"vaiz": {
"command": "npx",
"args": ["vaiz-mcp@latest"],
"env": {
"VAIZ_API_TOKEN": "your-api-key",
"VAIZ_SPACE_ID": "your-space-id"
}
}
}
}
使用方法
完成配置后,Cursor/Claude 将自动连接到您的 Vaiz 工作区,并获得以下访问权限:
- 🔍 搜索任务、项目和用户
- 📋 任务管理(创建、编辑、评论)
- 📊 查看看板和项目
- 👥 团队成员信息
- 📝 处理文档和里程碑
调试
若要启用调试输出,请添加 VAIZ_DEBUG 变量:
{
"mcpServers": {
"vaiz": {
"command": "npx",
"args": ["vaiz-mcp@latest"],
"env": {
"VAIZ_API_TOKEN": "your-api-key",
"VAIZ_DEBUG": "true"
}
}
}
}
调试消息将输出到 stderr。
编程方式使用
您也可以通过编程方式使用此库:
import { createVaizMCPClient } from 'vaiz-mcp';
const client = createVaizMCPClient({
apiKey: 'your-api-key',
spaceId: 'your-space-id',
});
// Initialize connection
const initResult = await client.initialize();
// Get list of tools
const tools = await client.listTools();
// Call a tool
const result = await client.callTool('search', {
query: 'important task',
entityType: 'task'
});
开发
# Clone the repository
git clone https://github.com/vaiz/vaiz-mcp.git
cd vaiz-mcp
# Install dependencies
npm install
# Build the project
npm run build
# Run in development mode
npm run dev
平台
许可证
MIT
评论
一个开放协议,规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话,MCP 服务负责提供工具、资源和提示模板,两者通过标准消息通信,同一个服务可以被不同客户端复用。