Newaitees Ollama MCP Server

🚀 ollama-MCP-server プロジェクトドキュメント

ollama-MCP-server は、Model Context Protocol (MCP) に基づくプロジェクトです。このプロジェクトは、ユーザーが大規模言語モデル（LLM）をローカルで実行および管理するためのサーバーを提供することを目的としています。また、ローカルでオープンソースの LLM を実行するためのツールである Ollama を利用しています。

🚀 クイックスタート

インストール

1. プロジェクトリポジトリをクローンします。

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

2. 仮想環境を作成してアクティブ化します（推奨）。

   python -m venv venv
   source venv/bin/activate  # Windows の場合は：venv\Scripts\activate
   

3. 依存関係をインストールします。

   pip install -r requirements.txt
   

サーバーの起動

1. 提供されているスクリプトを使用してサーバーを起動します。

   ./run_server.sh
   

2. オプションパラメータを追加することができます。

   --debug  # デバッグモードを有効にする（ログレベルを DEBUG に設定）
   --log=LEVEL  # ログレベルを設定する（DEBUG, INFO, WARNING, ERROR, CRITICAL）
   

使用例

# MCP プロトコルを通じてモデルを呼び出す
response = await mcp.use_mcp_tool({
    "server_name": "ollama-MCP-server",
    "tool_name": "run-model",
    "arguments": {
        "model": "llama3",
        "prompt": "请简单解释量子计算。",
        "temperature": 0.7
    }
})

✨ 主な機能

核心機能

• モデルの実行：LLaMA シリーズや Alpaca など、Ollama の複数のモデルをローカルで実行できます。
• API インターフェース：REST と WebSocket ベースの API を提供し、統合を容易にします。
• コンテキスト管理：MCP プロトコルを通じて、モデルと外部システムとのやり取りを実現します。

その他の機能

• 多言語対応：デフォルトで英語と中国語のインターフェースおよびドキュメントをサポートしています。
• ログシステム：詳細なログ記録機能が組み込まれており、デバッグや監視が容易です。
• 拡張プラグイン：プラグインメカニズムを提供し、さらなる機能モジュールを追加できます。

📦 インストール

システム要件

• オペレーティングシステム：Linux、macOS、Windows をサポートしています。
• Python バージョン：Python 3.8 以上の使用を推奨します。
• Ollama のインストール：事前に Ollama をインストールし、環境変数を設定する必要があります。

インストール手順

1. プロジェクトリポジトリをクローンします。

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

2. 仮想環境を作成してアクティブ化します（推奨）。

   python -m venv venv
   source venv/bin/activate  # Windows の場合は：venv\Scripts\activate
   

3. 依存関係をインストールします。

   pip install -r requirements.txt
   

設定

1. config.py ファイルを編集し、サーバーのポートやログレベルなどのパラメータを設定します。
2. models ディレクトリを作成し、必要な Ollama モデルファイルをダウンロードして配置します。

💻 使用例

基本的な使用法

# サーバーを起動する
./run_server.sh

高度な使用法

• モデル管理：

  • 複数の Ollama モデルの読み込みをサポートしています。
  • モデルの状態監視とリソース割り当て機能を提供しています。

• ログと監視

  • 詳細なログシステムが組み込まれており、複数のログレベルの出力をサポートしています。
  • パフォーマンス監視インターフェースを提供し、サーバーの実行を最適化しやすくしています。

📚 ドキュメント

開発環境の設定

1. プロジェクトをクローンして初期化します。

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

2. 仮想環境を作成してアクティブ化します。

   python -m venv venv
   source venv/bin/activate  # Windows の場合は：venv\Scripts\activate
   

3. 開発用の依存関係をインストールします。

   pip install -r requirements.dev.txt
   

コーディング規約

• PEP8 コードスタイルガイドに従ってください。
• 詳細なコメントとドキュメントを提供し、チーム協力を容易にしてください。

コードの提出

1. 機能ブランチを作成します。

   git checkout -b feature/your-feature-name
   

2. 変更をコミットし、リモートリポジトリにプッシュします。

   git add .
   git commit -m "描述你的修改"
   git push origin feature/your-feature-name
   

📄 ライセンス

原ドキュメントにライセンス情報が記載されていないため、このセクションは表示されません。

👏 謝辞

原ドキュメントに謝辞に関する具体的な内容が記載されていないため、このセクションは表示されません。