Dust

🚀 MCP サーバーガイド

MCP サーバーは、タスク制御プロトコル（Mission Control Protocol）を管理するためのツールです。会話の作成、メッセージの送信と検索機能を提供し、curl リクエストを通じたやり取りもサポートしています。

🚀 クイックスタート

✨ 主な機能

• 会話セッションの作成
• メッセージの送信と検索
• RESTful API を通じたクライアントとのやり取り

📦 インストール

MCP Server をインストールするには、以下の手順に従ってください。

前提条件

• オペレーティングシステム：Linux、macOS または Windows（Linux の使用を推奨）
• Python バージョン：3.6 以上
• Git：コードリポジトリをクローンするために必要

リポジトリのクローン

以下のコマンドを実行して、MCP Server のリポジトリをクローンします。

git clone https://github.com/yourusername/mcp-server.git
cd mcp-server

依存関係のインストール

pip を使用して、必要な Python パッケージをインストールします。

pip install -r requirements.txt

サーバーの起動

インストールが完了したら、以下のコマンドを実行して MCP Server を起動します。

python3 server.py --help

📚 ドキュメント

設定

MCP Server の設定は、config.json ファイルを通じて行います。このファイルは、プロジェクトのルートディレクトリにあります。

設定例

{
  "server": {
    "host": "0.0.0.0",
    "port": 5000,
    "debug": true
  },
  "api_key": "your_api_key_here",
  "workspace_id": "your_workspace_id_here"
}

環境変数

MCP Server は、環境変数を使用した設定もサポートしています。以下は、一般的に使用される環境変数です。

• MCP_API_KEY：あなたの API キー
• MCP_WORKSPACE_ID：あなたのワークスペース ID
• MCP_DEBUG：デバッグモードを有効にする（true または false）

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

MCP Server は、以下のコマンドラインオプションを提供しています。

サーバーの起動

python3 server.py --host HOST --port PORT [--debug]

パラメータ

• --host: サーバーがバインドするホストアドレス（デフォルト：0.0.0.0）
• --port: サーバーがリッスンするポート（デフォルト：5000）
• --debug: デバッグモードを有効にする（デフォルト：false）

ログ記録

python3 server.py --log-file LOG_PATH [--log-level LEVEL]

パラメータ

• LOG_PATH: ログファイルのパス
• LEVEL: ログレベル（DEBUG, INFO, WARNING, ERROR, CRITICAL，デフォルト：INFO）

💻 使用例

基本的な使用法

以下は、curl を使用した基本的なリクエストの例です。

会話の作成

curl -X POST "http://localhost:5000/api/v1/conversations" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "システム思考対話",
    "model": "claude-3-5-sonnet-20240620"
  }'

メッセージの送信

curl -X POST "http://localhost:5000/api/v1/conversations/{conversation_id}/messages" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "MCP プロトコルの詳細を説明してください",
    "mentions": [{
      "configurationId": "your_agent_id_here",
      "context": {
        "タイムゾーン": "Europe/Berlin",
        "モデル設定": {"提供者": "anthropic"}
      }
    }],
    "context": {
      "タイムゾーン": "Europe/Berlin"
    }
  }'

メッセージの検索

curl -X POST "http://localhost:5000/api/v1/conversations/{conversation_id}/messages" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "すべてのメッセージを返す",
    "mentions": [{
      "configurationId": "your_agent_id_here",
      "context": {
        "タイムゾーン": "Europe/Berlin",
        "モデル設定": {"提供者": "anthropic"}
      }
    }]
  }'

高度な使用法

高度なシナリオでは、コマンドラインオプションや環境変数を使用して、サーバーの設定をカスタマイズすることができます。

🔧 技術詳細

MCP Server は、以下のエラーコードをサポートしています。

• 400 Bad Request：無効なリクエスト
• 401 Unauthorized：認証されていないアクセス
• 404 Not Found：リソースが見つからない
• 500 Internal Server Error：サーバー内部エラー

📄 ライセンス

原ドキュメントにライセンス情報は記載されていません。

🔧 貢献ガイド

問題の報告

問題を報告するか、提案をする場合は、GitHub リポジトリに issue を投稿してください。

機能リクエストの提出

新しい機能や改善点を提案する場合は、Pull Request を通じて提出してください。

⚠️ 重要提示

• API キーとワークスペース ID の安全性を確保し、漏洩を防いでください。
• 本番環境では、デバッグモードを無効にしてください。

🚀 MCP サーバー API ドキュメント

概要

MCP サーバーは、RESTful API を提供しており、クライアントが MCP サービスとやり取りできるようになっています。以下は、利用可能な API エンドポイントとその詳細な説明です。

会話の作成

POST /api/v1/conversations

説明

新しい会話セッションを作成します。

リクエストヘッダー

• Authorization: Bearer Token（必須）
• Content-Type: application/json

リクエストボディ

{
  "title": "string", // 会話のタイトル（オプション）
  "model": "string" // 使用するモデル（必須）
}

レスポンス

{
  "id": "string", // 新しく作成されたセッションの ID
  "title": "string",
  "created_at": "datetime"
}

メッセージの送信

POST /api/v1/conversations/{conversation_id}/messages

説明

指定された会話セッションに新しいメッセージを送信します。

リクエストヘッダー

• Authorization: Bearer Token（必須）
• Content-Type: application/json

リクエストボディ

{
  "content": "string", // メッセージの内容（必須）
  "mentions": array // 言及するユーザーまたはロール（オプション）
}

レスポンス

{
  "id": "string",
  "content": "string",
  "sent_at": "datetime"
}

メッセージの検索

POST /api/v1/conversations/{conversation_id}/messages

説明

指定された会話セッション内のすべてのメッセージを検索します。

リクエストヘッダー

• Authorization: Bearer Token（必須）
• Content-Type: application/json

リクエストボディ

{
  "content": "string", // クエリ条件、例："すべてのメッセージを返す"（必須）
  "mentions": array // 言及するユーザーまたはロール（オプション）
}

レスポンス

[
  {
    "id": "string",
    "content": "string",
    "sent_at": "datetime"
  },
  ...
]

💻 使用例

基本的な使用法

以下は、API を使用した基本的なリクエストの例です。

会話の作成

curl -X POST "http://localhost:5000/api/v1/conversations" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "システム思考対話",
    "model": "claude-3-5-sonnet-20240620"
  }'

メッセージの送信

curl -X POST "http://localhost:5000/api/v1/conversations/{conversation_id}/messages" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "MCP プロトコルの詳細を説明してください",
    "mentions": [{
      "configurationId": "your_agent_id_here",
      "context": {
        "タイムゾーン": "Europe/Berlin",
        "モデル設定": {"提供者": "anthropic"}
      }
    }],
    "context": {
      "タイムゾーン": "Europe/Berlin"
    }
  }'

メッセージの検索

curl -X POST "http://localhost:5000/api/v1/conversations/{conversation_id}/messages" \
  -H "Authorization: Bearer your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "すべてのメッセージを返す",
    "mentions": [{
      "configurationId": "your_agent_id_here",
      "context": {
        "タイムゾーン": "Europe/Berlin",
        "モデル設定": {"提供者": "anthropic"}
      }
    }]
  }'