Payroll MCP Server

🚀 TypeScriptを使用したMCPサーバー

このプロジェクトは、給与管理に使用されるModel Context Protocol (MCP) サーバーで、TypeScriptとExpressを用いて実装されています。

🚀 クイックスタート

このMCPサーバーは給与管理に特化しており、TypeScriptとExpressを使って構築されています。以下にサーバーのセットアップと起動方法を説明します。

必要条件

• Node.js 18+ バージョン
• npm または yarn パッケージマネージャー

インストール

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

npm install

3. .env.example テンプレートをもとに .env ファイルを作成します。

cp .env.example .env

4. .env ファイル内のAPI設定を更新します。

# API 設定
BASE_URL=http://app.localopfin.com
PORT=8089

サーバーの起動

開発サーバーを起動するには、以下のコマンドを実行します。

npm run dev

本番環境で実行するには、以下のコマンドを実行します。

npm run build
npm start

サーバーはデフォルトで8089ポートで起動します。.env ファイル内の PORT 環境変数を設定することでポートを変更できます。

✨ 主な機能

• LLMとのやり取りのためにMCPプロトコルを実装
• 給与管理ツールと従業員情報へのアクセスを提供
• Expressを使用してHTTPリクエストを処理
• リアルタイム通信のためにサーバー送信イベント (SSE) をサポート
• テスト用のサンプルクライアントを含む

📚 ドキュメント

什么是 MCP？

Model Context Protocol (MCP) は、AIモデルが外部システムと標準的な方法でやり取りできるようにするプロトコルです。大型言語モデル (LLM) がタスクを実行するために使用するリソース、ツール、およびプロンプトを定義するフレームワークを提供します。 詳細については、Model Context Protocol リポジトリ を参照してください。

認証

このサーバーは、APIリクエストの認証方法として2種類をサポートしています。

1. authId と authKey を使用したAPI認証
2. partnerKey と clientKey を使用したパートナー認証 認証要件をカスタマイズする場合は、src/api.ts ファイルを変更できます。

API エンドポイント

• GET /sse: MCP通信のためのサーバー送信イベントエンドポイント
• POST /messages: クライアントがMCPサーバーにメッセージを送信するエンドポイント

利用可能なリソース

• greeting://welcome: 静的なウェルカムメッセージリソース
• users://{userId}: ユーザーデータを返す動的なリソース

利用可能なツール

• view-people: 従業員IDを使用して特定の人物情報を表示（authId と authKey 認証が必要）
• view-all-people: すべての人物を表示し、オプションのフィルターとページングをサポート（authId/authKeyによるAPI認証またはpartnerKey/clientKeyによるパートナー認証をサポート）
• add-employee: システムに新しい従業員を追加
• remove-employee: システムから指定された従業員を削除

利用可能なインターフェース

• EmployeeService 型は、従業員関連の操作インターフェースを定義します。
• SystemService 型は、システムレベルの操作インターフェースを定義します。 これらのツールを使用するには、プロジェクトのドキュメントまたはサンプルコードを参照してください。

💡 使用例

このプロジェクトにはテスト用のクライアントが含まれており、以下のコマンドで実行できます。

npm run client

これにより、サーバーの機能とAPI呼び出し方法を検証できます。

📄 ライセンス

[ここにライセンス情報を挿入]