List Component Schemas
swagger_list_schemasList all data models (schemas) defined in a loaded OpenAPI spec, showing their types and property counts to get an overview of the API's structure.
Instructions
List all component schemas (data models) defined in the loaded OpenAPI spec.
Use this tool to get an overview of all data models used by the API, including their types and number of properties.
Args:
spec_name (string): Name of the previously loaded spec
limit (number): Maximum results to return (default: 50)
offset (number): Number of results to skip (default: 0)
Returns: { "total": number, // Total number of schemas "count": number, // Number of results in this response "offset": number, // Current pagination offset "schemas": [{ "name", "type", "description", "properties" }], "has_more": boolean, "next_offset": number }
Examples:
Use when: "What data models are defined?" -> params with spec_name=""
Use when: "Show me all schemas" -> params with spec_name=""
Error Handling:
Returns error if the spec name has not been loaded yet
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum results to return (default: 50) | |
| offset | No | Number of results to skip for pagination (default: 0) | |
| spec_name | Yes | Name of the previously loaded OpenAPI/Swagger spec (use swagger_list_loaded to see available names) |