Ragie MCP Server

🚀 Ragie モデルコンテキストプロトコルサーバ

このサーバは、Model Context Protocol (MCP) を実装し、Ragie の知識ベース検索機能にアクセスする能力を提供します。AI モデルが Ragie の知識ベースから情報を検索できるようになります。

🚀 クイックスタート

このサーバは、AI モデルが Ragie の知識ベースから情報を取得できるよう、Model Context Protocol を実装しています。「retrieve」という単一のツールを提供し、知識ベースをクエリして関連情報を取得します。

✨ 主な機能

• このツールは、知識ベースから取得した一致するテキスト断片の配列を返します。

📦 インストール

前提条件

• Node.js >= 18
• Ragie API キー

環境変数

サーバには以下の環境変数が必要です。

• RAGIE_API_KEY（必須）：あなたの Ragie API 認証キー

インストールと実行

npx を使用してサーバをインストールし、実行します。

RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server

コマンドラインオプション

サーバは以下のコマンドラインオプションをサポートしています。

• --description, -d <text>：デフォルトのツール説明を上書きし、カスタムテキストを使用します。
• --partition, -p <id>：クエリする Ragie パーティション ID を指定します。

コマンド例

# カスタム説明を使用する場合
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "会社の知識ベース内の情報を検索する"

# パーティションを指定する場合
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --partition your_partition_id

# 両方のオプションを使用する場合
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "会社の知識ベース内の情報を検索する" --partition your_partition_id

📚 ドキュメント

Cursor ツールへの追加方法

方法1：mcp.json ファイルの作成

プロジェクトのルートディレクトリに mcp.json ファイルを作成し、以下の内容を追加します。

{
  "servers": [
    {
      "name": "ragie-mcp-server",
      "url": "http://localhost:3000"
    }
  ]
}

方法2：シェルスクリプトの作成

シェルスクリプト（例：start_mcp_server.sh）を作成し、以下の内容を追加します。

#!/bin/bash
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --partition your_partition_id

次に、スクリプトに実行権限を付与します。

chmod +x start_mcp_server.sh

スクリプトを実行してサーバを起動します。

Claude デスクトップへの追加方法

Claude デスクトップにこのサーバを追加するには、以下のパスを見つけて対応する設定ファイルを編集します。

• Windows：C:\Users\<YourUsername>\.claudius\config\mcp.json
• macOS/Linux：~/.claudius/config/mcp.json

ファイルに以下の内容を追加します。

{
  "servers": [
    {
      "name": "ragie-mcp-server",
      "url": "http://localhost:3000"
    }
  ]
}

<YourUsername> と your_api_key を実際の情報に置き換え、必要に応じて --partition your_partition_id パラメータを追加します。

開発に関する情報

このプロジェクトは TypeScript で記述されており、以下の主要なパッケージに依存しています。

• @modelcontextprotocol/sdk：MCP サーバを実装するため
• ragie：Ragie API とのやり取りのため
• zod：ランタイム型検証のため

開発環境のセットアップ

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

RAGIE_API_KEY=your_api_key npm run dev -- --partition optional_partition_id

プロジェクトのビルド

以下のコマンドでプロジェクトをビルドします。

npm run build

📄 ライセンス

このプロジェクトは MIT License の下でライセンスされています。詳細は LICENSE.txt ファイルを参照してください。