com.vaiz/mcp

السجل الرسمي مؤرشف الإنتاجية

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

التثبيت

أضف هذا إلى إعدادات MCP في عميلك (Claude Desktop: claude_desktop_config.json، وCursor: ‏.cursor/mcp.json، ويستخدم VS Code وغيره الصيغة نفسها «mcpServers»).

NPM package vaiz-mcp
Claude Code
claude mcp add com-vaiz-mcp -e 'VAIZ_API_TOKEN=<your vaiz_api_token>' -e 'VAIZ_SPACE_ID=<VAIZ_SPACE_ID>' -e 'VAIZ_API_URL=<VAIZ_API_URL>' -- npx -y vaiz-mcp@1.1.2
إعداد JSON (Claude Desktop وCursor وVS Code)
{
    "mcpServers": {
        "com-vaiz-mcp": {
            "command": "npx",
            "args": [
                "-y",
                "vaiz-mcp@1.1.2"
            ],
            "env": {
                "VAIZ_API_TOKEN": "<your vaiz_api_token>",
                "VAIZ_SPACE_ID": "<VAIZ_SPACE_ID>",
                "VAIZ_API_URL": "<VAIZ_API_URL>"
            }
        }
    }
}

متغيرات البيئة

  • VAIZ_API_TOKEN إلزامي سري Your Vaiz API key (Bearer token)
  • VAIZ_SPACE_ID Your Vaiz Space ID
  • VAIZ_API_URL Vaiz MCP API URL (default: https://api.vaiz.com/mcp)

التوثيق

مأخوذ من ملف README للمشروع على GitHub ويُحدَّث أسبوعيًا. تفتح الروابط على GitHub.

المحتويات
  1. vaiz-mcp
  2. Installation
  3. Configuration
  4. Usage
  5. Debugging
  6. Programmatic Usage
  7. Development
  8. Platforms
  9. License

vaiz-mcp

DEPRECATED. This package is no longer maintained and this repository is archived.

Vaiz now provides a hosted MCP server at https://api.vaiz.com/mcp with OAuth. You no longer need a local npx proxy or a VAIZ_API_TOKEN.

Cursor users: install the official Vaiz plugin from the Cursor Marketplace — https://github.com/vaizcom/vaiz-cursor-plugin

Any MCP client: point it at the remote server directly.

{
  "mcpServers": {
    "Vaiz": { "url": "https://api.vaiz.com/mcp" }
  }
}

Then authenticate when prompted (in Cursor: Settings → Tools & MCPs → Authenticate).

Guide: https://vaiz.com/help/tutorials/how-to-connect-vaiz-to-mcp · Support: https://vaiz.com/support

Existing installations of vaiz-mcp keep working for now, but will not receive updates or security fixes. Please migrate.


The original documentation is kept below for reference.

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

License

MIT

الأسئلة الشائعة

ما هو com.vaiz/mcp؟

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

كيف أثبّت com.vaiz/mcp؟

يعمل على جهازك. في Claude Code: claude mcp add com-vaiz-mcp -e 'VAIZ_API_TOKEN=<your vaiz_api_token>' -e 'VAIZ_SPACE_ID=<VAIZ_SPACE_ID>' -e 'VAIZ_API_URL=<VAIZ_API_URL>' -- npx -y vaiz-mcp@1.1.2. وفي العملاء الآخرين، الصق إعداد JSON من هذه الصفحة في إعدادات MCP الخاصة بهم.

هل يحتاج com.vaiz/mcp إلى مفتاح API؟

نعم. يتطلب VAIZ_API_TOKEN، وتضبطها في إعداداته.

هل com.vaiz/mcp مفتوح المصدر؟

نعم. شيفرته متاحة على GitHub بترخيص MIT.

من يصون com.vaiz/mcp؟

ينشره vaizcom. يدرجه AI.tn لكنه لا يصونه ولا يوصي به.

من سجل MCP الرسمي. الإدراج ليس توصية: راجع شيفرة الخادم وصلاحياته قبل منحه الوصول إلى بياناتك.