Skip to main content
Glama
Chatwoot MCP Server

Chatwoot MCP Server

by mohnori

Chatwoot MCP Server

License: MIT Node.js TypeScript

A Model Context Protocol (MCP) server that connects AI assistants like Claude to your Chatwoot instance. Manage customer conversations, read messages, send replies, and filter by date ranges -- all through natural language.

Features

  • 5 MCP Tools - List, filter, and inspect conversations; read and send messages

  • Advanced Filtering - Filter conversations by date range, status, assignee, inbox, and labels

  • Dual Authentication - API token (recommended) or JWT email/password

  • Type-Safe - Built with TypeScript and OpenAPI-generated types

  • Dual Output - Markdown (human-readable) and JSON (machine-readable) response formats

Related MCP server: aws-mcp

Tools

Tool

Description

chatwoot_list_conversations

List conversations with status, assignee, and inbox filters

chatwoot_get_conversation

Get full details for a specific conversation

chatwoot_list_messages

List all messages in a conversation

chatwoot_create_message

Send a reply or create an internal note

chatwoot_filter_conversations

Filter by date range, status, assignee, inbox, and labels

Quick Start

Prerequisites

  • Node.js >= 18

  • A Chatwoot account with API access

Install

git clone https://github.com/mohnori/chatwoot-mcp.git
cd chatwoot-mcp
npm install
npm run build

Configure

Copy the example environment file and fill in your credentials:

cp .env.example .env

Edit .env:

CHATWOOT_BASE_URL="https://your-chatwoot-instance.com"
CHATWOOT_API_TOKEN="your_api_token_here"
CHATWOOT_ACCOUNT_ID="your_account_id_here"

Getting your API token:

  1. Log in to Chatwoot

  2. Click your avatar → Profile Settings

  3. Scroll to the bottom → copy your Access Token

Getting your account ID: Your account ID is the number in the URL when you're logged in: app.chatwoot.com/app/accounts/<ID>/...

Run

npm start

MCP Configuration

Claude Code

claude mcp add chatwoot \
  -e CHATWOOT_BASE_URL="https://your-chatwoot-instance.com" \
  -e CHATWOOT_API_TOKEN="your_api_token" \
  -e CHATWOOT_ACCOUNT_ID="your_account_id" \
  -- node /path/to/chatwoot-mcp/dist/index.js

Replace /path/to/chatwoot-mcp with the actual path where you cloned the repository.

Claude Desktop

Add to your Claude Desktop configuration file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json

  • Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "chatwoot": {
      "command": "node",
      "args": ["/path/to/chatwoot-mcp/dist/index.js"],
      "env": {
        "CHATWOOT_BASE_URL": "https://your-chatwoot-instance.com",
        "CHATWOOT_API_TOKEN": "your_api_token_here",
        "CHATWOOT_ACCOUNT_ID": "your_account_id_here"
      }
    }
  }
}

Replace /path/to/chatwoot-mcp with the actual path where you cloned the repository. On Windows, use double backslashes: "C:\\Users\\you\\chatwoot-mcp\\dist\\index.js"

Environment Variables

Variable

Required

Description

CHATWOOT_BASE_URL

Yes

Your Chatwoot instance URL (no trailing slash)

CHATWOOT_ACCOUNT_ID

Yes

Your Chatwoot account ID (numeric)

CHATWOOT_API_TOKEN

Yes*

API access token (recommended method)

CHATWOOT_EMAIL

Yes*

Email for JWT auth (alternative method)

CHATWOOT_PASSWORD

No

Password for JWT auth (needed for token refresh)

*Either CHATWOOT_API_TOKEN or CHATWOOT_EMAIL is required.

Tools Reference

chatwoot_list_conversations

List conversations from an account with optional filters.

Parameter

Type

Required

Default

Description

status

string

No

"open"

"open", "resolved", "pending", "snoozed", or "all"

assignee_type

string

No

-

"me", "unassigned", or "all"

inbox_id

number

No

-

Filter by inbox ID

page

number

No

1

Page number

response_format

string

No

"markdown"

"markdown" or "json"

chatwoot_get_conversation

Get detailed information about a specific conversation.

Parameter

Type

Required

Description

conversation_id

number

Yes

Conversation ID

response_format

string

No

"markdown" or "json"

chatwoot_list_messages

List all messages in a conversation.

Parameter

Type

Required

Description

conversation_id

number

Yes

Conversation ID

response_format

string

No

"markdown" or "json"

chatwoot_create_message

Send a message or create an internal note in a conversation.

Parameter

Type

Required

Default

Description

conversation_id

number

Yes

-

Conversation ID

content

string

Yes

-

Message content

message_type

string

No

"outgoing"

"outgoing" or "incoming"

private

boolean

No

false

true for internal notes

chatwoot_filter_conversations

Filter conversations using advanced criteria. Uses Chatwoot's POST filter API with support for date ranges, status, assignee, inbox, and labels. Returns 25 results per page.

Parameter

Type

Required

Description

date_from

string

No

Created after this date (YYYY-MM-DD)

date_to

string

No

Created before this date (YYYY-MM-DD)

activity_from

string

No

Last activity after this date (YYYY-MM-DD)

activity_to

string

No

Last activity before this date (YYYY-MM-DD)

status

string

No

"open", "resolved", "pending", or "snoozed"

assignee_id

number

No

Filter by assignee agent ID

inbox_id

number

No

Filter by inbox ID

label

string

No

Filter by label name

page

number

No

Page number (default: 1)

response_format

string

No

"markdown" or "json"

Date filter behavior: Date boundaries are exclusive. To get conversations for a single day like Feb 21, use date_from="2026-02-20" and date_to="2026-02-22".

Example Queries

Once connected, you can ask Claude things like:

  • "Show me all open conversations"

  • "What are the details of conversation #123?"

  • "List all messages in conversation #456"

  • "Send a reply to conversation #789 saying 'Thank you for contacting us!'"

  • "Add an internal note to conversation #101 about the customer's issue"

  • "Find all conversations created on Feb 21"

  • "Show me resolved conversations from last week with the label 'urgent'"

Development

Project Structure

chatwoot-mcp/
├── src/
│   ├── index.ts                  # MCP server entry point & tool registration
│   ├── constants.ts              # Shared constants and enums
│   ├── chatwoot-types.ts         # Auto-generated OpenAPI types
│   ├── services/
│   │   ├── chatwoot-client.ts    # API client with auth middleware
│   │   ├── chatwoot-auth.ts      # JWT authentication
│   │   ├── token-cache.ts        # JWT token persistence
│   │   └── error-handler.ts      # Error formatting utilities
│   ├── schemas/
│   │   └── common.ts             # Shared Zod validation schemas
│   └── tools/
│       ├── conversations.ts      # List & get conversation tools
│       ├── messages.ts           # List & create message tools
│       └── filter-conversations.ts  # Advanced conversation filtering
├── test/
│   ├── chatwoot-client.test.ts   # Integration tests
│   ├── setup.ts                  # Test environment setup
│   └── unit/                     # Unit tests (mocked, no API calls)
│       ├── error-handler.test.ts
│       ├── build-filter-payload.test.ts
│       ├── conversations.test.ts
│       ├── messages.test.ts
│       ├── filter-conversations.test.ts
│       ├── schemas.test.ts
│       ├── chatwoot-auth.test.ts
│       └── token-cache.test.ts
├── .env.example                  # Environment variable template
├── package.json
├── tsconfig.json
└── vitest.config.ts

Scripts

Command

Description

npm run build

Compile TypeScript to dist/

npm start

Run the compiled server

npm run dev

Run in development mode with auto-reload

npm test

Run integration tests

npm run test:watch

Run tests in watch mode

npm run clean

Remove the dist/ directory

npm run generate-types

Regenerate OpenAPI types from swagger.json

Regenerating Types

If the Chatwoot API changes, download the latest OpenAPI spec and regenerate types:

  1. Download swagger.json from your Chatwoot instance at /swagger/v1/swagger.json

  2. Place it in the project root

  3. Run npm run generate-types

Running Tests

Unit tests run without any credentials. Integration tests require a real Chatwoot instance:

# Unit tests only (no credentials needed)
npm test -- test/unit/

# All tests (requires .env with valid credentials)
cp .env.example .env
# Edit .env with your credentials
npm test

Troubleshooting

API Token Returns 401

If using a self-hosted Chatwoot with nginx, add this to your nginx config:

server {
    underscores_in_headers on;  # Required for api_access_token header
}

JWT Tokens Expire

JWT tokens expire (typically after 2 weeks). Keep CHATWOOT_PASSWORD in your .env for automatic refresh, or switch to API token authentication.

MCP Connection Errors

If you see JSON parsing errors when connecting, ensure you are using node dist/index.js directly (not npx). Some npm packages output debug information to stdout during installation, which corrupts the MCP stdio protocol.

Tech Stack

Attribution

Originally created by Hugo Blanc.

License

MIT

Contributing

Contributions are welcome! Some ideas for additional tools:

  • Contact management (create, update, search)

  • Team and agent operations

  • Inbox configuration

  • Labels and custom attributes

  • Reports and analytics

Available Tools

5 tools
chatwoot_create_messageCreate Message in ConversationA

Create a new message in a Chatwoot conversation.

This tool sends a message in an existing conversation. Can be used for outgoing messages to customers or private internal notes.

Args:

  • conversation_id (number): The ID of the conversation (required)

  • content (string): The message content (required)

  • message_type (string): Type of message - "outgoing" or "incoming" (default: "outgoing")

  • private (boolean): Whether this is a private internal note (default: false)

Returns: Created message details including ID and confirmation

Examples:

  • Send a reply: { conversation_id: 123, content: "Thank you for contacting us!" }

  • Add internal note: { conversation_id: 123, content: "Customer called for follow-up", private: true }

Inputs: content (required), conversation_id (required), private, message_type.

chatwoot_filter_conversationsFilter Chatwoot Conversations by Date and CriteriaA
Read-onlyIdempotent

Filter conversations using advanced criteria including date ranges, status, assignee, and labels.

This tool uses Chatwoot's filter API to find conversations by creation date, last activity date, status, and more. Supports pagination (25 results per page) or auto-pagination to fetch all results at once.

IMPORTANT - Date format must be YYYY-MM-DD only (no time component). Date filters use exclusive boundaries: date_from='2026-02-20' means conversations created AFTER Feb 20 (i.e., Feb 21+). For a single day like Feb 21: use date_from='2026-02-20' and date_to='2026-02-22'.

Args:

  • date_from (string): Start date YYYY-MM-DD - conversations created after this date (optional)

  • date_to (string): End date YYYY-MM-DD - conversations created before this date (optional)

  • activity_from (string): Filter by last activity after this date YYYY-MM-DD (optional)

  • activity_to (string): Filter by last activity before this date YYYY-MM-DD (optional)

  • status (string): Filter by status - "open", "resolved", "pending", "snoozed" (optional)

  • assignee_id (number): Filter by assignee agent ID (optional)

  • inbox_id (number): Filter by inbox ID (optional)

  • label (string): Filter by label name (optional)

  • all_pages (boolean): Fetch ALL pages automatically, returns every matching conversation (default: false)

  • page (number): Page number, 25 results per page - ignored when all_pages is true (default: 1)

  • response_format (string): "markdown" or "json" (default: "markdown")

Returns: Filtered conversations with meta counts (all_count, mine_count, unassigned_count, assigned_count).

Examples:

  • Get all conversations from Feb 21: { date_from: "2026-02-20", date_to: "2026-02-22" }

  • Get ALL conversations from a date range: { date_from: "2026-02-17", date_to: "2026-03-21", all_pages: true }

  • Get resolved conversations from Feb 21: { date_from: "2026-02-20", date_to: "2026-02-22", status: "resolved" }

  • Get conversations with activity on Feb 21: { activity_from: "2026-02-20", activity_to: "2026-02-22" }

  • Get open conversations with a label: { status: "open", label: "urgent" }

Inputs: page, label, status, date_to, +7 more.

chatwoot_get_conversationGet Chatwoot Conversation DetailsA
Read-onlyIdempotent

Get detailed information about a specific Chatwoot conversation.

This tool retrieves full details for a single conversation including contact info, assignee, labels, and custom attributes.

Args:

  • conversation_id (number): The ID of the conversation to retrieve (required)

  • response_format (string): Output format - "markdown" or "json" (default: "markdown")

Returns: Full conversation details including:

  • Status, inbox, and metadata

  • Complete contact information

  • Assignee details

  • Labels and custom attributes

  • Message statistics

Examples:

  • Get conversation details: { conversation_id: 123 }

Inputs: conversation_id (required), response_format.

chatwoot_list_conversationsList Chatwoot ConversationsA
Read-onlyIdempotent

List conversations from a Chatwoot account with filtering options.

This tool retrieves conversations from Chatwoot, allowing you to filter by status, assignee, and inbox. Supports pagination for large result sets.

Args:

  • page (number): Page number for pagination, starts at 1 (default: 1)

  • status (string): Filter by conversation status - "open", "resolved", "pending", "snoozed", or "all" (default: "open")

  • assignee_type (string): Filter by assignee - "me", "unassigned", or "all" (optional)

  • inbox_id (number): Filter by specific inbox ID (optional)

  • response_format (string): Output format - "markdown" or "json" (default: "markdown")

Returns: A list of conversations with details including:

  • Conversation ID, status, and inbox

  • Contact information (name, email)

  • Assignee details

  • Message count and unread count

  • Last activity timestamp

Examples:

  • List all open conversations: { status: "open" }

  • List unassigned conversations: { assignee_type: "unassigned" }

  • List conversations in specific inbox: { inbox_id: 5 }

Inputs: page, status, inbox_id, assignee_type, +1 more.

chatwoot_list_messagesList Messages in ConversationA
Read-onlyIdempotent

List all messages in a Chatwoot conversation.

This tool retrieves all messages from a specific conversation, including message content, sender information, timestamps, and attachments.

Args:

  • conversation_id (number): The ID of the conversation (required)

  • response_format (string): Output format - "markdown" or "json" (default: "markdown")

Returns: List of messages with:

  • Message ID and content

  • Message type (incoming/outgoing)

  • Sender information (name, type)

  • Timestamp

  • Attachment information

  • Private flag (for internal notes)

Examples:

  • List all messages: { conversation_id: 123 }

Inputs: conversation_id (required), response_format.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.9/5.0

    Scored across 5 tools

    Disambiguation3/5

    list_conversations and filter_conversations overlap significantly; both retrieve conversations with filtering, though filter adds date/label/advanced criteria. The other three tools (get_conversation, list_messages, create_message) are clearly distinct.

    Naming Consistency5/5

    All tools follow a consistent chatwoot_ verb_noun pattern in snake_case: list_conversations, get_conversation, list_messages, create_message, filter_conversations. No style mixing or irregularities.

    Tool Count4/5

    Five tools is a reasonable size for a focused Chatwoot conversation/message server. It feels slightly thin compared to the full platform scope, but each tool has a distinct role and the count is appropriate for a targeted integration.

    Completeness3/5

    Core read and send workflows are covered (list/get conversations, list/create messages), but there are notable gaps: no way to update conversation status, assignee, or labels, and no create conversation or contact management. The surface handles common support tasks but lacks lifecycle management.

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      C
      quality
      D
      maintenance
      A Model Context Protocol (MCP) server that enables AI assistants like Claude to interact with your AWS environment. This allows for natural language querying and management of your AWS resources during conversations. Think of better Amazon Q alternative.
      3
      296
      ISC
    • A
      license
      C
      quality
      D
      maintenance
      A Model Context Protocol server that connects your personal WhatsApp account to AI agents like Claude, enabling them to search messages, view contacts, retrieve chat history, and send messages via WhatsApp.
      7
      11 npm
      76
      ISC
    • A
      license
      A
      quality
      C
      maintenance
      A Model Context Protocol server that enables AI assistants like Claude to interact with Zendesk Support through natural language for searching, creating, updating, and managing tickets.
      41
      287 npm
      3
      MIT