com.vaiz/mcp

Connect AI assistants to your Vaiz workspace: tasks, projects, boards, documents and milestones.

AI & MLTypeScriptv1.1.2

vaiz-mcp

smithery badge

MCP (Model Context Protocol) client for Vaiz — connect Cursor/Claude to your Vaiz workspace.

Installation

npm install -g vaiz-mcp

Or use directly via npx:

npx vaiz-mcp

Configuration

Environment Variables

VariableRequiredDescription
VAIZ_API_TOKENYesYour Vaiz API key (Bearer token)
VAIZ_SPACE_IDNoYour Vaiz Space ID
VAIZ_API_URLNoMCP API URL (default: https://api.vaiz.com/mcp)
VAIZ_DEBUGNoSet to true for debug output to stderr

Cursor Configuration

Create or edit ~/.cursor/mcp.json:

{
  "mcpServers": {
    "vaiz": {
      "command": "npx",
      "args": ["vaiz-mcp@latest"],
      "env": {
        "VAIZ_API_TOKEN": "your-api-key",
        "VAIZ_SPACE_ID": "your-space-id"
      }
    }
  }
}

Or after global installation (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 Configuration

Add to 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"
      }
    }
  }
}

Usage

After configuration, Cursor/Claude will automatically connect to your Vaiz workspace and gain access to:

  • 🔍 Search tasks, projects, users
  • 📋 Task management (create, edit, comments)
  • 📊 View boards and projects
  • 👥 Team member information
  • 📝 Work with documents and milestones

Debugging

To enable debug output, add the VAIZ_DEBUG variable:

{
  "mcpServers": {
    "vaiz": {
      "command": "npx",
      "args": ["vaiz-mcp@latest"],
      "env": {
        "VAIZ_API_TOKEN": "your-api-key",
        "VAIZ_DEBUG": "true"
      }
    }
  }
}

Debug messages will be output to stderr.

Programmatic Usage

You can also use the library programmatically:

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' 
});

Development

# 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

Platforms

LobeHub

License

MIT

Installation

Source-derived launch command. Check the maintainer’s required arguments and credentials before running:

bash
npx -y vaiz-mcp

Set up in your AI client

Merge this template into ~/Library/Application Support/Claude/claude_desktop_config.json. Keep existing servers. Add any arguments, credentials, and permissions required by the maintainer; this template has not been install-tested.

json
{
  "mcpServers": {
    "com-vaiz-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "vaiz-mcp"
      ]
    }
  }
}

Restart Claude Desktop completely for changes to take effect. Confirm the server appears connected in the client’s tool list, then try a read-only example from its documentation.

Claude Desktop setup reference

Package

vaiz-mcpnpm

Compatible MCP Clients

com.vaiz/mcp works with any MCP-compatible client. Copy the config snippet from the Configuration section above and add it to the file shown for your client, then restart the application.

  • Claude Desktop~/Library/Application Support/Claude/claude_desktop_config.jsonRestart Claude Desktop completely for changes to take effect.
  • Cursor~/.cursor/mcp.jsonRestart Cursor for changes to take effect.
  • VS Code.vscode/mcp.jsonReload VS Code window for changes to take effect.
  • Windsurf~/.codeium/windsurf/mcp_config.jsonRestart Windsurf for changes to take effect.
  • Claude Code.mcp.jsonSave at the project root, then start Claude Code in that project and review the MCP server approval prompt. Keep real credentials out of shared files.

Learn More