FA

fazer-ai/mcp-chatwoot

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

12 stars 12 forks 质量 66 趋势 19MIT

MCP server for Chatwoot (TypeScript + Bun)

概览

A Model Context Protocol (MCP) server that exposes the full Chatwoot API — including fazer.ai exclusive features — as for use with AI assistants like Claude, VS Code Copilot, and others. - covering all Chatwoot API endpoints - Account, Agents, Contacts, Conversations, Messages, Inboxes, Teams, and more - Reports (v1 & v2), Help Center, Automation Rules, Custom Attributes, Custom Filters - : Kanban Boards, Kanban Steps, Kanban Tasks, Kanban Audit Events, Kanban Preferences, Scheduled Messages - Proper MCP tool annotations (readOnlyHint, destructiveHint, idempotentHint) - Multi-account support (account_id is a per-tool argument) - stdio transport (compatible with Claude Desktop, VS Code, and any MCP client) - Bun v1.

README

以下为原文 README 节选,完整内容请查看原文。

@fazer-ai/mcp-chatwoot

A Model Context Protocol (MCP) server that exposes the full Chatwoot API — including fazer.ai exclusive features — as 129 tools for use with AI assistants like Claude, VS Code Copilot, and others.

Features

  • 129 tools covering all Chatwoot API endpoints
  • Account, Agents, Contacts, Conversations, Messages, Inboxes, Teams, and more
  • Reports (v1 & v2), Help Center, Automation Rules, Custom Attributes, Custom Filters
  • [fazer.ai] exclusive: Kanban Boards, Kanban Steps, Kanban Tasks, Kanban Audit Events, Kanban Preferences, Scheduled Messages
  • Proper MCP tool annotations (readOnlyHint, destructiveHint, idempotentHint)
  • Multi-account support (account_id is a per-tool argument)
  • stdio transport (compatible with Claude Desktop, VS Code, and any MCP client)

Requirements

  • Bun v1.0+
  • A Chatwoot instance with API access

Installation

bun install

Environment Variables

Variable Required Description
CHATWOOT_BASE_URL Yes Your Chatwoot instance URL (e.g. https://app.chatwoot.com)
CHATWOOT_API_TOKEN Yes API access token (found in Chatwoot → Profile → Access Token)

Usage

Development

bun run dev

Production

bun run start

Claude Desktop Configuration

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "chatwoot": {
      "command": "bun",
      "args": ["run", "/path/to/mcp-chatwoot/src/index.ts"],
      "env": {
        "CHATWOOT_BASE_URL": "https://your-chatwoot-instance.com",
        "CHATWOOT_API_TOKEN": "your-api-token"
      }
    }
  }
}

VS Code Configuration

Add to your .vscode/mcp.json:

{
  "servers": {
    "chatwoot": {
      "command": "bun",
      "args": ["run", "${workspaceFolder}/src/index.ts"],
      "env": {
        "CHATWOOT_BASE_URL": "https://your-chatwoot-instance.com",
        "CHATWOOT_API_TOKEN": "your-api-token"
      }
    }
  }
}

Available Tools (129)

Account (2)

account_get, account_update

Agent Bots (5)

agent_bots_list, agent_bots_create, agent_bots_get, agent_bots_update, agent_bots_delete

Agents (4)

agents_list, agents_create, agents_update, agents_delete

Audit Logs (1)

audit_logs_list

Automation Rules (5)

automation_rules_list, automation_rules_create, automation_rules_get, automation_rules_update, automation_rules_delete

在 GitHub 查看完整 README

安装

This server does not publish a one-line install command.

Open the repository installation guide 新手?先看 mcpskill.org 教程 →

配置

{ "mcpServers": { "chatwoot": { "command": "bun", "args": ["run", "/path/to/mcp-chatwoot/src/index.ts"], "env": { "CHATWOOT_BASE_URL": "https://your-chatwoot-instance.com", "CHATWOOT_API_TOKEN": "your-api-token" } } } }