@redocly/config 0.54.0 → 0.56.0

package/lib-esm/types/config-types.d.ts

@@ -6,6 +6,7 @@ import type { RedocConfigTypes } from './redoc-types.js';
 import type { GraphQLConfigTypes } from './graphql-types.js';
 import type { productConfigSchema, productGoogleAnalyticsConfigSchema, markdownConfigSchema, amplitudeAnalyticsConfigSchema, rudderstackAnalyticsConfigSchema, segmentAnalyticsConfigSchema, gtmAnalyticsConfigSchema, googleAnalyticsConfigSchema, scorecardConfigSchema, catalogFilterSchema, catalogSchema, searchFacetsConfigSchema } from '../ex-theme-config-schemas.js';
 import type { scorecardsConfigSchema } from '../scorecards-config-schema.js';
+import type { recheckConfigSchema } from '../recheck-config-schema.js';
 import type { reuniteConfigSchema } from '../reunite-config-schema.js';
 import type { optionalEmailSettings, reasonsSettings } from '../feedback-config-schema.js';
 import type { AsyncApiConfigTypes } from './asyncapi-types.js';
@@ -31,6 +32,7 @@ export type CatalogFilterConfig = FromSchema<typeof catalogFilterSchema>;
 export type ReuniteConfig = FromSchema<typeof reuniteConfigSchema>;
 export type ScorecardConfig = FromSchema<typeof scorecardConfigSchema>;
 export type ScorecardsConfig = FromSchema<typeof scorecardsConfigSchema>;
+export type RecheckConfig = FromSchema<typeof recheckConfigSchema>;
 export type SearchFacetsConfig = FromSchema<typeof searchFacetsConfigSchema>;
 export type SkillsConfig = FromSchema<typeof skillsConfigSchema>;
 type RootRedoclyConfig = FromSchema<typeof rootRedoclyConfigSchema>;

package/lib-esm/types/index.d.ts

@@ -1,4 +1,5 @@
 export * from './api-functions-types.js';
+export * from './mcp-tools-types.js';
 export * from './config-types.js';
 export * from './portal-shared-types.js';
 export * from './catalog-entity-types.js';

package/lib-esm/types/mcp-tools-types.d.ts

@@ -0,0 +1,81 @@
+import type { JSONSchema } from 'json-schema-to-ts';
+import type { ApiFunctionsContext, ApiFunctionsContextMethods } from './api-functions-types.js';
+/** A JSON Schema (draft-07) object, as accepted by MCP tool definitions. */
+export type McpToolJsonSchema = Exclude<JSONSchema, boolean>;
+export type McpToolJsonValue = string | number | boolean | null | McpToolJsonValue[] | {
+    [key: string]: McpToolJsonValue;
+};
+/** Structurally compatible with the MCP protocol `CallToolResult`. */
+export type McpToolResult = {
+    content: Array<{
+        type: 'text' | 'image' | 'audio' | 'resource' | 'resource_link';
+        text?: string;
+        [key: string]: unknown;
+    }>;
+    structuredContent?: Record<string, unknown>;
+    isError?: boolean;
+    _meta?: Record<string, unknown>;
+};
+/** Behavior hints for MCP clients, as defined by the MCP specification. */
+export type McpToolAnnotations = {
+    title?: string;
+    readOnlyHint?: boolean;
+    destructiveHint?: boolean;
+    idempotentHint?: boolean;
+    openWorldHint?: boolean;
+};
+export type McpToolFileSystem = {
+    /**
+     * Reads a text file from the built project output (which includes a Markdown
+     * twin of every page). A path that escapes the output directory is rejected.
+     */
+    readFile: (path: string) => Promise<string>;
+};
+/** Context passed to a custom MCP tool's `execute` and `isAvailable` functions. */
+export type McpToolContext = Omit<ApiFunctionsContext, 'telemetry' | 'getKv' | keyof ApiFunctionsContextMethods> & {
+    /** Scoped file access to the built project output. */
+    fs: McpToolFileSystem;
+    /** Product names configured in the project. */
+    products?: string[];
+    /** Access token of the authenticated MCP connection. */
+    accessToken?: string;
+    /** Free-form caller metadata, parsed from the `X-Redocly-AI-Metadata` request header. */
+    metadata?: Record<string, unknown>;
+};
+/** MCP protocol metadata passed to a custom MCP tool's `execute` function. */
+export type McpToolCallExtra = {
+    sessionId?: string;
+    requestId: string | number;
+    authInfo?: {
+        token: string;
+        clientId: string;
+        scopes: string[];
+        expiresAt?: number;
+        [key: string]: unknown;
+    };
+    requestInfo?: {
+        headers: Record<string, string | string[] | undefined>;
+    };
+    _meta?: Record<string, unknown>;
+};
+/**
+ * A custom MCP tool defined by a file in an `@mcp` folder.
+ * The file's default export must satisfy this type; the tool name is the file name without extension.
+ */
+export type McpToolDefinition<TArgs extends Record<string, unknown> = Record<string, unknown>> = {
+    /** Human-readable description shown to MCP clients and AI models. */
+    description: string;
+    /** JSON Schema for the tool's input arguments. Defaults to an empty object schema. */
+    inputSchema?: McpToolJsonSchema & {
+        type?: 'object';
+    };
+    outputSchema?: McpToolJsonSchema;
+    annotations?: McpToolAnnotations;
+    /** Controls whether the tool is advertised to the current MCP connection. */
+    isAvailable?: (context: McpToolContext) => boolean | Promise<boolean>;
+    /**
+     * Runs the tool. A returned string or JSON value is wrapped into an MCP
+     * result automatically; throw an `Error` to report a failure.
+     */
+    execute: (args: TArgs, context: McpToolContext, extra: McpToolCallExtra) => McpToolResult | McpToolJsonValue | Promise<McpToolResult | McpToolJsonValue>;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/config",
-  "version": "0.54.0",
+  "version": "0.56.0",
   "license": "MIT",
   "type": "module",
   "main": "./lib/index.js",
@@ -21,14 +21,16 @@
   "devDependencies": {
     "@markdoc/markdoc": "0.5.2",
     "esbuild": "0.28.1",
-    "@redocly/openapi-core": "2.47.0",
+    "@redocly/ajv": "8.18.0",
+    "@redocly/openapi-core": "2.49.1",
     "@types/node": "24.1.0",
     "@types/react": "^19.2.7",
-    "@vitest/coverage-v8": "4.1.10",
+    "@vitest/coverage-v8": "4.1.11",
+    "ajv-formats": "^3.0.1",
     "react-router": "^8.3.0",
     "rimraf": "5.0.7",
     "typescript": "6.0.3",
-    "vitest": "4.1.10"
+    "vitest": "4.1.11"
   },
   "dependencies": {
     "json-schema-to-ts": "2.7.2"