Skip to main content
Glama
mohnori

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 }

ParametersJSON Schema
NameRequiredDescriptionDefault
contentYesThe message content
privateNoWhether the message is private (internal note)
message_typeNoThe type of messageoutgoing
conversation_idYesThe ID of the conversation

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations indicate readOnlyHint=false, idempotentHint=false, destructiveHint=false. The description adds meaningful behavioral context: it specifies the message can be outgoing or incoming, private or public, and explicitly states the return value includes created message details. No contradiction with annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections (Args, Returns, Examples). Every sentence earns its place, and the examples are concise yet illustrative. No fluff or repetition of what the schema already conveys.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Despite lacking an output schema, the description explicitly states what the tool returns. It covers the main use cases (public reply, internal note) and explains defaults. Given the tool's complexity (4 params, two required), this is complete enough for an agent to use it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema covers all 4 parameters (100% coverage), so baseline is 3. The description adds value by restating parameters in a compact Args section, clarifying default values for message_type and private, and providing two concrete examples that demonstrate parameter usage and practical intent.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states "Create a new message in a Chatwoot conversation." It uses a specific verb ('create') and resource ('message'), and naturally distinguishes from sibling tools that list, get, or filter conversations/messages.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides practical guidance with examples for both public replies and private internal notes, clarifying when each mode is appropriate. However, it does not explicitly mention alternatives or when not to use this tool (e.g., 'for reading messages use chatwoot_list_messages'), though the context makes it obvious.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

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

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination (starts at 1)
labelNoFilter by label name
statusNoFilter by conversation status
date_toNoEnd date filter (exclusive). Format: YYYY-MM-DD. Conversations created BEFORE this date will be returned. Example: '2026-02-22' excludes conversations from Feb 22. To get a single day like Feb 21, use date_from='2026-02-20' and date_to='2026-02-22'
inbox_idNoFilter by inbox ID
all_pagesNoFetch ALL pages automatically. When true, ignores 'page' and returns every conversation matching the filters. Use with caution on large date ranges.
date_fromNoStart date filter (inclusive). Format: YYYY-MM-DD. Conversations created AFTER this date will be returned. Example: '2026-02-20' returns conversations from Feb 21 onwards
activity_toNoFilter by last activity before this date. Format: YYYY-MM-DD
assignee_idNoFilter by assignee agent ID
activity_fromNoFilter by last activity after this date. Format: YYYY-MM-DD. Use this instead of date_from/date_to to find conversations with activity on a specific date (not just created on that date)
response_formatNoOutput format: 'markdown' for human-readable or 'json' for machine-readablemarkdown

TDQS

A4.7/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Even with annotations declaring the tool as read-only, idempotent, and non-destructive, the description adds substantial behavioral context. It exposes the exclusive date boundary semantics (e.g., date_from='2026-02-20' means Feb 21+), pagination behavior (25 per page, all_pages option), and the returned meta counts. These details go well beyond what annotations provide.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but logically structured: a summary sentence, an IMPORTANT caveat about date format, an Args list, a Returns section, and five practical examples. It is front-loaded with the purpose and critical date semantics, and every section earns its place—no filler or redundancy exists.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description fully covers what the tool returns ('Filtered conversations with meta counts') and comprehensively documents all 11 optional parameters, including edge cases and examples. For a complex query tool with multiple filters and pagination modes, the description is entirely sufficient for an agent to select and invoke the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema already has 100% description coverage, setting a baseline of 3. The description reinforces this with a dedicated Args list and, more importantly, clarifies the date-exclusivity rule with concrete examples (e.g., 'Get all conversations from Feb 21'). This adds meaningful value beyond the schema text, warranting a 4.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with 'Filter conversations using advanced criteria including date ranges, status, assignee, and labels,' which clearly states the verb (filter), resource (conversations), and scope. It differentiates from the simpler sibling 'chatwoot_list_conversations' by emphasizing 'advanced criteria' and the dedicated filter API, making the tool's unique purpose unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides clear context for when to use this tool: whenever advanced filtering by date, status, assignee, or labels is needed. It explains the filter API and pagination options, but it does not explicitly mention alternative tools or exclusion cases, so it falls short of full sibling differentiation.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

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 }

ParametersJSON Schema
NameRequiredDescriptionDefault
conversation_idYesThe ID of the conversation
response_formatNoOutput format: 'markdown' for human-readable or 'json' for machine-readablemarkdown

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false. The description adds return content details (status, inbox, contact, assignee, labels, message stats), which enriches the behavioral profile beyond the annotation flags. No contradictions.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with Args, Returns, and Examples sections. The first sentence front-loads the purpose, and each section adds specific information without excess verbosity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the simple read-only nature, the description covers purpose, parameters with defaults, return contents, and an example. No output schema exists, but the Returns section lists key fields. Annotations cover safety hints. This is complete for an agent to select and invoke correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Both parameters are fully described in the schema (conversation_id, response_format). The description restates them and adds a usage example with conversation_id: 123, giving practical invocation context. Schema coverage is 100%, so the baseline is 3; the example lifts it to 4.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with 'Get detailed information about a specific Chatwoot conversation' and 'retrieves full details for a single conversation,' clearly distinguishing it from sibling tools that list or filter conversations. The verb 'Get' and resource 'specific conversation' are specific and unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description states it is for a 'single conversation' and lists the contents (contact info, assignee, labels, custom attributes), implying use when you have a conversation ID. It does not explicitly mention alternatives like list_conversations, but the 'specific' scope provides context. No exclusions are stated.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

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 }

ParametersJSON Schema
NameRequiredDescriptionDefault
pageNoPage number for pagination (starts at 1)
statusNoFilter conversations by statusopen
inbox_idNoFilter conversations by inbox ID
assignee_typeNoFilter by assignee type
response_formatNoOutput format: 'markdown' for human-readable or 'json' for machine-readablemarkdown

TDQS

A3.6/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare read-only, idempotent, and non-destructive behavior. The description adds valuable context beyond annotations: it explicitly mentions pagination support, the output format options (markdown/json), and details of the return content. This provides a richer picture of the tool's behavior without contradicting the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is structured with clear sections (Args, Returns, Examples) and front-loaded with the primary Purpose. While it is longer than the minimal two-sentence example, every section adds necessary information for a tool with five parameters and no output schema. The use of bullet-style lists keeps it scannable and avoids unnecessary prose.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a listing tool with no output schema, the description is complete: it explains the return fields, provides examples for common use cases, and documents defaults. It does not, however, address potential edge cases like empty results, error conditions, or rate limits, which would require additional context. Given the moderate complexity and full parameter schema, this is a solid but not perfect score.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description enriches parameter semantics by explaining defaults (page: 1, status: 'open', response_format: 'markdown'), enumerating allowed values for status and assignee_type, and providing concrete examples of parameter combinations. These additions go beyond the schema's descriptive text.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description uses a specific verb 'List' and resource 'conversations', clearly stating the tool retrieves conversations with filtering options. It does not explicitly distinguish this from the sibling 'chatwoot_filter_conversations', which appears to have overlapping purpose, preventing a perfect score.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides examples of parameter usage but no guidance on when to use this tool versus the sibling 'chatwoot_filter_conversations' or 'chatwoot_list_messages'. There is no mention of scenarios where this tool is preferred or excluded, leaving the selection decision to the agent without explicit direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

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 }

ParametersJSON Schema
NameRequiredDescriptionDefault
conversation_idYesThe ID of the conversation
response_formatNoOutput format: 'markdown' for human-readable or 'json' for machine-readablemarkdown

TDQS

A4.3/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering safety. The description adds valuable behavioral detail beyond annotations by specifying exactly what is retrieved (message content, sender information, timestamps, attachments) and the return structure (message type, private flag). This provides transparency about the tool's output and side-effect-free nature without contradicting the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with a clear purpose line, a concise Args section, a Returns section, and an example. Every sentence serves a purpose—no filler or repetition. It is front-loaded with the action and scope, making it easy for an agent to quickly understand what the tool does. The length is appropriate for the amount of detail provided.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple list tool with two parameters and no output schema, the description is highly complete. It explains both parameters, the response fields (message ID, content, type, sender, timestamp, attachments, private flag), and provides a concrete example. While it doesn't mention pagination or error handling, these are not critical for this tool's basic use case, and the description fully equips an agent to invoke it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents both parameters thoroughly. The description repeats this information in an 'Args' section and adds a usage example, which is helpful but largely redundant. Since the schema carries the heavy lifting, the description adds marginal value beyond schema descriptions, keeping this at the baseline of 3.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description opens with a specific verb and resource: 'List all messages in a Chatwoot conversation.' It clearly identifies the scope (a single conversation) and the content (messages with sender info, timestamps, attachments). This distinguishes it from sibling tools like chatwoot_list_conversations (lists conversations) and chatwoot_get_conversation (retrieves a conversation's details).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description clearly states the primary use case: retrieving all messages from a specific conversation. It implies when to use this tool (when you need message-level detail) and implicitly differentiates it from siblings by focusing on messages rather than conversations or creating messages. However, it does not explicitly mention when not to use it or name alternative tools, so it misses the full criteria for a 5.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Tool Schema Changelog

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

  1. 5 tool updatesv1.1.0
    • First observedchatwoot_create_message
    • First observedchatwoot_filter_conversations
    • First observedchatwoot_get_conversation
    • First observedchatwoot_list_conversations
    • First observedchatwoot_list_messages

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.

Maintenance

ActivityInactive
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • F
    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
    295
    -
  • A
    license
    C
    quality
    F
    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
    6 npm
    73
    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
    134 npm
    3
    MIT