MCP Typesense Server

🚀 Typesense MCP サーバー

Model Context Protocol (MCP)に基づくサーバー実装で、AIモデルがTypesenseの検索機能にアクセスできるようにします。このサーバーにより、大規模言語モデルはTypesenseコレクションに格納されたデータを発見、検索、分析することができます。

🚀 クイックスタート

このTypesense MCPサーバーは、AIモデルがTypesenseの検索機能を利用するための基盤を提供します。以下のセクションでは、サーバーの機能、インストール方法、開発ガイド、設定方法などについて説明します。

✨ 主な機能

リソース

• typesense:// URI を通じてコレクションを一覧表示し、アクセスできます。
• 各コレクションには名前、説明、ドキュメント数があります。
• JSON MIME タイプを使用してスキーマにアクセスします。

ツール

• typesense_query

  • Typesenseコレクション内のドキュメントを検索し、強力なフィルタリング機能を備えています。
  • 入力: クエリテキスト、コレクション名、検索フィールド、フィルタ条件、ソートオプション、制限
  • 一致するドキュメントとその関連性スコアを返します。

• typesense_get_document

  • コレクションからIDで特定のドキュメントを取得します。
  • 入力: コレクション名、ドキュメントID
  • 完全なドキュメントデータを返します。

• typesense_collection_stats

  • Typesenseコレクションの統計情報を取得します。
  • 入力: コレクション名
  • コレクションのメタデータ、ドキュメント数、スキーマ情報を返します。

プロンプト

• analyze_collection

  • コレクションの構造と内容を分析します。
  • 入力: コレクション名
  • 出力: スキーマ、データ型、統計情報に関する洞察

• search_suggestions

  • 検索提案を提供します。
  • 入力: 検索キーワード
  • 出力: コンテキストに基づく検索提案

📦 インストール

npmを使ったグローバルインストール

npm install -g typesense-mcp-server

ローカルインストール

npm install typesense-mcp-server

mcp-getコマンドを使ったインストール

npx @michaellatman/mcp-get@latest install typesense-mcp-server

📚 ドキュメント

開発ガイド

依存関係のインストール

npm install

サーバーのビルド

npm run build

デバッグツールの使用

• MCP Inspector：MCPサービスを分析および監視するための対話型ツール

  npm run inspect
  

設定ガイド

Claude Desktop用の設定

以下の内容を設定ファイルに追加してください。

{
  "typesense-mcp-server": {
    "path": "~/.config/typesense-mcp-server",
    "log_level": "info"
  }
}

ログ記録

このMCPサーバーのログファイルは ~/.config/typesense-mcp-server/logs に保存されます。ログファイルにはすべての操作、エラー、その他の重要なイベントが記録され、サーバーの状態を監視および維持するのに役立ちます。

📄 ライセンス

このMCPサーバーはMITライセンスの下で公開されています。これは、あなたが自由にソフトウェアを使用、変更、配布できることを意味しますが、MITライセンスの条項と条件に従う必要があります。詳細については、プロジェクトリポジトリ内の LICENSE ファイルを参照してください。

💻 使用例

基本的な使用法

このサーバーの基本的な使用方法は、インストール後に設定ファイルを適切に設定し、必要なツールを使用してTypesenseコレクションにアクセスすることです。例えば、typesense_query を使ってドキュメントを検索することができます。

高度な使用法

高度なシナリオでは、複数のツールを組み合わせて使用したり、サーバーの設定をカスタマイズしたりすることができます。例えば、analyze_collection と search_suggestions を組み合わせて、コレクションの分析と検索提案を同時に行うことができます。

🔍 サンプル