MCPサーバー

このプロジェクトは、AG2 のMCP ビルダーを使用して自動生成された、指定された OpenAPI URL - https://api.apis.guru/v2/specs/nytimes.com/timeswire/3.0.0/openapi.json用の MCP (マルチエージェント会話プロトコル) サーバーです。

前提条件

• Python 3.9以上

• pipとuv

Related MCP server: Most Popular API MCP Server

インストール

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

   git clone <repository-url>
   cd mcp-server

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

   pip install -e ".[dev]"

   あるいは、 uvを使用することもできます。

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

発達

このプロジェクトでは、リンティングとフォーマットに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

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

サーバーの実行

MCPサーバーは、mcp_server/main.pyスクリプトを使用して起動できます。様々なトランスポートモード（例： stdio 、 sse ）をサポートしています。

サーバーを起動するには（例：stdio モード）：

python mcp_server/main.py stdio

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

• 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スクリプト経由でも利用できます。