What is docfy-mcp

Czym jest

docfy-mcp to serwer MCP (Model Context Protocol): udostępnia katalog OpenAPI (najlepiej taki, który nestjs-docfy już udokumentowało, ale działa dowolna prawidłowa specyfikacja OpenAPI 3.0/3.1) jako narzędzia, które połączony agent kodujący może wywołać bezpośrednio.

Pięć narzędzi: list_endpoints i get_endpoint do odkrywania i inspekcji endpointów, lint_spec do sprawdzania jakości specyfikacji, diff_specs do porównania z inną wersją oraz contract_test do walidacji żywego serwera względem specyfikacji.

Dlaczego istnieje

Bez tego agent implementujący klienta dla Twojego API ma dwie opcje: zgadnąć kształt z kontekstu albo poprosić człowieka o otwarcie przeglądarki, znalezienie Swagger UI i wklejenie odpowiedniego fragmentu z powrotem do czatu. Obie są wolniejsze i mniej pewne niż bezpośrednie wywołanie narzędzia.

Jak pasuje do nestjs-docfy

docfy-mcp jest zbudowany na tym samym silniku modelu dokumentu, którego używa docfy-ui: współdzielonym pakiecie docfy-core.

Wynik get_endpoint to dokładnie ten sam tekst, który kopiuje przycisk Copy for AI z docfy-ui, generowany przez tę samą funkcję operationToAiText(). Oba projekty to dwa różne front-endy nad tym samym modelem: jeden dla człowieka w przeglądarce, drugi dla agenta przez stdio.