Aintent Framework

🚀 目標 MCP サーバー

自然言語の意図を処理し、それを構造化された操作可能な形式に変換するモデルコンテキストプロトコル (MCP) サーバーです。このサーバーは、意図を管理および処理するための強力で信頼性の高い API を提供し、拡張性と信頼性に重点を置いています。

🚀 クイックスタート

この MCP サーバーは、自然言語の意図を構造化された形式に変換するためのもので、拡張性と信頼性に優れた API を提供します。以下の手順でサーバーを起動し、利用することができます。

✨ 主な機能

• 🎯 意図処理：充実した API を通じて、意図の作成、取得、処理が可能です。
• 🔍 自然言語理解：ユーザーの原始的な意図を解析し理解します。
• 🧩 意図分解：意図を、目標と制約を含む構造化オブジェクトに変換します。
• 💾 柔軟なストレージ：プラガブルなストレージシステムで、組み込みのメモリ実装も備えています。
• 📝 型安全性：完全な TypeScript 実装で、ドキュメントも付属しています。
• 🛠️ 強力な API：意図の作成、読み取り、更新、削除機能を提供します。
• 🔄 拡張性の設計：新しい機能モジュールを簡単に追加できます。

📦 インストール

前提条件

このプロジェクトを使用するには、以下のツールがインストールされていることを確認してください。

• Node.js（推奨バージョン 14 以上）
• npm（Node パッケージマネージャー）

インストール手順

GitHub からリポジトリをクローンし、依存関係をインストールします。

git clone https://github.com/yourusername/intent-mcp.git
cd intent-mcp
npm install

📚 ドキュメント

設定

サーバーの動作は、以下の環境変数を通じて設定できます。

• NODE_ENV：実行環境を設定します（development または production）。デフォルトは development です。
• PORT：サーバーがリッスンするポートを指定します。デフォルトは 3000 です。
• DB_URI：データベース接続 URI を指定します。デフォルトは mongodb://localhost:27017/intents です。

使用方法

開発モード

npm run dev

本番モード

npm start

テスト

npm test

API エンドポイント

意図の作成

メソッド: POST
パス: /api/intents
リクエストボディ形式: JSON

リクエスト例：

{
  "intentName": "order_food",
  "description": "食品注文を処理する"
}

すべての意図を取得

メソッド: GET
パス: /api/intents

ID で意図を取得

メソッド: GET
パス: /api/intents/:id

意図を更新

メソッド: PUT
パス: /api/intents/:id
リクエストボディ形式: JSON

リクエスト例：

{
  "intentName": "order_food_updated",
  "description": "食品注文処理を更新する"
}

意図を削除

メソッド: DELETE
パス: /api/intents/:id

アーキテクチャ

このプロジェクトは、クリーンアーキテクチャパターンを採用しており、以下の層に分かれています。

• コントローラー (Controllers)：HTTP リクエストとレスポンスを処理します。
• サービス (Services)：ビジネスロジックとデータ操作を担当します。
• ストレージ (Storage)：データの永続化機能を提供します。
• モデル (Models)：データ構造と検証ルールを定義します。

プロジェクト構造

intent-mcp/
├── controllers/          # コントローラー
├── services/            # サービス層
├── storage/             # ストレージ実装
├── models/              # データモデル
├── config/              # 設定ファイル
└── routes/              # ルート定義

意図構造

意図は、以下の TypeScript インターフェースで定義されています。

interface Intent {
  id: string;
  intentName: string;
  description: string;
  createdAt: Date;
  updatedAt: Date;
}

エラー処理

このシステムは、包括的なエラー処理メカニズムを提供しており、以下のものが含まれます。

• カスタムエラークラス
• HTTP ステータスコードとレスポンスボディ
• ログ記録とトラッキング

コントリビューションガイド

コントリビューションを歓迎します！以下の手順に従ってプロジェクトに参加してください。

1. リポジトリをあなたのアカウントに Fork します。
2. 機能ブランチを作成します。
3. 変更をコミットし、Pull Request を作成します。
4. 必要に応じてドキュメントを更新します。

コミットメッセージは Conventional Commits 規範に従ってください。また、Pull Request で変更内容を明記してください。

📄 ライセンス

MIT ライセンスです。詳細は LICENSE ファイルを参照してください。