MCP-Server

Dieses Projekt ist ein MCP-Server (Multi-Agent Conversation Protocol) für die angegebene OpenAPI-URL – https://api.apis.guru/v2/specs/nytimes.com/timeswire/3.0.0/openapi.json , automatisch generiert mit dem MCP-Builder von AG2.

Voraussetzungen

• Python 3.9+

• Pip und UV

Related MCP server: Most Popular API MCP Server

Installation

1. Klonen Sie das Repository:

   git clone <repository-url>
   cd mcp-server

2. Abhängigkeiten installieren: Das Skript .devcontainer/setup.sh übernimmt die Installation von Abhängigkeiten mit pip install -e ".[dev]" . Wenn Sie den Dev-Container nicht verwenden, können Sie diesen Befehl manuell ausführen.

   pip install -e ".[dev]"

   Alternativ können Sie uv verwenden:

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

Entwicklung

Dieses Projekt verwendet ruff zum Lint-Test und Formatieren, mypy zur statischen Typprüfung und pytest zum Testen.

Lintierung und Formatierung

So prüfen Sie, ob Probleme mit der Flusenbildung vorliegen:

ruff check

So formatieren Sie den Code:

ruff format

Diese Befehle sind auch über das Skript scripts/lint.sh verfügbar.

Statische Analyse

So führen Sie eine statische Analyse aus (mypy, bandit, semgrep):

./scripts/static-analysis.sh

Dieses Skript ist auch als Pre-Commit-Hook in .pre-commit-config.yaml konfiguriert.

Ausführen von Tests

So führen Sie Tests mit Abdeckung durch:

./scripts/test.sh

Dadurch wird pytest ausgeführt und ein Abdeckungsbericht generiert. Für einen kombinierten Bericht und eine Bereinigung können Sie Folgendes verwenden:

./scripts/test-cov.sh

Pre-Commit-Hooks

Dieses Projekt verwendet Pre-Commit-Hooks, die in .pre-commit-config.yaml definiert sind. So installieren Sie die Hooks:

pre-commit install

Die Hooks werden vor jedem Commit automatisch ausgeführt.

Ausführen des Servers

Der MCP-Server kann mit dem Skript mcp_server/main.py gestartet werden. Er unterstützt verschiedene Transportmodi (z. B. stdio , sse ).

So starten Sie den Server (z. B. im Standardmodus):

python mcp_server/main.py stdio

Der Server kann mithilfe von Umgebungsvariablen konfiguriert werden:

• CONFIG_PATH : Pfad zu einer JSON-Konfigurationsdatei (z. B. mcp_server/mcp_config.json ).

• CONFIG : Eine JSON-Zeichenfolge, die die Konfiguration enthält.

• SECURITY : Umgebungsvariablen für Sicherheitsparameter (z. B. API-Schlüssel).

Weitere Informationen zum Laden finden Sie im Block if __name__ == "__main__": in mcp_server/main.py .

Die Datei tests/test_mcp_server.py zeigt, wie Sie den Server zum Testen programmgesteuert starten und mit ihm interagieren.

Erstellen und Veröffentlichen

Dieses Projekt verwendet Hatch zum Erstellen und Veröffentlichen. So erstellen Sie das Projekt:

hatch build

So veröffentlichen Sie das Projekt:

hatch publish

Diese Befehle sind auch über das Skript scripts/publish.sh verfügbar.