Zendesk Api MCP Server

🚀 Zendesk API MCP サーバー

このサーバーは、Zendesk API とのインタラクションに特化した包括的なモデルコンテキストプロトコル (MCP) サーバーです。Zendesk のサポート、Talk、Chat、Guide といった各種製品を管理するためのツールやリソースを提供します。

🚀 クイックスタート

前提条件

• Node.js 14 以上
• API アクセス権を持つ Zendesk アカウント

インストール

1. このリポジトリをクローンします。
2. 依存関係をインストールします。

   npm install
   

3. あなたの Zendesk の認証情報を使用して .env ファイルを作成します。

   ZENDESK_SUBDOMAIN=your-subdomain
   ZENDESK_EMAIL=your-email@example.com
   ZENDESK_API_TOKEN=your-api-token
   

サーバーの起動

サーバーを起動します。

npm start

開発時に自動再起動機能を使用する場合は、以下のコマンドを実行します。

npm run dev

MCP インスペクターでのテスト

MCP インスペクターを使用してサーバーをテストします。

npm run inspect

✨ 主な機能

• Zendesk API の機能を完全に網羅
• チケット、ユーザー、組織などを管理するツール
• Zendesk API ドキュメントにアクセスするためのリソース
• Zendesk API トークンを使用した安全な認証

💻 使用例

基本的な使用法

以下は、Zendesk のチケットを操作するための基本的なコード例です。

# チケットを一覧表示する
list_tickets()

# ID を指定して特定のチケットを取得する
get_ticket(ticket_id)

# 新しいチケットを作成する
create_ticket(subject, description)

# 既存のチケットを更新する
update_ticket(ticket_id, subject, description)

# チケットを削除する
delete_ticket(ticket_id)

高度な使用法

以下は、Zendesk のユーザーを操作するための高度なコード例です。

# ユーザーを一覧表示する
list_users()

# ID を指定して特定のユーザーを取得する
get_user(user_id)

# 新しいユーザーを作成する
create_user(name, email)

# 既存のユーザーを更新する
update_user(user_id, name, email)

# ユーザーを削除する
delete_user(user_id)

📚 ドキュメント

利用可能なツール

チケット

• list_tickets：Zendesk 内のチケットを一覧表示します。
• get_ticket：ID を指定して特定のチケットを取得します。
• create_ticket：新しいチケットを作成します。
• update_ticket：既存のチケットを更新します。
• delete_ticket：チケットを削除します。

ユーザー

• list_users：Zendesk 内のユーザーを一覧表示します。
• get_user：ID を指定して特定のユーザーを取得します。
• create_user：新しいユーザーを作成します。
• update_user：既存のユーザーを更新します。
• delete_user：ユーザーを削除します。

組織

• list_organizations：Zendesk 内の組織を一覧表示します。
• get_organization：ID を指定して特定の組織を取得します。
• create_organization：新しい組織を作成します。
• update_organization：既存の組織を更新します。
• delete_organization：組織を削除します。

グループ

• list_groups：Zendesk 内のエージェントグループを一覧表示します。
• get_group：ID を指定して特定のグループを取得します。
• create_group：新しいエージェントグループを作成します。
• update_group：既存のグループを更新します。
• delete_group：グループを削除します。

マクロ

• list_macros：Zendesk 内のマクロを一覧表示します。
• get_macro：ID を指定して特定のマクロを取得します。
• create_macro：新しいマクロを作成します。
• update_macro：既存のマクロを更新します。
• delete_macro：マクロを削除します。

ビュー

• list_views：Zendesk 内のビューを一覧表示します。
• get_view：ID を指定して特定のビューを取得します。
• create_view：新しいビューを作成します。
• update_view：既存のビューを更新します。
• delete_view：ビューを削除します。

トリガー

• list_triggers：Zendesk 内のトリガーを一覧表示します。
• get_trigger：ID を指定して特定のトリガーを取得します。
• create_trigger：新しいトリガーを作成します。
• update_trigger：既存のトリガーを更新します。
• delete_trigger：トリガーを削除します。

リソース

• zendesk://docs/{section}