mcp-z-api について
mcp-z-api は、WhatsApp メッセージングプラットフォーム Z-API の MCP サーバーです。複数種類のメッセージ送信と、連絡先・チャット・グループ・ラベルの管理に対応しています。WhatsApp で顧客とやり取りする AI エージェントやワークフローに適しています。
主な機能
- 01テキスト・画像・ドキュメント・音声・位置情報の送信
- 02連絡先・チャット・既読状態の管理
- 03グループの作成とメンバー管理
- 04チャットへのラベル付与
- 05ボタンおよびオプションリストの送信
活用シーン
- 01エージェントによる顧客への WhatsApp 自動返信
- 02グループメンバーとラベルの一括管理
MCP 対応
Z-API の WhatsApp 機能を 27 個の MCP ツールとして公開し、MCP クライアントから呼び出せるようにします。
設定
ローカルサーバーの設定はどのクライアントでも共通です。コピーしてクライアントの MCP 設定ファイルに貼り付けてください。
ツール
27掲載時のツール一覧 · 2 週間前に更新
| パラメーター | 型 | 必須 | 説明 |
|---|---|---|---|
| phone | string | はい | 国番号付きの電話番号(例:5511999999999) |
| message | string | はい | テキストメッセージの内容 |
詳細
@codespar/mcp-z-api
Z-API 用 MCP サーバー — WhatsApp メッセージングプラットフォーム
クイックスタート
Claude Desktop
~/.config/claude/claude_desktop_config.json に追加します:
{
"mcpServers": {
"z-api": {
"command": "npx",
"args": ["-y", "@codespar/mcp-z-api"],
"env": {
"ZAPI_INSTANCE_ID": "your-instance-id",
"ZAPI_TOKEN": "your-token"
}
}
}
}
Claude Code
claude mcp add z-api -- npx @codespar/mcp-z-api
Cursor / VS Code
.cursor/mcp.json または .vscode/mcp.json に追加します:
{
"servers": {
"z-api": {
"command": "npx",
"args": ["-y", "@codespar/mcp-z-api"],
"env": {
"ZAPI_INSTANCE_ID": "your-instance-id",
"ZAPI_TOKEN": "your-token"
}
}
}
}
ツール(27)
| ツール | 用途 |
|---|---|
send_text | WhatsApp でテキストメッセージを送信します |
send_image | WhatsApp で画像メッセージを送信します |
send_document | WhatsApp でドキュメントを送信します |
send_audio | WhatsApp で音声メッセージを送信します |
get_contacts | WhatsApp のすべての連絡先を取得します |
check_number | 電話番号が WhatsApp に登録されているか確認します |
get_profile_picture | 電話番号に対応するプロフィール画像の URL を取得します |
get_messages | 電話番号に対応するメッセージを取得します |
send_button_list | WhatsApp でボタンリストメッセージを送信します |
get_status | WhatsApp インスタンスの接続状態を取得します |
create_group | WhatsApp グループを作成します |
get_group_metadata | グループのメタデータと参加者を取得します |
add_group_participant | WhatsApp グループに参加者を追加します |
remove_group_participant | WhatsApp グループから参加者を削除します |
send_location | WhatsApp で位置情報メッセージを送信します |
send_contact | WhatsApp で連絡先カードを送信します |
add_label | チャットにラベル/タグを割り当てます |
get_labels | 利用可能なすべてのラベル/タグを一覧表示します |
read_message | メッセージを既読にします |
delete_message | メッセージを削除します |
get_contact_metadata | 1 件の連絡先のメタデータ(名前、WhatsApp の表示名、プロフィール画像、ステータス)を取得します |
add_contacts | 1 件以上の連絡先を WhatsApp のアドレス帳に追加します。 |
list_chats | ページネーション付きで WhatsApp のすべてのチャットを一覧表示します |
mark_chat_as_read | チャット全体を既読または未読にします |
list_groups | ページネーション付きで WhatsApp のすべてのグループを一覧表示します |
send_option_list | インタラクティブな選択肢リスト(WhatsApp ネイティブリスト)を送信します。 |
send_button_actions | インタラクティブなアクションボタン(CALL、URL、REPLY)を送信します。 |
認証
Z-API では、リクエスト URL に埋め込まれたインスタンス ID とトークンを使用します。
サンドボックス/テスト
Z-API では、テスト用の無料トライアルを利用できます。アカウントを作成して開始してください。
認証情報の取得
- Z-API Developer Portal にアクセスします
- アカウントを作成し、無料トライアルを開始します
- インスタンス ID とトークンを取得します
- 環境変数を設定します
環境変数
| 変数 | 必須 | 説明 |
|---|---|---|
ZAPI_INSTANCE_ID | はい | Z-API インスタンス ID |
ZAPI_TOKEN | はい | Z-API インスタンストークン |
ロードマップ
v0.2(予定)
send_sticker— WhatsApp でスタンプメッセージを送信しますsend_reaction— メッセージにリアクションを送信しますget_chat_history— 連絡先とのチャット履歴全体を取得しますupdate_group_settings— グループ名、説明、設定を更新しますleave_group— WhatsApp グループから退出します
v0.3(予定)
bulk_messaging— 複数の連絡先にメッセージを送信しますtemplate_management— メッセージテンプレートを作成、管理しますcatalog_products— WhatsApp Business カタログの商品を管理します
コントリビューションをご希望ですか?PR を作成するか、ツールをリクエストしてください。
リンク
エンタープライズ
エージェントによる支払いのガバナンス、予算上限、監査証跡が必要ですか?CodeSpar Enterprise は、これらの MCP サーバーにポリシーエンジン、支払いルーティング、コンプライアンステンプレートを追加します。
ライセンス
MIT
コメント
AI アプリケーションが外部のツールやデータソースに統一的な方法で接続するためのオープンなプロトコルです。クライアントはモデルとの対話を担い、MCP サーバーはツール・リソース・プロンプトテンプレートを提供します。標準メッセージでやり取りするため、1 つのサーバーを複数のクライアントで再利用できます。