Frontapp

🚀 Frontapp MCP サーバー

Frontend は、大型言語モデル（LLMs）を Frontapp の顧客コミュニケーションプラットフォームに統合するためのモデルコンテキストプロトコル（MCP）サーバーです。このサーバーにより、開発者は明確なインターフェースとプロトコルを通じて、ワークフローの自動化と対話体験の向上を実現できます。

🚀 クイックスタート

Frontapp MCP サーバーは、大型言語モデル（LLMs）と Frontapp の顧客コミュニケーションプラットフォームをつなぐ橋渡しの役割を果たします。定義されたインターフェースとプロトコルを通じて、開発者はワークフローの自動化と対話体験の向上を実現できます。

✨ 主な機能

• 対話管理：Frontapp の対話に関連するすべての操作を処理します。
• タグ管理：タグの作成、読み取り、更新、削除操作を提供します。
• 連絡先管理：連絡先の効率的な管理を実現します。
• チケット管理：チケットのライフサイクル全体の操作をサポートします。
• webhook 統合：リアルタイムイベント通知の受信と処理を実現します。

🔧 技術詳細

Frontapp MCP サーバーはモジュール化設計を採用しており、以下の主要コンポーネントで構成されています。

1. API ゲートウェイ：すべての API リクエストのルーティングと処理を担当します。
2. 対話プロセッサー：対話に関連するビジネスロジックを専門的に処理します。
3. タグプロセッサー：タグの作成、読み取り、更新、削除操作に特化しています。
4. 連絡先プロセッサー：連絡先の効率的な管理を実現します。
5. チケットプロセッサー：チケットのライフサイクル全体の操作をサポートします。
6. webhook プロセッサー：リアルタイムイベント通知の受信と処理を実現します。

📦 インストール

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

npx -y @smithery/cli install frontapp-mcp-server --rebuild

手動インストール

1. リポジトリをクローンします：

   git clone https://github.com/your-username/frontapp-mcp-server.git
   cd frontapp-mcp-server
   

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

   npm install
   

3. 開発サーバーを起動します：

   npm run dev
   

📚 ドキュメント

プロジェクトのドキュメントは docs ディレクトリにあり、以下の内容が含まれています。

• intro.md：プロジェクトの概要と基本概念。
• インストールガイド.md：詳細なインストール手順。
• 対話管理.md：対話に関連するインターフェースと使用方法。
• タグ管理.md：タグの作成、読み取り、更新、削除操作。
• 連絡先管理.md：連絡先の効率的な管理方法。
• チケット管理.md：チケットのライフサイクル全体の操作ガイド。
• webhook 統合.md：リアルタイムイベント通知の受信と処理。

💻 使用例

API 使用例

import { FrontappMCPClient } from '@frontapp/mcp-client';

const client = new FrontappMCPClient('http://localhost:3000');

// 対話リストを取得する
client.conversations.getConversations().then(console.log);

// 新しい対話を作成する
client.conversations.createConversation({
  participants: ['user1', 'bot'],
  initialMessage: 'Hello, how are you?'
});

クライアントライブラリの例

完全なクライアントの使用例は src/examples/client-usage-example.ts にあります。

webhook 統合

このプロジェクトは、Frontapp から送信されるリアルタイムイベント通知の受信と処理をサポートしています。詳細については docs/webhook-integration.md を参照してください。

開発ガイド

詳細な開発情報は docs/development-guide.md を参照してください。

高速開発コマンド

# ホットリロード付きで開発サーバーを起動する
npm run dev

# テストケースを実行する
npm test

# コードカバレッジチェックを実行する
npm run coverage

# ドキュメントを生成する
npm run docs:build

コンテナ化デプロイ

このプロジェクトは Docker をサポートしており、コンテナ化デプロイを容易にしています。

1. イメージをビルドします：

   docker build -t frontapp-mcp-server .
   

2. コンテナを実行します：

   docker run -p 3000:3000 --name mcp-server frontapp-mcp-server
   

セキュリティに関する考慮事項

このプロジェクトでは、以下のセキュリティ対策を推奨しています。

• 暗号化：すべての機密データは暗号化処理する必要があります。
• HTTPS：通信には HTTPS プロトコルを強制的に使用します。
• 認証：厳格な認証メカニズムを実装し、承認されたユーザーのみがリソースにアクセスできるようにします。
• レート制限：API リクエストにレート制限を設定し、乱用を防止します。

📄 ライセンス

このプロジェクトは MIT License のオープンソースライセンスの下で提供されています。

謝辞

Frontapp MCP サーバーの開発に貢献した以下のプロジェクトとツールに感謝します。

• Node.js と npm
• TypeScript
• Docker
• Smithery