Ksrk MCP Server Client

🚀 クイックスタート

このプロジェクトは、MCP サーバーと OpenAI の GPT - 4 モデルを利用したシステムです。以下に、必要な環境のセットアップと使用方法を説明します。

✨ 主な機能

• MCP サーバーとの接続管理
• OpenAI の GPT - 4 モデルを用いたユーザークエリの分析
• ScrapingDog API を使ったウェブ検索
• ウェブサイトのコンテンツ取得

📦 インストール

必要条件

• Python 3.13
• pyproject.toml に記載された依存関係

インストール手順

1. リポジトリをクローンし、ディレクトリに移動します。

   git clone <repository-url>
   cd documentation
   

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

   python -m venv .venv
   source .venv/bin/activate  # Windows の場合は `.venv\Scripts\activate` を使用
   

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

   pip install -r requirements.txt
   

4. 環境変数を設定します。 プロジェクトのルートディレクトリに .env ファイルを作成し、以下の内容を記述します。

   SCRAPING_DOG_API_KEY=your_scraping_dog_api_key
   OPENAI_API_KEY=your_openai_api_key
   

💻 使用例

基本的な使用法

クライアントの実行

1. ルートディレクトリに移動します。

   cd ..
   

2. クライアントを実行します。

   python client.py
   

3. インタラクティブなプロンプトに質問を入力します。quit または exit を入力すると、クライアントを停止できます。

📚 ドキュメント

プロジェクトファイル

client.py

このファイルには、MCP サーバーと OpenAI の GPT - 4 モデルとのやり取りを行う主要なクライアントコードが含まれています。以下の主要なコンポーネントがあります。

• MCPClient：MCP サーバーとの接続を管理し、利用可能なツールを呼び出すメソッドを提供するクラス。
• agent_loop：ユーザーのクエリを処理し、LLM と利用可能なツールを使用して分析する非同期関数。
• main：MCP サーバーの設定、ツールの初期化、およびインタラクティブループを実行するメイン関数。

ksrk - mcp/ksrk - mcp - server.py

このファイルには、MCP サーバーの実装が含まれています。以下の主要なコンポーネントがあります。

• search_web：ScrapingDog API を使用してウェブ検索を行う非同期関数。
• fetch_url：指定された URL のコンテンツを取得する非同期関数。
• about_ksrk：指定されたウェブサイトで「ksrk」に関する詳細情報を検索する MCP ツール。

ksrk - mcp/test - website.py

このファイルには、httpx と BeautifulSoup を使用してウェブサイトのスクレイピングをテストするスクリプトが含まれています。

📄 ライセンス

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

謝辞

• OpenAI：GPT - 4 モデルの提供
• ScrapingDog：ウェブスクレイピング API の提供
• BeautifulSoup：HTML および XML ドキュメントの解析
• [httpx](https://www.python - httpx.org)：HTTP クライアントの提供