Mineskin Api

🚀 MCP Server

このプロジェクトは、指定されたOpenAPI URL（https://api.apis.guru/v2/specs/mineskin.org/1.0.0/openapi.json）用のMCP（Model Context Protocol）サーバーです。AG2のMCPビルダーを使用して自動生成されています。

🚀 クイックスタート

このMCPサーバーにはPython 3.9以上が必要で、依存関係のインストールやサーバーの起動、テストなどの操作が可能です。

✨ 主な機能

• 様々なトランスポートモード（stdio、sse、streamable-httpなど）をサポートします。
• 環境変数を使用したサーバーの設定が可能です。
• コードのリント、静的解析、テストなどの開発ツールが用意されています。

📦 インストール

前提条件

• Python 3.9+
• pipとuv

手順

1. リポジトリをクローンします：

   git clone <repository-url>
   cd mcp-server
   

2. 依存関係をインストールします： .devcontainer/setup.shスクリプトを使用して、pip install -e ".[dev]"で依存関係をインストールできます。開発コンテナを使用していない場合は、このコマンドを手動で実行できます。

   pip install -e ".[dev]"
   

   または、uvを使用することもできます：

   uv pip install --editable ".[dev]"
   

💻 使用例

基本的な使用法

サーバーを起動するには、mcp_server/main.pyスクリプトを使用します。例えば、stdioモードで起動するには以下のコマンドを実行します。

python mcp_server/main.py stdio

高度な使用法

サーバーは環境変数を使用して設定することができます。

# CONFIG_PATHを指定してサーバーを起動
CONFIG_PATH=mcp_server/mcp_config.json python mcp_server/main.py stdio

📚 ドキュメント

開発に関する情報

このプロジェクトでは、コードのリントとフォーマットにruff、静的型チェックにmypy、テストにpytestを使用しています。

リントとフォーマット

リントの問題をチェックするには：

ruff check

コードをフォーマットするには：

ruff format

これらのコマンドは、scripts/lint.shスクリプトを介しても利用できます。

静的解析

静的解析（mypy、bandit、semgrep）を実行するには：

./scripts/static-analysis.sh

このスクリプトは、.pre-commit-config.yamlでプリコミットフックとしても設定されています。

テストの実行

カバレッジ付きでテストを実行するには：

./scripts/test.sh

これにより、pytestが実行され、カバレッジレポートが生成されます。結合レポートとクリーンアップを行うには、以下のコマンドを使用できます：

./scripts/test-cov.sh

プリコミットフック

このプロジェクトでは、.pre-commit-config.yamlで定義されたプリコミットフックを使用しています。フックをインストールするには：

pre-commit install

これらのフックは、各コミットの前に自動的に実行されます。

サーバーの実行

サーバーは、環境変数を使用して設定することができます。

• CONFIG_PATH：JSON設定ファイルへのパス（例：mcp_server/mcp_config.json）。
• CONFIG：設定を含むJSON文字列。
• SECURITY：セキュリティパラメータ（例：APIキー）の環境変数。

詳細は、mcp_server/main.pyのif __name__ == "__main__":ブロックを参照してください。

tests/test_mcp_server.pyファイルでは、テスト用にサーバーをプログラムで起動してやり取りする方法が示されています。

ビルドと公開

このプロジェクトでは、ビルドと公開にHatchを使用しています。 プロジェクトをビルドするには：

hatch build

プロジェクトを公開するには：

hatch publish

これらのコマンドは、scripts/publish.shスクリプトを介しても利用できます。