@farming-labs/docs 0.2.53 → 0.2.55

package/dist/mcp.d.mts

@@ -1,4 +1,4 @@
-import { $ as DocsMcpConfig, It as DocsTelemetryFramework, J as DocsMcpAllowedOrigins, Ot as DocsSearchSourcePage, St as DocsSearchConfig, X as DocsMcpAuthenticate, Y as DocsMcpAuthPrincipal, an as PageAgentFrontmatter, en as OrderingItem, jt as DocsTelemetryConfig, ot as DocsObservabilityConfig, v as DocsAnalyticsConfig } from "./types-CdKu8KmO.mjs";
+import { Ft as DocsSearchSourcePage, Rt as DocsTelemetryConfig, T as DocsAnalyticsConfig, Ut as DocsTelemetryFramework, fn as PageAgentFrontmatter, kt as DocsSearchConfig, nt as DocsMcpAuthPrincipal, ot as DocsMcpConfig, pt as DocsObservabilityConfig, rt as DocsMcpAuthenticate, sn as OrderingItem, tt as DocsMcpAllowedOrigins } from "./types-R-DN23yw.mjs";
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 
 //#region src/mcp.d.ts
@@ -91,8 +91,8 @@ interface DocsMcpConfigSchemaOption {
   default?: string | boolean | number | null;
   description: string;
   docs?: string;
-  values?: string[];
-  children?: DocsMcpConfigSchemaOption[];
+  values?: readonly string[];
+  children?: readonly DocsMcpConfigSchemaOption[];
 }
 interface DocsMcpConfigSchema {
   schemaVersion: 1;
@@ -153,6 +153,18 @@ interface DocsMcpContextResult {
   context: string;
   sources: DocsMcpContextSource[];
 }
+interface DocsMcpContextOptions {
+  pages: readonly DocsMcpPage[];
+  query: string;
+  framework?: string;
+  version?: string;
+  locale?: string;
+  tokenBudget: number;
+  entry?: string;
+  siteTitle?: string;
+  /** Maximum number of ranked, deduplicated candidates to render. Defaults to 50. */
+  maxResults?: number;
+}
 interface DocsMcpPageNode {
   type: "page";
   name: string;
@@ -255,6 +267,7 @@ declare const DEFAULT_DOCS_MCP_MAX_BODY_BYTES: number;
 declare const DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS = 600;
 declare const DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS: readonly string[];
 declare const DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS: readonly string[];
+declare const DOCS_CONFIG_SCHEMA_OPTIONS: readonly DocsMcpConfigSchemaOption[];
 declare function normalizeDocsMcpRoute(route?: string): string;
 declare function resolveDocsMcpConfig(mcp?: boolean | DocsMcpConfig, defaults?: {
   defaultName?: string;
@@ -265,5 +278,10 @@ declare function createFilesystemDocsMcpSource(options?: CreateFilesystemDocsMcp
 declare function createDocsMcpServer(options: CreateDocsMcpServerOptions): Promise<McpServer>;
 declare function createDocsMcpHttpHandler(options: CreateDocsMcpServerOptions): DocsMcpHttpHandlers;
 declare function runDocsMcpStdio(options: CreateDocsMcpServerOptions): Promise<void>;
+declare function getDocsConfigSchema(filters?: {
+  option?: string;
+  query?: string;
+}): DocsMcpConfigSchema;
+declare function buildDocsMcpContext(options: DocsMcpContextOptions): Promise<DocsMcpContextResult>;
 //#endregion
-export { CreateDocsMcpServerOptions, DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS, DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS, DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS, DEFAULT_DOCS_MCP_MAX_BODY_BYTES, DocsMcpAgentContractSummary, DocsMcpCodeExample, DocsMcpConfigSchema, DocsMcpConfigSchemaOption, DocsMcpContextResult, DocsMcpContextSource, DocsMcpDocsList, DocsMcpDocsPageSummary, DocsMcpDocsSection, DocsMcpFolderNode, DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpPageNode, DocsMcpRequestContext, DocsMcpResolvedConfig, DocsMcpResolvedCorsConfig, DocsMcpResolvedSecurityConfig, DocsMcpSource, DocsMcpTaskSummary, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio };
+export { CreateDocsMcpServerOptions, DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS, DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS, DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS, DEFAULT_DOCS_MCP_MAX_BODY_BYTES, DOCS_CONFIG_SCHEMA_OPTIONS, DocsMcpAgentContractSummary, DocsMcpCodeExample, DocsMcpConfigSchema, DocsMcpConfigSchemaOption, DocsMcpContextOptions, DocsMcpContextResult, DocsMcpContextSource, DocsMcpDocsList, DocsMcpDocsPageSummary, DocsMcpDocsSection, DocsMcpFolderNode, DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpPageNode, DocsMcpRequestContext, DocsMcpResolvedConfig, DocsMcpResolvedCorsConfig, DocsMcpResolvedSecurityConfig, DocsMcpSource, DocsMcpTaskSummary, buildDocsMcpContext, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, getDocsConfigSchema, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio };