UnderChat MCP by usefulapi
List WhatsApp chats, contacts and sectors; send, transfer and label chats in UnderChat.
使うべきか
品質と安全性
検出事項(1)
- LOWunderchat_find_contact_by_phone 内
ツール定義とプロトコルへの準拠に関する自動分析に基づいています。
コンテキストコスト
これは、サーバーのツールがモデルのコンテキストに読み込まれるたびに消費されるおおよそのトークン数です。数が多いほど、ほかのタスクに使える注意が減ります。
インストール
ワンクリックインストール
これを `claude_desktop_config.json` ファイルに追加してください:
{
"mcpServers": {
"underchat": {
"url": "https://underchat.usefulapi.io/mcp"
}
}
}リモートエンドポイント
https://underchat.usefulapi.io/mcpstreamable-httpできること
ツール一覧
ツール(21)
🟢underchat_list_chats(status, current_page, per_page, cursor, filter_name, ...)
List conversations in one state (my_chats = the executor's own chats; or queue, in_chat, closed, and so on), with optional filters. GET /chat.
入力スキーマ
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"my_chats",
"ura",
"queue",
"in_chat",
"ura_output",
"ura_schedule",
"ura_webhook",
"closed",
"transmission"
],
"description": "Conversation state to list. Use my_chats for the executor's own chats."
},
"current_page": {
"description": "Page number (default 1).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"per_page": {
"description": "Results per page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"cursor": {
"description": "Cursor from a previous page, when the API returns one.",
"type": "string"
},
"filter_name": {
"description": "Filter by contact name.",
"type": "string"
},
"filter_phone": {
"description": "Filter by contact phone.",
"type": "string"
},
"filter_protocol": {
"description": "Filter by attendance protocol.",
"type": "string"
},
"filter_sector_id": {
"description": "Filter by sector id.",
"type": "string"
},
"filter_worker_id": {
"description": "Filter by channel (worker) id.",
"type": "string"
},
"filter_user_id": {
"description": "Filter by assigned user id.",
"type": "string"
},
"filter_label_template_id": {
"description": "Filter by label template id.",
"type": "string"
},
"filter_unread_conversations": {
"description": "Only conversations with unread messages.",
"type": "boolean"
}
},
"required": [
"status"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_search_chats(search, status, current_page, per_page, filter_sector_id, ...)
Search conversations by contact name or phone. GET /chat/search.
入力スキーマ
{
"type": "object",
"properties": {
"search": {
"type": "string",
"minLength": 1,
"description": "Text to find in the contact name or phone."
},
"status": {
"description": "Optional conversation state to narrow the search.",
"type": "string",
"enum": [
"my_chats",
"ura",
"queue",
"in_chat",
"ura_output",
"ura_schedule",
"ura_webhook",
"closed",
"transmission"
]
},
"current_page": {
"description": "Page number (default 1).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"per_page": {
"description": "Results per page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"filter_sector_id": {
"description": "Filter by sector id.",
"type": "string"
},
"filter_user_id": {
"description": "Filter by assigned user id.",
"type": "string"
}
},
"required": [
"search"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_get_chat_messages(chat_id, current_page, per_page)
Read the message history of one chat, newest first, with paging. GET /chat/{chat_id}.
入力スキーマ
{
"type": "object",
"properties": {
"chat_id": {
"type": "string",
"minLength": 1,
"description": "The chat id (from underchat_list_chats)."
},
"current_page": {
"description": "Page number (default 1).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"per_page": {
"description": "Results per page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"chat_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_search_chat_messages(chat_id, search, current_page, per_page)
Search the messages of one chat for a text. GET /chat/{chat_id}/search.
入力スキーマ
{
"type": "object",
"properties": {
"chat_id": {
"type": "string",
"minLength": 1,
"description": "The chat id (from underchat_list_chats)."
},
"search": {
"type": "string",
"minLength": 1,
"description": "Text to find in the messages."
},
"current_page": {
"description": "Page number (default 1).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"per_page": {
"description": "Results per page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"chat_id",
"search"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_get_chat_details(chat_id)
Get one chat with its state, assigned channel, user, sector and labels. GET /chat/{chat_id}/details.
入力スキーマ
{
"type": "object",
"properties": {
"chat_id": {
"type": "string",
"minLength": 1,
"description": "The chat id (from underchat_list_chats)."
}
},
"required": [
"chat_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_get_unread_summary
Count the unread messages for the executor. GET /chat/unread-summary.
入力スキーマ
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_list_channels
List the account's channels (for example WhatsApp numbers) with their status. Use the ids as channel or worker ids in other tools. GET /chat/channels-status.
入力スキーマ
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_list_workers
List the workers (channels) that can receive or transfer a chat, for filters and transfers. GET /chat/workers.
入力スキーマ
{
"type": "object",
"properties": {},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_list_contacts(search, current_page, per_page, filter_name, filter_phone, ...)
List the account's chat contacts with paging and filters. GET /chat/contacts.
入力スキーマ
{
"type": "object",
"properties": {
"search": {
"description": "Text to find in the contact data.",
"type": "string"
},
"current_page": {
"description": "Page number (default 1).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"per_page": {
"description": "Results per page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"filter_name": {
"description": "Filter by first name.",
"type": "string"
},
"filter_phone": {
"description": "Filter by phone number.",
"type": "string"
},
"filter_email": {
"description": "Filter by email.",
"type": "string"
},
"filter_label_template_id": {
"description": "Filter by label template id.",
"type": "string"
},
"filter_channel_id": {
"description": "Filter by channel id.",
"type": "string"
},
"filter_user_id": {
"description": "Filter by owner user id.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_get_contact(contact_id)
Get one chat contact by id. GET /chat/contacts/{contact_id}.
入力スキーマ
{
"type": "object",
"properties": {
"contact_id": {
"type": "string",
"minLength": 1,
"description": "The contact id (from underchat_list_contacts)."
}
},
"required": [
"contact_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_find_contact_by_phone(phone, phone_ddi)
Find the chat contact that has a phone number. GET /chat/contacts/by-phone.
入力スキーマ
{
"type": "object",
"properties": {
"phone": {
"type": "string",
"minLength": 1,
"description": "Phone number without the country code."
},
"phone_ddi": {
"type": "string",
"minLength": 1,
"description": "Country code, for example 49 for Germany."
}
},
"required": [
"phone",
"phone_ddi"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_list_label_templates(label, label_status, current_page, per_page)
List the label templates (etiquetas) of the account. GET /label-template.
入力スキーマ
{
"type": "object",
"properties": {
"label": {
"description": "Filter by label name.",
"type": "string"
},
"label_status": {
"description": "Filter by label status.",
"type": "string"
},
"current_page": {
"description": "Page number (default 1).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"per_page": {
"description": "Results per page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_list_sectors(name, current_page, per_page)
List the sectors (setores) of the account. GET /sector.
入力スキーマ
{
"type": "object",
"properties": {
"name": {
"description": "Filter by sector name.",
"type": "string"
},
"current_page": {
"description": "Page number (default 1).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"per_page": {
"description": "Results per page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_list_users(search, sector_id, current_page, per_page)
List the users (attendants) of the account with paging and filters. GET /user.
入力スキーマ
{
"type": "object",
"properties": {
"search": {
"description": "Text to find in the user data.",
"type": "string"
},
"sector_id": {
"description": "Only users of this sector.",
"type": "string"
},
"current_page": {
"description": "Page number (default 1).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"per_page": {
"description": "Results per page.",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟢underchat_get_user(user_id)
Get one user of the account by id, with the status and access group. GET /user/{user_id}.
入力スキーマ
{
"type": "object",
"properties": {
"user_id": {
"type": "string",
"minLength": 1,
"description": "The user id (from underchat_list_users)."
}
},
"required": [
"user_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴underchat_send_text_message(chat_id, message, message_quoted_id)
Send a WhatsApp text message into an existing chat, as the executor. The customer receives it. POST /chat/{chat_id} with type=text.
入力スキーマ
{
"type": "object",
"properties": {
"chat_id": {
"type": "string",
"minLength": 1,
"description": "The chat id (from underchat_list_chats)."
},
"message": {
"type": "string",
"minLength": 1,
"maxLength": 4096,
"description": "The text to send."
},
"message_quoted_id": {
"description": "Id of a message to quote in the reply.",
"type": "string"
}
},
"required": [
"chat_id",
"message"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴underchat_update_chat_status(chat_id, status, closure_comment, send_message_on_finish_attendance)
Move a chat to another state, for example closed, queue or in_chat. Closing ends the attendance for the customer. PATCH /chat/{chat_id}/status.
入力スキーマ
{
"type": "object",
"properties": {
"chat_id": {
"type": "string",
"minLength": 1,
"description": "The chat id (from underchat_list_chats)."
},
"status": {
"type": "string",
"enum": [
"ura",
"queue",
"in_chat",
"ura_output",
"ura_schedule",
"ura_webhook",
"closed",
"transmission"
],
"description": "The new state of the chat."
},
"closure_comment": {
"description": "Comment saved when the chat is closed.",
"type": "string",
"maxLength": 1000
},
"send_message_on_finish_attendance": {
"description": "Send the account's closing message to the customer.",
"type": "boolean"
}
},
"required": [
"chat_id",
"status"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴underchat_transfer_chat(chat_id, worker_id, user_id, sector_id, annotation, ...)
Transfer a chat to another worker (channel), user or sector. Set at least one of worker_id, user_id or sector_id. POST /chat/{chat_id}/transfer.
入力スキーマ
{
"type": "object",
"properties": {
"chat_id": {
"type": "string",
"minLength": 1,
"description": "The chat id (from underchat_list_chats)."
},
"worker_id": {
"description": "Target channel (worker) id.",
"type": "string"
},
"user_id": {
"description": "Target user id.",
"type": "string"
},
"sector_id": {
"description": "Target sector id.",
"type": "string"
},
"annotation": {
"description": "Note for the receiving attendant.",
"type": "string",
"maxLength": 1000
},
"keep_in_chat": {
"description": "Keep the executor in the chat after the transfer.",
"type": "boolean"
},
"send_message_on_transfer": {
"description": "Send the account's transfer message to the customer.",
"type": "boolean"
}
},
"required": [
"chat_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡underchat_set_chat_labels(chat_id, label_template_ids)
Send a list of label template ids to a chat. The API decides whether the list replaces or adds to the current labels; check the chat after the call. PATCH /chat/{chat_id}/label.
入力スキーマ
{
"type": "object",
"properties": {
"chat_id": {
"type": "string",
"minLength": 1,
"description": "The chat id (from underchat_list_chats)."
},
"label_template_ids": {
"maxItems": 50,
"type": "array",
"items": {
"type": "string",
"minLength": 1
},
"description": "Label template ids (from underchat_list_label_templates)."
}
},
"required": [
"chat_id",
"label_template_ids"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🔴underchat_create_contact(name, phone_ddi, phone, last_name, email, ...)
Create a chat contact with a name and a phone number. POST /chat/contacts.
入力スキーマ
{
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"description": "First name."
},
"phone_ddi": {
"type": "string",
"minLength": 1,
"description": "Country code without +, for example 49."
},
"phone": {
"type": "string",
"minLength": 1,
"description": "Phone number without the country code."
},
"last_name": {
"description": "Last name.",
"type": "string"
},
"email": {
"description": "Email address.",
"type": "string"
},
"nickname": {
"description": "Nickname.",
"type": "string"
},
"notes": {
"description": "Free-text notes.",
"type": "string"
}
},
"required": [
"name",
"phone_ddi",
"phone"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}🟡underchat_update_contact(contact_id, name, last_name, email, nickname, ...)
Change the fields you send for one chat contact. Fields you omit stay as they are. PATCH /chat/contacts/{contact_id}.
入力スキーマ
{
"type": "object",
"properties": {
"contact_id": {
"type": "string",
"minLength": 1,
"description": "The contact id (from underchat_list_contacts)."
},
"name": {
"description": "First name.",
"type": "string"
},
"last_name": {
"description": "Last name.",
"type": "string"
},
"email": {
"description": "Email address.",
"type": "string"
},
"nickname": {
"description": "Nickname.",
"type": "string"
},
"notes": {
"description": "Free-text notes.",
"type": "string"
}
},
"required": [
"contact_id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}コミュニティ
エビデンス