Tools reference

list_endpoints, get_endpoint, lint_spec, diff_specs oraz contract_test: wejścia, wyjścia i przykładowe odpowiedzi.

list_endpoints

Wylistowuje każdy endpoint w katalogu (metoda, ścieżka i podsumowanie), bez szczegółów żądania/odpowiedzi. Użyj go, aby odkryć, co istnieje, przed wywołaniem get_endpoint.

Opcjonalny parametr filter: dopasowanie podłańcucha bez rozróżniania wielkości liter względem ścieżki, podsumowania albo tagów.

text
GET /
POST /auth/register — Register
POST /auth/login — Login
GET /auth/profile — Get profile

get_endpoint

Zwraca pełny tekst w formacie Copy for AI dla jednego endpointu (Purpose, Request, Parameters, Validation, Success Response i Error Responses), na podstawie jego method i path.

text
Endpoint: POST /auth/login

Purpose:
Login

Request:
{
  "email": "string",
  "password": "string"
}

Validation:
- email must be valid

Success Response (201):
{
  "success": "boolean",
  "data": { "access_token": "string", "user": { "id": "string", "role": "string" } }
}

Error Responses:
400 Bad Request

lint_spec

Sprawdza wczytany katalog pod kątem problemów z jakością specyfikacji: brakujące summary/description, brakujące tagi, brakujące odpowiedzi 4xx/5xx, nieudokumentowane opisy odpowiedzi oraz zduplikowane identyfikatory operacji.

text
✖ POST /auth/login: [missing-description] no description declared
✖ POST /auth/login: [no-error-response] no 4xx/5xx response declared

diff_specs

Porównuje wczytany katalog z inną specyfikacją (podaną jako path dla pliku lokalnego albo url) i raportuje dodane/usunięte endpointy oraz zmiany pól breaking kontra informacyjne (nowe wymagane parametry, requestBody, które stało się wymagane, usunięty kod odpowiedzi).

text
+ POST /users
- DELETE /users/{id}
! GET /users/{id}: parameter "id" (path) is now required

contract_test

Wysyła prawdziwe żądanie do każdego endpointu (albo przefiltrowanego podzbioru) już działającego serwera zbudowanego z wczytanej specyfikacji i waliduje każdą żywą odpowiedź względem jej zadeklarowanego schematu. To odpowiednik runnera kolekcji Postmana bez żadnej konfiguracji.

Przyjmuje baseUrl, opcjonalną listę headers (powtarzalne stringi „Name: value”, np. auth) oraz opcjonalny filter, by przetestować podzbiór.

text
✓ GET /users (http://localhost:3000/users) — 200, matches schema
✖ POST /users (http://localhost:3000/users) — 201, 1 mismatch(es): body.email (required property missing)