{ "openapi": "3.1.1", "info": { "title": "NTComponents.MCP | v1", "version": "1.0.0" }, "servers": [ { "url": "https://mcp.ntcomponents.nttechnologies.dev/" } ], "paths": { "/": { "get": { "tags": [ "Service" ], "summary": "Discover the NTComponents documentation service", "description": "Returns the MCP, OpenAPI, health, and REST API locations together with current catalog counts.", "operationId": "DiscoverNTComponentsService", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceDiscovery" } } } } } } }, "/health": { "get": { "tags": [ "Service" ], "summary": "Check service health", "description": "Returns a healthy status only when the documentation catalog can be resolved and contains components and reference types.", "operationId": "GetHealth", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthStatus" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthStatus" } } } } } } }, "/api": { "get": { "tags": [ "NTComponents Documentation" ], "summary": "Get the documentation catalog overview", "description": "Returns current component and reference-type counts plus available component folders and reference kinds.", "operationId": "GetCatalogOverview", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogOverview" } } } } } } }, "/api/components": { "get": { "tags": [ "NTComponents Documentation" ], "summary": "List NT-prefixed components", "description": "Lists public NT-prefixed Blazor components with generated summaries, render compatibility, source folders, and required parameters.", "operationId": "ListNTComponents", "parameters": [ { "name": "query", "in": "query", "description": "Optional text matched against component names and generated documentation.", "schema": { "maxLength": 512, "type": "string" } }, { "name": "folder", "in": "query", "description": "Optional source folder such as Buttons, Form, Grid, Dialog, or Layout.", "schema": { "type": "string" } }, { "name": "includeObsolete", "in": "query", "description": "Include obsolete components when true.", "schema": { "type": "boolean", "default": false } }, { "name": "limit", "in": "query", "description": "Maximum number of results from 1 through 200.", "schema": { "maximum": 200, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "description": "Zero-based result offset.", "schema": { "maximum": 2147483647, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogPageOfComponentSummary" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } }, "/api/components/{name}": { "get": { "tags": [ "NTComponents Documentation" ], "summary": "Get one NT-prefixed component", "description": "Returns generated usage guidance, parameters, methods, render-mode compatibility, related enums and helpers, and obsolescence information for one component.", "operationId": "GetNTComponent", "parameters": [ { "name": "name", "in": "path", "description": "Component name or full name, for example NTButton or NTComponents.NTButton.", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "name": "includeRelatedEnumValues", "in": "query", "description": "Inline up to 20 values for each related enum when true.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComponentDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } }, "/api/references": { "get": { "tags": [ "NTComponents Documentation" ], "summary": "List NTComponents enums and helpers", "description": "Lists public enums and helper types that are part of or referenced by the NTComponents component API.", "operationId": "ListNTReferenceTypes", "parameters": [ { "name": "query", "in": "query", "description": "Optional text matched against reference-type names and generated documentation.", "schema": { "maxLength": 512, "type": "string" } }, { "name": "kind", "in": "query", "description": "Optional reference kind: Enum or Helper.", "schema": { "enum": [ "Enum", "Helper" ], "type": "string" } }, { "name": "scope", "in": "query", "description": "Optional API scope: ComponentApi or LibraryApi.", "schema": { "enum": [ "ComponentApi", "LibraryApi" ], "type": "string" } }, { "name": "includeObsolete", "in": "query", "description": "Include obsolete reference types when true.", "schema": { "type": "boolean", "default": false } }, { "name": "limit", "in": "query", "description": "Maximum number of results from 1 through 200.", "schema": { "maximum": 200, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } }, { "name": "offset", "in": "query", "description": "Zero-based result offset.", "schema": { "maximum": 2147483647, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogPageOfReferenceSummary" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } }, "/api/references/{name}": { "get": { "tags": [ "NTComponents Documentation" ], "summary": "Get one NTComponents enum or helper", "description": "Returns generated documentation, enum values or public members, obsolescence information, and the components that use one reference type.", "operationId": "GetNTReferenceType", "parameters": [ { "name": "name", "in": "path", "description": "Reference type name or full name, for example NTButtonVariant or NTComponents.NTButtonVariant.", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenceDetails" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } }, "/api/search": { "get": { "tags": [ "NTComponents Documentation" ], "summary": "Search NTComponents documentation", "description": "Returns relevance-ranked component, enum, and helper matches from the generated documentation catalog.", "operationId": "SearchNTComponents", "parameters": [ { "name": "query", "in": "query", "description": "Required text matched against component, enum, and helper documentation.", "required": true, "schema": { "maxLength": 512, "minLength": 1, "type": "string" } }, { "name": "limit", "in": "query", "description": "Maximum number of results from 1 through 200.", "schema": { "maximum": 200, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 25 } }, { "name": "offset", "in": "query", "description": "Zero-based result offset.", "schema": { "maximum": 2147483647, "minimum": 0, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentationSearchPage" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } } }, "components": { "schemas": { "CatalogOverview": { "required": [ "serverVersion", "componentsVersion", "buildRevision", "documentationBaseUrl", "componentCount", "referenceTypeCount", "componentFolders", "referenceKinds", "referenceScopes" ], "type": "object", "properties": { "serverVersion": { "type": "string" }, "componentsVersion": { "type": "string" }, "buildRevision": { "type": "string" }, "documentationBaseUrl": { "type": "string" }, "componentCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "referenceTypeCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "componentFolders": { "type": "array", "items": { "type": "string" } }, "referenceKinds": { "type": "array", "items": { "type": "string" } }, "referenceScopes": { "type": "array", "items": { "type": "string" } } } }, "CatalogPageOfComponentSummary": { "required": [ "items", "totalCount", "offset", "limit", "hasMore", "nextOffset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentSummary" } }, "totalCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "hasMore": { "type": "boolean" }, "nextOffset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "CatalogPageOfReferenceSummary": { "required": [ "items", "totalCount", "offset", "limit", "hasMore", "nextOffset" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceSummary" } }, "totalCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "hasMore": { "type": "boolean" }, "nextOffset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "ComponentDetails": { "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "folder": { "type": "string" }, "sourceFile": { "type": "string" }, "summary": { "type": "string" }, "remarks": { "type": "string" }, "renderCompatibility": { "type": "string" }, "isSsrCompatible": { "type": "boolean" }, "compatibilitySummary": { "type": "string" }, "compatibilityDetails": { "type": "string" }, "isObsolete": { "type": "boolean" }, "obsoleteMessage": { "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterDetails" } }, "methods": { "type": "array", "items": { "$ref": "#/components/schemas/MemberDetails" } }, "relatedTypes": { "type": "array", "items": { "$ref": "#/components/schemas/ReferenceSummary" } }, "relatedComponents": { "type": "array", "items": { "$ref": "#/components/schemas/ComponentSummary" } }, "usageGuidelines": { "type": "array", "items": { "type": "string" } }, "razorUsage": { "type": "string" }, "usageExamples": { "type": "array", "items": { "$ref": "#/components/schemas/UsageExample" } }, "documentationUrl": { "type": "string" }, "relatedEnums": { "type": "array", "items": { "$ref": "#/components/schemas/RelatedEnumDetails" } } } }, "ComponentSummary": { "required": [ "name", "fullName", "folder", "summary", "renderCompatibility", "isObsolete", "requiredParameters", "documentationUrl" ], "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "folder": { "type": "string" }, "summary": { "type": "string" }, "renderCompatibility": { "type": "string" }, "isObsolete": { "type": "boolean" }, "requiredParameters": { "type": "array", "items": { "type": "string" } }, "documentationUrl": { "type": "string" } } }, "DocumentationSearchPage": { "required": [ "items", "totalCount", "offset", "limit", "hasMore", "nextOffset", "didYouMean" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentationSearchResult" } }, "totalCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "offset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "hasMore": { "type": "boolean" }, "nextOffset": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "didYouMean": { "type": [ "null", "string" ] } } }, "DocumentationSearchResult": { "required": [ "name", "fullName", "category", "summary", "folder", "score", "matchedTerms", "matchedFields", "documentationUrl" ], "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "category": { "type": "string" }, "summary": { "type": "string" }, "folder": { "type": "string" }, "score": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "matchedTerms": { "type": "array", "items": { "type": "string" } }, "matchedFields": { "type": "array", "items": { "type": "string" } }, "documentationUrl": { "type": "string" } } }, "ErrorResponse": { "required": [ "error" ], "type": "object", "properties": { "error": { "type": "string" } } }, "FieldDetails": { "required": [ "name", "type", "value", "summary", "isObsolete" ], "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" }, "summary": { "type": "string" }, "isObsolete": { "type": "boolean" } } }, "HealthStatus": { "required": [ "status" ], "type": "object", "properties": { "status": { "type": "string" } } }, "HttpValidationProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "MemberDetails": { "type": "object", "properties": { "name": { "type": "string" }, "signature": { "type": "string" }, "summary": { "type": "string" }, "isInherited": { "type": "boolean" }, "isObsolete": { "type": "boolean" }, "accessibility": { "type": "string" } } }, "ParameterDetails": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "summary": { "type": "string" }, "isRequired": { "type": "boolean" }, "isCascading": { "type": "boolean" }, "isInherited": { "type": "boolean" }, "isObsolete": { "type": "boolean" }, "accessibility": { "type": "string" }, "defaultValueExpression": { "type": [ "null", "string" ] }, "category": { "type": "string" }, "categoryOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ReferenceDetails": { "required": [ "name", "fullName", "kind", "folder", "sourceFile", "summary", "remarks", "isObsolete", "obsoleteMessage", "fields", "properties", "methods", "usedByComponents", "scope", "documentationUrl" ], "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "kind": { "type": "string" }, "folder": { "type": "string" }, "sourceFile": { "type": "string" }, "summary": { "type": "string" }, "remarks": { "type": "string" }, "isObsolete": { "type": "boolean" }, "obsoleteMessage": { "type": "string" }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDetails" } }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterDetails" } }, "methods": { "type": "array", "items": { "$ref": "#/components/schemas/MemberDetails" } }, "usedByComponents": { "type": "array", "items": { "type": "string" } }, "scope": { "type": "string" }, "documentationUrl": { "type": "string" } } }, "ReferenceSummary": { "required": [ "name", "fullName", "kind", "summary", "isObsolete", "usedByComponents", "scope", "documentationUrl" ], "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "kind": { "type": "string" }, "summary": { "type": "string" }, "isObsolete": { "type": "boolean" }, "usedByComponents": { "type": "array", "items": { "type": "string" } }, "scope": { "type": "string" }, "documentationUrl": { "type": "string" } } }, "RelatedEnumDetails": { "required": [ "name", "fullName", "values", "totalValueCount", "isTruncated" ], "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/FieldDetails" } }, "totalValueCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isTruncated": { "type": "boolean" } } }, "ServiceDiscovery": { "required": [ "name", "mcp", "openApi", "health", "api", "catalog" ], "type": "object", "properties": { "name": { "type": "string" }, "mcp": { "type": "string" }, "openApi": { "type": "string" }, "health": { "type": "string" }, "api": { "type": "string" }, "catalog": { "$ref": "#/components/schemas/CatalogOverview" } } }, "UsageExample": { "required": [ "title", "description", "razor" ], "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "razor": { "type": "string" } } } } }, "tags": [ { "name": "Service" }, { "name": "NTComponents Documentation" } ] }