Freshdesk MCP

🚀 Freshdesk MCP サーバー

このサーバーは、Freshdesk と統合された MCP サーバーの実装で、AI モデルが Freshdesk モジュールとやり取りし、さまざまなサポート操作を実行できるようにします。

✨ 主な機能

• Freshdesk 統合：Freshdesk API エンドポイントとシームレスにやり取りします。
• AI モデルサポート：AI モデルが Freshdesk を通じてサポート操作を実行できるようにします。
• 自動化工单管理：チケットの作成、更新、および応答を処理します。

📦 コンポーネント

ツール

このサーバーは、Freshdesk 操作に使用できる複数のツールを提供します。

• create_ticket：新しいサポートチケットを作成します。

  • 入力：
    • subject (文字列、必須)：チケットの件名
    • description (文字列、必須)：チケットの説明
    • source (数値、必須)：チケットのソースコード
    • priority (数値、必須)：チケットの優先度レベル
    • status (数値、必須)：チケットのステータスコード
    • email (文字列、オプション)：リクエスターのメールアドレス
    • requester_id (数値、オプション)：リクエスターの ID
    • custom_fields (オブジェクト、オプション)：チケットのカスタムフィールド

• update_ticket：既存のチケットを更新します。

  • 入力：
    • ticket_id (数値、必須)：更新するチケットの ID
    • updates (オブジェクト、必須)：更新するフィールド

• delete_ticket：チケットを削除します。

  • 入力：
    • ticket_id (数値、必須)：削除するチケットの ID

• search_tickets：条件に基づいてチケットを検索します。

  • 入力：
    • query (文字列、必須)：検索クエリ文字列

• get_ticket_fields：すべてのチケットフィールドを取得します。

  • 入力：
    • なし

• get_tickets：すべてのチケットを取得します。

  • 入力：
    • page (数値、オプション)：取得するページ番号
    • per_page (数値、オプション)：1 ページあたりに表示するチケット数

• get_ticket：単一のチケットを取得します。

  • 入力：
    • ticket_id (数値、必須)：取得するチケットの ID

🚀 クイックスタート

インストール方法

Smithery を使用したインストール

# 以下のコマンドをターミナルで実行してインストールスクリプトを実行します
smithery install @effytech/freshdesk-mcp

手動インストール

1. 圧縮ファイルをダウンロードして解凍します。

   wget https://example.com/freshdesk-mcp.zip && unzip freshdesk-mcp.zip
   

2. 依存関係をインストールします。

   npm install
   

3. サーバーを起動します。

   node index.js
   

前提条件

• Node.js 14 以上
• npm 6 以上
• Freshdesk アカウントと API アクセス権限

技術要件

• ポート：デフォルトでは 3000
• プロトコル：HTTP/HTTPS
• サポートされる形式：JSON

設定

設定ファイルの例（config.json）

{
  "freshdesk": {
    "url": "https://your-subdomain.freshdesk.com",
    "api_key": "your_api_key"
  },
  "mcp": {
    "port": 3000,
    "host": "localhost"
  }
}

環境変数の設定

export FRESHDESK_URL="https://your-subdomain.freshdesk.com"
export FRESHDESK_API_KEY="your_api_key"

💻 使用例

基本的な使用法

チケットの作成

curl -X POST http://localhost:3000/api/tickets \
     -H "Content-Type: application/json" \
     -d '{"subject":"問題報告","description":"深刻な問題に遭遇しました。"}'

チケットの状態を更新

curl -X PUT http://localhost:3000/api/tickets/123/status \
     -H "Content-Type: application/json" \
     -d '{"status":2}'

🔧 テスト

単体テスト

以下のコマンドを実行して単体テストを実行します。

npm test

統合テスト

以下のコマンドを実行して統合テストを実行します。

npm run integration-test

トラブルシューティング

1. ポートの競合：他のサービスが 3000 ポートを使用していないことを確認してください。
2. 接続問題：ネットワーク接続と API サービスの状態を確認してください。
3. 設定エラー：config.json ファイルが正しいことを確認してください。

よくある質問

• デフォルトのポートを変更するにはどうすればいいですか？
  • config.json の port パラメータを変更します。
• Freshdesk に接続できません。どうすればいいですか？
  • API URL とキーが正しいことを確認してください。

📄 ライセンス

この MCP サーバーは MIT ライセンスの下で公開されています。詳細については、プロジェクトリポジトリの LICENSE ファイルを参照してください。