Chatwoot API工具集

一个基于Model Context Protocol (MCP)的服务器,提供Chatwoot API的全部功能,包括129个工具,适用于AI助手如Claude、VS Code Copilot等。

  • by fazer-ai
  • TypeScript
  • 本地部署
  • 12 星标
  • 更新于
在 GitHub 查看 fazer-ai/mcp-chatwoot

使用说明

@做-ai/mcp-chatwoot

A. 模型上下文协议 (MCP)服务器,公开完整 查特沃特 API-包括 做.ai 独家功能——如 129工具 适用于Claude、VS Code Copilot等人工智能助手。

特性

  • 129工具 覆盖所有Chatwoot API端点
  • 帐户、代理、联系人、对话、消息、收件箱、团队等
  • 报告(v1和v2)、帮助中心、自动化规则、自定义属性、自定义筛选器
  • [专属] Exclusive:看板、看板步骤、看板任务、看板审核事件、看板偏好、计划消息
  • 正确的MCP工具注释(readOnlyHint, destructiveHint, idempotentHint)
  • 多账户支持(account_id 是每个工具的参数)
  • stdio传输(与Claude Desktop、VS Code和任何MCP客户端兼容)

需求

  • 包子 v1.0+
  • 具有API访问权限的Chatwoot实例

安装

bun install

环境变量

变量 必填 描述
CHATWOOT_BASE_URL 是 您的Chatwoot实例URL(例如。 https://app.chatwoot.com)
CHATWOOT_API_TOKEN 是 API访问令牌(在Chatwoot中找到→ 个人资料→ 访问令牌)

用法

发展

bun run dev

生产

bun run start

Claude桌面配置

添加到您的 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代码配置

添加到您的 .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"
      }
    }
  }
}

可用工具(129)

账户(2)

account_get, account_update

代理机器人(5)

agent_bots_list, agent_bots_create, agent_bots_get, agent_bots_update, agent_bots_delete

代理商(4)

agents_list, agents_create, agents_update, agents_delete

审计日志(1)

audit_logs_list

自动化规则(5)

automation_rules_list, automation_rules_create, automation_rules_get, automation_rules_update, automation_rules_delete

罐装回复(4)

canned_responses_list, canned_responses_create, canned_responses_update, canned_responses_delete

联系人(11)

contacts_list, contacts_create, contacts_get, contacts_update, contacts_delete, contacts_conversations, contacts_search, contacts_filter, contacts_create_contact_inbox, contacts_contactable_inboxes, contacts_merge

联系人标签(2)

contact_labels_list, contact_labels_set

对话(12)

conversations_meta, conversations_list, conversations_create, conversations_filter, conversations_get, conversations_update, conversations_toggle_status, conversations_toggle_priority, conversations_set_custom_attributes, conversations_get_labels, conversations_set_labels, conversations_reporting_events

会话作业(1)

conversation_assignments_assign

留言(3)

messages_list, messages_create, messages_delete

自定义属性(5)

custom_attributes_list, custom_attributes_create, custom_attributes_get, custom_attributes_update, custom_attributes_delete

自定义过滤器(5)

custom_filters_list, custom_filters_create, custom_filters_get, custom_filters_update, custom_filters_delete

帮助中心(5)

help_center_portals_list, help_center_portals_create, help_center_portals_update, help_center_categories_create, help_center_articles_create

收件箱(11)

inboxes_list, inboxes_get, inboxes_create, inboxes_update, inboxes_get_agent_bot, inboxes_set_agent_bot, inbox_members_list, inbox_members_create, inbox_members_update, inbox_members_delete

集成(4)

integrations_list_apps, integrations_create_hook, integrations_update_hook, integrations_delete_hook

简介(1)

profile_get

报告(9)

reports_account_overview, reports_account_summary, reports_agent_summary, reports_conversation_metrics, reports_v2_overview, reports_v2_agents, reports_v2_inboxes, reports_v2_teams, reports_v2_labels

团队(9)

teams_list, teams_create, teams_get, teams_update, teams_delete, team_members_list, team_members_add, team_members_update, team_members_delete

Webhooks(4)

webhooks_list, webhooks_create, webhooks_update, webhooks_delete

看板(9)--[fazer.ai]

kanban_boards_list, kanban_boards_create, kanban_boards_get, kanban_boards_update, kanban_boards_delete, kanban_boards_get_automation_settings, kanban_boards_update_automation_settings, kanban_boards_get_members, kanban_boards_set_members

看板步骤(5)--[fazer.ai]

kanban_steps_list, kanban_steps_create, kanban_steps_get, kanban_steps_update, kanban_steps_delete

看板任务(7)--[fazer.ai]

kanban_tasks_list, kanban_tasks_create, kanban_tasks_get, kanban_tasks_update, kanban_tasks_delete, kanban_tasks_move

看板审核事件(2)--[fazer.ai]

kanban_audit_events_list, kanban_audit_events_get

看板首选项(1)--[fazer.ai]

kanban_preferences_get

预定消息(4)--[fazer.ai]

scheduled_messages_list, scheduled_messages_create, scheduled_messages_update, scheduled_messages_delete

发展

# Run tests
bun test

# Lint & format
bun run lint
bun run format

# Type check
bun run build-check

# Full check (lint + type-check + tests)
bun run check

许可证

麻省理工学院