Tools reference

list_endpoints, get_endpoint, lint_spec, diff_specs en contract_test: inputs, outputs en voorbeeldresponses.

list_endpoints

Lijst elk endpoint in de catalogus op (methode, path en summary), zonder request-/responsedetail. Gebruik dit om te ontdekken wat er bestaat vóór je get_endpoint aanroept.

Optionele filter-parameter: een hoofdletterongevoelige substring-match tegen path, summary of tags.

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

get_endpoint

Geeft de volledige Copy for AI-tekst terug voor één endpoint (Purpose, Request, Parameters, Validation, Success Response en Error Responses), op basis van zijn method en 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

Controleert de geladen catalogus op speckwaliteitsproblemen: ontbrekende summary/description, ontbrekende tags, ontbrekende 4xx-/5xx-responses, ongedocumenteerde responsebeschrijvingen en dubbele operation-ID's.

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

diff_specs

Vergelijkt de geladen catalogus met een andere spec (opgegeven als path voor een lokaal bestand of url) en rapporteert toegevoegde/verwijderde endpoints plus breaking versus informatieve veldwijzigingen (nieuwe verplichte parameters, een requestBody die verplicht wordt, een verwijderde responsecode).

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

contract_test

Stuurt een echte request naar elk endpoint (of een gefilterde subset) van een al draaiende server die op de geladen spec is gebouwd, en valideert elke live response tegen het gedeclareerde schema. Het is het equivalent van een Postman-collection-runner, zonder setup.

Neemt baseUrl, een optionele headers-lijst (herhaalbare "Naam: waarde"-strings, bijv. voor auth), en een optionele filter om een subset te testen.

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)