Ragieai Ragie MCP Server

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

このサーバは、モデルコンテキストプロトコル（MCP）を実装し、Ragie 知識ベースの検索機能へのアクセスを提供します。

🚀 クイックスタート

このサーバは、AI モデルが Ragie 知識ベースから情報を検索する機能を有効にするために、モデルコンテキストプロトコルを実装しています。「retrieve」という単一のツールを提供し、知識ベースをクエリして関連情報を取得できます。

✨ 主な機能

• AI モデルが Ragie 知識ベースから情報を検索する機能を有効にする。
• 「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

# 2つのオプションを同時に使用
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "会社の知識ベースを検索する" --partition your_partition_id

💻 使用例

基本的な使用法

この MCP サーバを Cursor と一緒に使用する方法を説明します。

方法 1：MCP 設定ファイルを作成する

1. mcp.json という名前のファイルを作成します。
   • 特定のプロジェクト用のツール：プロジェクトディレクトリ内に .cursor/mcp.json ファイルを作成します。これにより、この特定のプロジェクト内でのみ利用可能な MCP サーバを定義できます。
   • すべてのプロジェクトで使用するツール：ホームディレクトリ内に ~/.cursor/mcp.json ファイルを作成します。これにより、MCP サーバをすべての Cursor ワークスペースで利用できるようになります。

mcp.json の例：

{
  "mcpServers": {
    "ragie": {
      "command": "npx",
      "args": [
        "-y",
        "@ragieai/mcp-server",
        "--partition",
        "optional_partition_id"
      ],
      "env": {
        "RAGIE_API_KEY": "your_api_key"
      }
    }
  }
}

方法 2：シェルスクリプトを使用する

1. システム上に ragie-mcp.sh という名前のファイルを保存します。

#!/usr/bin/env bash

export RAGIE_API_KEY="your_api_key"

npx -y @ragieai/mcp-server --partition optional_partition_id

2. ファイルに実行権限を付与します。

chmod +x ragie-mcp.sh

3. スクリプトを実行します。

./ragie-mcp.sh

🔧 技術詳細

このプロジェクトは 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.txt を参照してください。