@farming-labs/docs 0.2.52 → 0.2.53
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/agent-2t4kZLGo.mjs +10 -0
- package/dist/{agent-CaOBIVFy.mjs → agent-BMxMpEa0.mjs} +194 -22
- package/dist/agent-contract-b0akaPcg.mjs +573 -0
- package/dist/agent-export--X9Go-wj.mjs +853 -0
- package/dist/{agents-DjhjZaNP.mjs → agents-CW-zTNKP.mjs} +6 -5
- package/dist/cli/index.mjs +43 -28
- package/dist/client/react.d.mts +1 -1
- package/dist/{cloud-ask-ai-DcMe6xOf.d.mts → cloud-ask-ai-CMzYVzVX.d.mts} +1 -1
- package/dist/{cloud-C_Ok9rC5.mjs → cloud-zs0qAnKJ.mjs} +3 -3
- package/dist/{codeblocks-z9iT794h.mjs → codeblocks-DWM4IJPL.mjs} +9 -12
- package/dist/{dev-Tm9Ss4D6.mjs → dev-DFeVU2Ui.mjs} +2 -2
- package/dist/docs-cloud-server.d.mts +2 -2
- package/dist/docs-cloud-server.mjs +1 -1
- package/dist/{doctor-O9o9kjN8.mjs → doctor-CkM5tKdD.mjs} +36 -24
- package/dist/{downgrade-CYEaOctn.mjs → downgrade-Dj_KXV11.mjs} +2 -2
- package/dist/i18n-CAlj1ADU.mjs +40 -0
- package/dist/index.d.mts +139 -3
- package/dist/index.mjs +7 -5
- package/dist/{init-Ch5On0zm.mjs → init-Cmz-oqnp.mjs} +3 -3
- package/dist/{mcp-DuCPNHS-.mjs → mcp-B4Q1PN93.mjs} +9 -5
- package/dist/mcp.d.mts +102 -4
- package/dist/mcp.mjs +1446 -66
- package/dist/{package-version-C8PigBZk.mjs → package-version-DxnTZH4m.mjs} +1 -1
- package/dist/{reading-time-CPAy1SWO.mjs → reading-time-BuK2YL23.mjs} +278 -33
- package/dist/{review-lm3dt7yy.mjs → review-BEsbm0l2.mjs} +38 -3
- package/dist/{robots-DV7u4Ire.mjs → robots-BOwkq9du.mjs} +5 -4
- package/dist/{robots-XVPs9lVz.mjs → robots-C6uQG-fS.mjs} +1 -1
- package/dist/{search-BWuU70B0.mjs → search-CJNLkdjX.mjs} +174 -79
- package/dist/{search-DFEhf9-s.d.mts → search-CTu6Bvq-.d.mts} +3 -1
- package/dist/{search-B6nEkx86.mjs → search-CtAXkk_J.mjs} +5 -4
- package/dist/server.d.mts +5 -5
- package/dist/server.mjs +8 -7
- package/dist/{sitemap-BEiKy4Iy.mjs → sitemap-OPb8EdNe.mjs} +6 -5
- package/dist/{sitemap-server-xEHtDUDB.mjs → sitemap-server-DnilMEiZ.mjs} +1 -1
- package/dist/{templates-uaauJcTO.mjs → templates-Bty9M6lA.mjs} +11 -5
- package/dist/{types-XqGLsmOD.d.mts → types-CdKu8KmO.d.mts} +118 -2
- package/dist/{upgrade-DzQtpgJM.mjs → upgrade-BNdBB9tQ.mjs} +2 -2
- package/package.json +1 -1
- package/dist/agent-DXDOMJBw.mjs +0 -9
- /package/dist/{cloud-ask-ai-Cl-xaV8j.mjs → cloud-ask-ai-BFlx8VMO.mjs} +0 -0
- /package/dist/{config-tiQCZ46q.mjs → config-DhIyFsy9.mjs} +0 -0
- /package/dist/{errors-CW1LnxaQ.mjs → errors-BxfYhp1L.mjs} +0 -0
- /package/dist/{review-B7goPYUb.mjs → review-BHdy75TE.mjs} +0 -0
- /package/dist/{utils-D-xTRNuh.mjs → utils-CMZTjRQT.mjs} +0 -0
package/dist/index.d.mts
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { $ as
|
|
2
|
-
import { $ as createDocsAgentTraceId, A as resolveDocsSitemapRequest, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, I as PromptAction, J as DOCS_AGENT_TRACE_EVENT_TYPES, L as PromptProviderChoice, O as resolveDocsSitemapConfig, Q as createDocsAgentTraceContext, R as SerializeOpenDocsProviderOptions, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, X as ResolvedDocsAnalyticsConfig, Y as DocsAgentTraceContext, Z as ResolvedDocsObservabilityConfig, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, at as resolveDocsObservabilityConfig, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAgentTraceEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, it as resolveDocsAnalyticsConfig, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, nt as emitDocsObservabilityEvent, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, r as createAlgoliaSearchAdapter, rt as getDocsRequestAnalyticsProperties, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsAnalyticsEvent, u as performDocsSearch, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider } from "./search-
|
|
1
|
+
import { $ as DocsMcpConfig, $t as OpenGraphImage, A as DocsAskAIMcpConfig, At as DocsTelemetryAgentSurface, B as DocsCodeBlocksRunnerProvider, Bt as GithubConfig, C as DocsAnalyticsSource, Cn as TypesenseDocsSearchConfig, Ct as DocsSearchDocument, D as DocsAskAIFeedbackData, Dt as DocsSearchResultType, E as DocsAskAIFeedbackConfig, Et as DocsSearchResult, F as DocsCloudPublishConfig, Ft as DocsTelemetryFeatures, G as DocsFeedbackData, Gt as LlmsTxtSectionConfig, H as DocsCodeBlocksValidationMode, Ht as LlmsTxtConfig, I as DocsCodeBlocksConfig, It as DocsTelemetryFramework, J as DocsMcpAllowedOrigins, Jt as OpenDocsConfig, K as DocsFeedbackValue, Kt as McpDocsSearchConfig, L as DocsCodeBlocksPlannerConfig, Lt as DocsTheme, M as DocsCloudConfig, Mt as DocsTelemetryEvent, N as DocsCloudFeatureConfig, Nt as DocsTelemetryEventInput, O as DocsAskAIFeedbackMessage, Ot as DocsSearchSourcePage, P as DocsCloudPreviewConfig, Pt as DocsTelemetryEventType, Q as DocsMcpAuthenticateResult, Qt as OpenDocsTarget, R as DocsCodeBlocksPlannerProvider, Rt as FeedbackConfig, S as DocsAnalyticsInput, Sn as ThemeToggleConfig, St as DocsSearchConfig, T as DocsAskAIActionType, Tn as UIConfig, Tt as DocsSearchQuery, U as DocsCodeBlocksValidationPolicy, Ut as LlmsTxtMaxCharsConfig, V as DocsCodeBlocksValidateConfig, Vt as LastUpdatedConfig, W as DocsConfig, Wt as LlmsTxtMaxCharsMode, X as DocsMcpAuthenticate, Xt as OpenDocsProviderConfig, Y as DocsMcpAuthPrincipal, Yt as OpenDocsProvider, Z as DocsMcpAuthenticateContext, Zt as OpenDocsProviderId, _ as DocsAgentTraceStatus, _n as SidebarFolderNode, _t as DocsRobotsRule, a as ApiReferenceRenderer, an as PageAgentFrontmatter, at as DocsNav, b as DocsAnalyticsEventInput, bn as SidebarTree, bt as DocsSearchAdapterFactory, c as ChangelogFrontmatter, cn as PageOpenGraph, ct as DocsObservabilityEventInput, d as CopyMarkdownFormat, dn as ReadingTimeConfig, dt as DocsReviewCiMode, en as OrderingItem, et as DocsMcpCorsConfig, f as CustomDocsSearchConfig, fn as ReadingTimeFormat, ft as DocsReviewConfig, g as DocsAgentTraceEventType, gn as SidebarFolderIndexBehavior, gt as DocsRobotsConfig, h as DocsAgentTraceEventInput, hn as SidebarConfig, ht as DocsReviewSeverity, i as ApiReferenceConfig, in as PageAgentFailureMode, it as DocsMetadata, j as DocsCloudApiKeyConfig, jt as DocsTelemetryConfig, k as DocsAskAIFeedbackValue, kt as DocsSitemapConfig, l as CodeBlockCopyData, ln as PageSidebarFrontmatter, lt as DocsRelatedItem, m as DocsAgentFeedbackData, mn as SidebarComponentProps, mt as DocsReviewScoreConfig, n as AgentFeedbackConfig, nn as PageAgentAppliesTo, nt as DocsMcpSecurityConfig, o as BreadcrumbConfig, on as PageAgentVerification, ot as DocsObservabilityConfig, p as DocsAgentFeedbackContext, pn as ResolvedDocsRelatedLink, pt as DocsReviewRulesConfig, q as DocsI18nConfig, qt as OGConfig, r as AlgoliaDocsSearchConfig, rn as PageAgentCommand, rt as DocsMcpToolsConfig, s as ChangelogConfig, sn as PageFrontmatter, st as DocsObservabilityEvent, t as AIConfig, tn as PageActionsConfig, tt as DocsMcpOriginContext, u as CopyMarkdownConfig, un as PageTwitter, ut as DocsReviewCiConfig, v as DocsAnalyticsConfig, vn as SidebarNode, vt as DocsSearchAdapter, w as DocsAskAIActionData, wn as TypographyConfig, wt as DocsSearchEmbeddingsConfig, x as DocsAnalyticsEventType, xn as SimpleDocsSearchConfig, xt as DocsSearchChunkingConfig, y as DocsAnalyticsEvent, yn as SidebarPageNode, yt as DocsSearchAdapterContext, z as DocsCodeBlocksRunnerConfig, zt as FontStyle } from "./types-CdKu8KmO.mjs";
|
|
2
|
+
import { $ as createDocsAgentTraceId, A as resolveDocsSitemapRequest, C as buildDocsSitemapManifest, D as renderDocsSitemapXml, E as renderDocsSitemapMarkdown, I as PromptAction, J as DOCS_AGENT_TRACE_EVENT_TYPES, L as PromptProviderChoice, O as resolveDocsSitemapConfig, Q as createDocsAgentTraceContext, R as SerializeOpenDocsProviderOptions, S as DocsSitemapResolvedConfig, T as readDocsSitemapManifestFromContentMap, X as ResolvedDocsAnalyticsConfig, Y as DocsAgentTraceContext, Z as ResolvedDocsObservabilityConfig, _ as DEFAULT_SITEMAP_XML_ROUTE, a as createMcpSearchAdapter, at as resolveDocsObservabilityConfig, b as DocsSitemapManifestPage, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, et as emitDocsAgentTraceEvent, f as resolveSearchRequestConfig, g as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, h as DEFAULT_SITEMAP_MD_ROUTE, i as createCustomSearchAdapter, it as resolveDocsAnalyticsConfig, j as toDocsSitemapMarkdownUrl, k as resolveDocsSitemapPageLastmod, l as inferDocsAskAIPackageHints, m as DEFAULT_SITEMAP_MD_DOCS_ROUTE, n as buildDocsSearchDocuments, nt as emitDocsObservabilityEvent, o as createSimpleSearchAdapter, p as DEFAULT_SITEMAP_MANIFEST_PATH, r as createAlgoliaSearchAdapter, rt as getDocsRequestAnalyticsProperties, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, tt as emitDocsAnalyticsEvent, u as performDocsSearch, v as DocsSitemapFormat, w as createDocsSitemapResponse, x as DocsSitemapPageInput, y as DocsSitemapManifest, z as SerializedOpenDocsProvider } from "./search-CTu6Bvq-.mjs";
|
|
3
3
|
import { DocsMcpPage, DocsMcpResolvedConfig } from "./mcp.mjs";
|
|
4
4
|
|
|
5
5
|
//#region src/define-docs.d.ts
|
|
@@ -123,6 +123,58 @@ declare function resolveDocsI18n(config?: DocsI18nConfig | null): ResolvedDocsI1
|
|
|
123
123
|
declare function resolveDocsLocale(searchParams: URLSearchParams, i18n?: ResolvedDocsI18n | null): string | undefined;
|
|
124
124
|
declare function resolveDocsPath(pathname: string, entry: string): DocsPathMatch;
|
|
125
125
|
//#endregion
|
|
126
|
+
//#region src/agent-conformance.d.ts
|
|
127
|
+
declare const DOCS_AGENT_CONTRACT_VERSION = "1.0";
|
|
128
|
+
type DocsAgentAdapter = "next" | "tanstack-start" | "sveltekit" | "astro" | "nuxt";
|
|
129
|
+
type DocsAgentContractSurface = "discovery" | "config" | "diagnostics" | "feedback-schema" | "markdown" | "markdown-accept" | "markdown-locale" | "markdown-missing" | "llms" | "llms-full" | "agents" | "skill" | "sitemap-xml" | "sitemap-markdown" | "robots" | "mcp";
|
|
130
|
+
interface DocsAgentContractRequest {
|
|
131
|
+
url: string;
|
|
132
|
+
init?: RequestInit;
|
|
133
|
+
}
|
|
134
|
+
interface DocsAgentContractExpectation {
|
|
135
|
+
statuses: readonly number[];
|
|
136
|
+
contentTypes: readonly string[];
|
|
137
|
+
bodyIncludes?: readonly string[];
|
|
138
|
+
}
|
|
139
|
+
interface DocsAgentContractCase {
|
|
140
|
+
surface: DocsAgentContractSurface;
|
|
141
|
+
request: DocsAgentContractRequest;
|
|
142
|
+
expect: DocsAgentContractExpectation;
|
|
143
|
+
}
|
|
144
|
+
interface DocsAgentConformanceCaseResult {
|
|
145
|
+
surface: DocsAgentContractSurface;
|
|
146
|
+
passed: boolean;
|
|
147
|
+
status?: number;
|
|
148
|
+
contentType?: string;
|
|
149
|
+
issues: string[];
|
|
150
|
+
}
|
|
151
|
+
interface DocsAgentConformanceReport {
|
|
152
|
+
adapter: DocsAgentAdapter;
|
|
153
|
+
contractVersion: typeof DOCS_AGENT_CONTRACT_VERSION;
|
|
154
|
+
passed: boolean;
|
|
155
|
+
cases: DocsAgentConformanceCaseResult[];
|
|
156
|
+
}
|
|
157
|
+
interface RunDocsAgentConformanceOptions {
|
|
158
|
+
adapter: DocsAgentAdapter;
|
|
159
|
+
/** Origin used to construct requests. Defaults to http://localhost. */
|
|
160
|
+
origin?: string;
|
|
161
|
+
/** Public docs entry. Defaults to docs. */
|
|
162
|
+
entry?: string;
|
|
163
|
+
/** Locale fixture expected to render the word "Bonjour". Set false to skip. */
|
|
164
|
+
locale?: string | false;
|
|
165
|
+
handle(request: Request, surface: DocsAgentContractSurface): Response | Promise<Response>;
|
|
166
|
+
}
|
|
167
|
+
/**
|
|
168
|
+
* The framework-neutral public surface every first-party adapter must implement.
|
|
169
|
+
* Adapter tests consume this list so new routes and invariants are added once.
|
|
170
|
+
*/
|
|
171
|
+
declare function createDocsAgentContractCases(options?: {
|
|
172
|
+
origin?: string;
|
|
173
|
+
entry?: string;
|
|
174
|
+
locale?: string | false;
|
|
175
|
+
}): DocsAgentContractCase[];
|
|
176
|
+
declare function runDocsAgentConformance(options: RunDocsAgentConformanceOptions): Promise<DocsAgentConformanceReport>;
|
|
177
|
+
//#endregion
|
|
126
178
|
//#region src/metadata.d.ts
|
|
127
179
|
interface DocsStructuredDataBreadcrumb {
|
|
128
180
|
name: string;
|
|
@@ -136,6 +188,8 @@ interface DocsPageStructuredDataInput {
|
|
|
136
188
|
entry?: string;
|
|
137
189
|
dateModified?: string;
|
|
138
190
|
breadcrumbs?: DocsStructuredDataBreadcrumb[];
|
|
191
|
+
/** Optional actionable page contract represented as a Schema.org HowTo. */
|
|
192
|
+
agent?: PageAgentFrontmatter;
|
|
139
193
|
}
|
|
140
194
|
/**
|
|
141
195
|
* Resolve page title using metadata titleTemplate.
|
|
@@ -202,6 +256,30 @@ declare function resolveReadingTimeFromSource(source: string, wordsPerMinute?: n
|
|
|
202
256
|
declare function normalizeDocsRelated(value: unknown): ResolvedDocsRelatedLink[];
|
|
203
257
|
declare function renderDocsRelatedMarkdownLines(related: ResolvedDocsRelatedLink[] | undefined): string[];
|
|
204
258
|
//#endregion
|
|
259
|
+
//#region src/agent-contract.d.ts
|
|
260
|
+
interface PageAgentFrontmatterIssue {
|
|
261
|
+
path: string;
|
|
262
|
+
message: string;
|
|
263
|
+
}
|
|
264
|
+
declare const PAGE_AGENT_CONTRACT_START_MARKER = "<!-- farming-labs:agent-contract:start -->";
|
|
265
|
+
declare const PAGE_AGENT_CONTRACT_END_MARKER = "<!-- farming-labs:agent-contract:end -->";
|
|
266
|
+
/**
|
|
267
|
+
* Normalize untrusted page frontmatter into the stable agent contract shape.
|
|
268
|
+
* Invalid fields are omitted so malformed author input cannot break page delivery.
|
|
269
|
+
*/
|
|
270
|
+
declare function normalizePageAgentFrontmatter(value: unknown): PageAgentFrontmatter | undefined;
|
|
271
|
+
declare function hasStructuredPageAgentContract(value: unknown): boolean;
|
|
272
|
+
/** Return author-facing validation issues without throwing. */
|
|
273
|
+
declare function getPageAgentFrontmatterIssues(value: unknown): PageAgentFrontmatterIssue[];
|
|
274
|
+
/** Render normalized `agent` YAML in a stable field order. */
|
|
275
|
+
declare function renderPageAgentFrontmatterYamlLines(value: unknown, indentation?: number): string[];
|
|
276
|
+
/** Render the structured contract as deterministic, compact machine-readable Markdown. */
|
|
277
|
+
declare function renderPageAgentContractMarkdown(value: unknown): string;
|
|
278
|
+
/** Remove generated contract blocks while preserving handwritten guidance. */
|
|
279
|
+
declare function stripGeneratedPageAgentContractMarkdown(markdown: string): string;
|
|
280
|
+
/** Insert one generated contract unless the document already has handwritten contract guidance. */
|
|
281
|
+
declare function upsertPageAgentContractMarkdown(markdown: string, value: unknown): string;
|
|
282
|
+
//#endregion
|
|
205
283
|
//#region src/sidebar.d.ts
|
|
206
284
|
interface SidebarFolderIndexBehaviorOptions {
|
|
207
285
|
sidebar: boolean | SidebarConfig | undefined;
|
|
@@ -433,6 +511,8 @@ interface DocsLlmsTxtRequest {
|
|
|
433
511
|
}
|
|
434
512
|
interface DocsLlmsTxtPageInput {
|
|
435
513
|
url: string;
|
|
514
|
+
/** Override the Markdown link emitted in llms.txt. */
|
|
515
|
+
markdownUrl?: string;
|
|
436
516
|
title: string;
|
|
437
517
|
description?: string;
|
|
438
518
|
content: string;
|
|
@@ -491,14 +571,21 @@ interface DocsSkillDocumentOptions {
|
|
|
491
571
|
};
|
|
492
572
|
}
|
|
493
573
|
interface DocsAgentsDocumentOptions extends DocsSkillDocumentOptions {}
|
|
574
|
+
interface DocsAgentContractMcpTools {
|
|
575
|
+
list?: "list_tasks";
|
|
576
|
+
read?: "read_task";
|
|
577
|
+
}
|
|
494
578
|
interface DocsMarkdownPage {
|
|
495
579
|
slug?: string;
|
|
496
580
|
url: string;
|
|
497
581
|
title: string;
|
|
498
582
|
description?: string;
|
|
583
|
+
/** Override the public Markdown representation URL when it differs from `${url}.md`. */
|
|
584
|
+
markdownUrl?: string;
|
|
499
585
|
lastModified?: string;
|
|
500
586
|
lastmod?: string;
|
|
501
587
|
related?: ResolvedDocsRelatedLink[];
|
|
588
|
+
agent?: PageAgentFrontmatter;
|
|
502
589
|
content: string;
|
|
503
590
|
rawContent?: string;
|
|
504
591
|
agentContent?: string;
|
|
@@ -535,6 +622,18 @@ interface DocsMarkdownCanonicalUrlOptions {
|
|
|
535
622
|
requestedPath: string;
|
|
536
623
|
locale?: string | null;
|
|
537
624
|
}
|
|
625
|
+
interface DocsMarkdownResponseOptions extends DocsMarkdownNotFoundOptions {
|
|
626
|
+
request: Request;
|
|
627
|
+
document: string | null;
|
|
628
|
+
/** Override the human-readable canonical URL, for example when docsPath differs from entry. */
|
|
629
|
+
canonicalUrl?: string;
|
|
630
|
+
/** Override the selected Markdown representation URL. */
|
|
631
|
+
contentLocation?: string;
|
|
632
|
+
locale?: string | null;
|
|
633
|
+
/** Exact source modification timestamp. Date-only values are intentionally ignored. */
|
|
634
|
+
lastModified?: string | Date | null;
|
|
635
|
+
cacheControl?: string;
|
|
636
|
+
}
|
|
538
637
|
declare function normalizeDocsPathSegment(value: string): string;
|
|
539
638
|
declare function normalizeDocsUrlPath(value: string): string;
|
|
540
639
|
declare function isDocsConfigRequest(url: URL): boolean;
|
|
@@ -609,12 +708,16 @@ declare function renderDocsMarkdownNotFound({
|
|
|
609
708
|
pages,
|
|
610
709
|
sitemap
|
|
611
710
|
}: DocsMarkdownNotFoundOptions): string;
|
|
711
|
+
/** Build one standards-aware Markdown response for every framework adapter. */
|
|
712
|
+
declare function createDocsMarkdownResponse(options: DocsMarkdownResponseOptions): Response;
|
|
612
713
|
declare function findDocsMarkdownPage<T extends DocsMarkdownPage>(entry: string, pages: T[], requestedPath: string): T | null;
|
|
613
714
|
declare function renderDocsMarkdownDocument(page: DocsMcpPage | DocsSearchSourcePage, options?: DocsMarkdownDocumentOptions): string;
|
|
614
715
|
declare function renderDocsMarkdownDocument(page: DocsMarkdownPage, options?: DocsMarkdownDocumentOptions): string;
|
|
615
716
|
declare function renderDocsSkillDocument(options: DocsSkillDocumentOptions): string;
|
|
616
717
|
declare function renderDocsAgentsDocument(options: DocsAgentsDocumentOptions): string;
|
|
617
718
|
declare function resolveDocsAgentMdxContent(content: string, audience: "human" | "agent"): string;
|
|
719
|
+
/** Resolve only the task tools that the advertised MCP endpoint actually exposes. */
|
|
720
|
+
declare function resolveDocsAgentContractMcpTools(mcp: DocsMcpResolvedConfig): DocsAgentContractMcpTools | undefined;
|
|
618
721
|
declare function buildDocsAgentDiscoverySpec({
|
|
619
722
|
origin,
|
|
620
723
|
entry,
|
|
@@ -648,6 +751,7 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
648
751
|
markdownRoutes: boolean;
|
|
649
752
|
agentMdOverrides: boolean;
|
|
650
753
|
agentBlocks: boolean;
|
|
754
|
+
structuredAgentContracts: boolean;
|
|
651
755
|
agents: boolean;
|
|
652
756
|
llms: boolean;
|
|
653
757
|
skills: boolean;
|
|
@@ -687,6 +791,33 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
687
791
|
apiPattern: string;
|
|
688
792
|
resolutionOrder: string[];
|
|
689
793
|
};
|
|
794
|
+
agentContract: {
|
|
795
|
+
usefulContractFields: string[];
|
|
796
|
+
fields: {
|
|
797
|
+
tokenBudget: string;
|
|
798
|
+
task: string;
|
|
799
|
+
outcome: string;
|
|
800
|
+
appliesTo: {
|
|
801
|
+
framework: string;
|
|
802
|
+
version: string;
|
|
803
|
+
package: string;
|
|
804
|
+
};
|
|
805
|
+
prerequisites: string;
|
|
806
|
+
files: string;
|
|
807
|
+
commands: string;
|
|
808
|
+
sideEffects: string;
|
|
809
|
+
verification: string;
|
|
810
|
+
rollback: string;
|
|
811
|
+
failureModes: string;
|
|
812
|
+
};
|
|
813
|
+
mcpTools?: DocsAgentContractMcpTools | undefined;
|
|
814
|
+
enabled: boolean;
|
|
815
|
+
schemaVersion: string;
|
|
816
|
+
source: string;
|
|
817
|
+
frontmatterPath: string;
|
|
818
|
+
markdownSection: string;
|
|
819
|
+
mcpField: string;
|
|
820
|
+
};
|
|
690
821
|
llms: {
|
|
691
822
|
sections?: {
|
|
692
823
|
title: string;
|
|
@@ -736,6 +867,7 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
736
867
|
fields: string[];
|
|
737
868
|
canonicalUrlField: string;
|
|
738
869
|
breadcrumbType: string;
|
|
870
|
+
agentContractType: string;
|
|
739
871
|
};
|
|
740
872
|
openapi: {
|
|
741
873
|
enabled: boolean;
|
|
@@ -789,10 +921,13 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
789
921
|
listDocs: boolean;
|
|
790
922
|
listPages: boolean;
|
|
791
923
|
readPage: boolean;
|
|
924
|
+
listTasks?: boolean;
|
|
925
|
+
readTask?: boolean;
|
|
792
926
|
searchDocs: boolean;
|
|
793
927
|
getNavigation: boolean;
|
|
794
928
|
getCodeExamples: boolean;
|
|
795
929
|
getConfigSchema: boolean;
|
|
930
|
+
getContext: boolean;
|
|
796
931
|
};
|
|
797
932
|
};
|
|
798
933
|
feedback: {
|
|
@@ -810,6 +945,7 @@ declare function buildDocsAgentDiscoverySpec({
|
|
|
810
945
|
doNotAssumeFeedbackPayloadShape: boolean;
|
|
811
946
|
};
|
|
812
947
|
};
|
|
948
|
+
declare function acceptsDocsMarkdown(request: Request): boolean;
|
|
813
949
|
declare function resolveDocsOpenApiDiscoveryConfig(openapi?: boolean | DocsOpenApiDiscoveryConfig): DocsOpenApiResolvedDiscoveryConfig;
|
|
814
950
|
//#endregion
|
|
815
951
|
//#region src/robots.d.ts
|
|
@@ -855,4 +991,4 @@ declare function renderDocsRobotsGeneratedBlock(options?: DocsRobotsRenderOption
|
|
|
855
991
|
declare function upsertDocsRobotsGeneratedBlock(existing: string, block: string): string;
|
|
856
992
|
declare function analyzeDocsRobotsTxt(content: string, options?: DocsRobotsRenderOptions): DocsRobotsAnalysis;
|
|
857
993
|
//#endregion
|
|
858
|
-
export { type AIConfig, type AgentFeedbackConfig, type AlgoliaDocsSearchConfig, type ApiReferenceConfig, type ApiReferenceRenderer, type BreadcrumbConfig, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CopyMarkdownConfig, type CopyMarkdownFormat, type CustomDocsSearchConfig, DEFAULT_AGENTS_MD_ROUTE, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, DEFAULT_AGENT_FEEDBACK_ROUTE, DEFAULT_AGENT_MD_ROUTE, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_DOCS_CONFIG_FORMAT, DEFAULT_DOCS_CONFIG_ROUTE, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_ROUTE, DEFAULT_LLMS_FULL_TXT_ROUTE, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, DEFAULT_LLMS_TXT_MAX_CHARS, DEFAULT_LLMS_TXT_ROUTE, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, DEFAULT_OPENAPI_SCHEMA_ROUTE, DEFAULT_ROBOTS_TXT_ROUTE, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, type DocsAgentDiscoverySpecOptions, type DocsAgentFeedbackContext, type DocsAgentFeedbackData, type DocsAgentFeedbackDiscoveryConfig, type DocsAgentFeedbackRequest, type DocsAgentFeedbackResolvedConfig, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAgentsDocumentOptions, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAnalyticsEventType, type DocsAnalyticsInput, type DocsAnalyticsSource, type DocsAskAIActionData, type DocsAskAIActionType, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsCloudApiKeyConfig, type DocsCloudConfig, type DocsCloudFeatureConfig, type DocsCloudPreviewConfig, type DocsCloudPublishConfig, type DocsCodeBlocksConfig, type DocsCodeBlocksPlannerConfig, type DocsCodeBlocksPlannerProvider, type DocsCodeBlocksRunnerConfig, type DocsCodeBlocksRunnerProvider, type DocsCodeBlocksValidateConfig, type DocsCodeBlocksValidationMode, type DocsCodeBlocksValidationPolicy, type DocsConfig, type DocsConfigMap, type DocsConfigMapJsonValue, type DocsConfigMapPointer, type DocsDiagnostics, type DocsDiagnosticsFeature, type DocsDiagnosticsIssue, type DocsDiagnosticsIssueSeverity, type DocsDiagnosticsOptions, type DocsDiagnosticsStatus, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsLlmsDiscoveryConfig, type DocsLlmsTxtGeneratedContent, type DocsLlmsTxtGeneratedSection, type DocsLlmsTxtMaxCharsIssue, type DocsLlmsTxtPageInput, type DocsLlmsTxtRequest, type DocsLlmsTxtResolvedMaxChars, type DocsLlmsTxtResolvedSection, type DocsLlmsTxtSelectedContent, type DocsMarkdownAgentDetection, type DocsMarkdownPage, type DocsMarkdownRecoveryMatch, type DocsMarkdownRecoveryResult, type DocsMcpConfig, type DocsMcpEndpointCandidate, type DocsMcpEndpointCandidateOptions, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsOpenApiDiscoveryConfig, type DocsOpenApiResolvedDiscoveryConfig, type DocsPageStructuredDataInput, type DocsPathMatch, type DocsRelatedItem, type DocsReviewCiConfig, type DocsReviewCiMode, type DocsReviewConfig, type DocsReviewRulesConfig, type DocsReviewScoreConfig, type DocsReviewSeverity, type DocsRobotsConfig, type DocsRobotsRenderOptions, type DocsRobotsResolvedConfig, type DocsRobotsRule, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchChunkingConfig, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchEmbeddingsConfig, type DocsSearchQuery, type DocsSearchResult, type DocsSearchResultType, type DocsSearchSourcePage, type DocsSitemapConfig, type DocsSitemapFormat, type DocsSitemapManifest, type DocsSitemapManifestPage, type DocsSitemapPageInput, type DocsSitemapResolvedConfig, type DocsSkillDocumentOptions, type DocsStructuredDataBreadcrumb, type DocsTelemetryAgentSurface, type DocsTelemetryAgentSurfaceContext, type DocsTelemetryAgentSurfaceRequestOptions, type DocsTelemetryConfig, type DocsTelemetryContext, type DocsTelemetryEvent, type DocsTelemetryEventInput, type DocsTelemetryEventType, type DocsTelemetryFeatures, type DocsTelemetryFramework, type DocsTheme, type FeedbackConfig, type FontStyle, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, type GeneratedAgentProvenance, type GeneratedAgentSourceKind, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type LlmsTxtMaxCharsConfig, type LlmsTxtMaxCharsMode, type LlmsTxtSectionConfig, type McpDocsSearchConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenDocsProviderConfig, type OpenDocsProviderId, type OpenDocsTarget, type OpenGraphImage, type OrderingItem, type PageActionsConfig, type PageFrontmatter, type PageOpenGraph, type PageSidebarFrontmatter, type PageTwitter, type PromptAction, type PromptProviderChoice, type ReadingTimeConfig, type ReadingTimeFormat, type ResolvedChangelogConfig, type ResolvedDocsAnalyticsConfig, type ResolvedDocsI18n, type ResolvedDocsObservabilityConfig, type ResolvedDocsRelatedLink, type ResolvedDocsTelemetryConfig, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, type SidebarComponentProps, type SidebarConfig, type SidebarFolderIndexBehavior, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type SimpleDocsSearchConfig, type ThemeToggleConfig, type TypesenseDocsSearchConfig, type TypographyConfig, type UIConfig, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, hasDocsMarkdownSignatureAgent, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, validateDocsAgentFeedbackPayload };
|
|
994
|
+
export { type AIConfig, type AgentFeedbackConfig, type AlgoliaDocsSearchConfig, type ApiReferenceConfig, type ApiReferenceRenderer, type BreadcrumbConfig, type ChangelogConfig, type ChangelogEntrySummary, type ChangelogFrontmatter, type CodeBlockCopyData, type CopyMarkdownConfig, type CopyMarkdownFormat, type CustomDocsSearchConfig, DEFAULT_AGENTS_MD_ROUTE, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, DEFAULT_AGENT_FEEDBACK_ROUTE, DEFAULT_AGENT_MD_ROUTE, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_DOCS_CONFIG_FORMAT, DEFAULT_DOCS_CONFIG_ROUTE, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_ROUTE, DEFAULT_LLMS_FULL_TXT_ROUTE, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, DEFAULT_LLMS_TXT_MAX_CHARS, DEFAULT_LLMS_TXT_ROUTE, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, DEFAULT_OPENAPI_SCHEMA_ROUTE, DEFAULT_ROBOTS_TXT_ROUTE, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_AGENT_CONTRACT_VERSION, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, type DocsAgentAdapter, type DocsAgentConformanceCaseResult, type DocsAgentConformanceReport, type DocsAgentContractCase, type DocsAgentContractExpectation, type DocsAgentContractMcpTools, type DocsAgentContractRequest, type DocsAgentContractSurface, type DocsAgentDiscoverySpecOptions, type DocsAgentFeedbackContext, type DocsAgentFeedbackData, type DocsAgentFeedbackDiscoveryConfig, type DocsAgentFeedbackRequest, type DocsAgentFeedbackResolvedConfig, type DocsAgentTraceContext, type DocsAgentTraceEventInput, type DocsAgentTraceEventType, type DocsAgentTraceStatus, type DocsAgentsDocumentOptions, type DocsAnalyticsConfig, type DocsAnalyticsEvent, type DocsAnalyticsEventInput, type DocsAnalyticsEventType, type DocsAnalyticsInput, type DocsAnalyticsSource, type DocsAskAIActionData, type DocsAskAIActionType, type DocsAskAIFeedbackConfig, type DocsAskAIFeedbackData, type DocsAskAIFeedbackMessage, type DocsAskAIFeedbackValue, type DocsAskAIMcpConfig, type DocsCloudApiKeyConfig, type DocsCloudConfig, type DocsCloudFeatureConfig, type DocsCloudPreviewConfig, type DocsCloudPublishConfig, type DocsCodeBlocksConfig, type DocsCodeBlocksPlannerConfig, type DocsCodeBlocksPlannerProvider, type DocsCodeBlocksRunnerConfig, type DocsCodeBlocksRunnerProvider, type DocsCodeBlocksValidateConfig, type DocsCodeBlocksValidationMode, type DocsCodeBlocksValidationPolicy, type DocsConfig, type DocsConfigMap, type DocsConfigMapJsonValue, type DocsConfigMapPointer, type DocsDiagnostics, type DocsDiagnosticsFeature, type DocsDiagnosticsIssue, type DocsDiagnosticsIssueSeverity, type DocsDiagnosticsOptions, type DocsDiagnosticsStatus, type DocsFeedbackData, type DocsFeedbackValue, type DocsI18nConfig, type DocsLlmsDiscoveryConfig, type DocsLlmsTxtGeneratedContent, type DocsLlmsTxtGeneratedSection, type DocsLlmsTxtMaxCharsIssue, type DocsLlmsTxtPageInput, type DocsLlmsTxtRequest, type DocsLlmsTxtResolvedMaxChars, type DocsLlmsTxtResolvedSection, type DocsLlmsTxtSelectedContent, type DocsMarkdownAgentDetection, type DocsMarkdownPage, type DocsMarkdownRecoveryMatch, type DocsMarkdownRecoveryResult, type DocsMarkdownResponseOptions, type DocsMcpAllowedOrigins, type DocsMcpAuthPrincipal, type DocsMcpAuthenticate, type DocsMcpAuthenticateContext, type DocsMcpAuthenticateResult, type DocsMcpConfig, type DocsMcpCorsConfig, type DocsMcpEndpointCandidate, type DocsMcpEndpointCandidateOptions, type DocsMcpOriginContext, type DocsMcpSecurityConfig, type DocsMcpToolsConfig, type DocsMetadata, type DocsNav, type DocsObservabilityConfig, type DocsObservabilityEvent, type DocsObservabilityEventInput, type DocsOpenApiDiscoveryConfig, type DocsOpenApiResolvedDiscoveryConfig, type DocsPageStructuredDataInput, type DocsPathMatch, type DocsRelatedItem, type DocsReviewCiConfig, type DocsReviewCiMode, type DocsReviewConfig, type DocsReviewRulesConfig, type DocsReviewScoreConfig, type DocsReviewSeverity, type DocsRobotsConfig, type DocsRobotsRenderOptions, type DocsRobotsResolvedConfig, type DocsRobotsRule, type DocsSearchAdapter, type DocsSearchAdapterContext, type DocsSearchAdapterFactory, type DocsSearchChunkingConfig, type DocsSearchConfig, type DocsSearchDocument, type DocsSearchEmbeddingsConfig, type DocsSearchQuery, type DocsSearchResult, type DocsSearchResultType, type DocsSearchSourcePage, type DocsSitemapConfig, type DocsSitemapFormat, type DocsSitemapManifest, type DocsSitemapManifestPage, type DocsSitemapPageInput, type DocsSitemapResolvedConfig, type DocsSkillDocumentOptions, type DocsStructuredDataBreadcrumb, type DocsTelemetryAgentSurface, type DocsTelemetryAgentSurfaceContext, type DocsTelemetryAgentSurfaceRequestOptions, type DocsTelemetryConfig, type DocsTelemetryContext, type DocsTelemetryEvent, type DocsTelemetryEventInput, type DocsTelemetryEventType, type DocsTelemetryFeatures, type DocsTelemetryFramework, type DocsTheme, type FeedbackConfig, type FontStyle, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, type GeneratedAgentProvenance, type GeneratedAgentSourceKind, type GithubConfig, type LastUpdatedConfig, type LlmsTxtConfig, type LlmsTxtMaxCharsConfig, type LlmsTxtMaxCharsMode, type LlmsTxtSectionConfig, type McpDocsSearchConfig, type OGConfig, type OpenDocsConfig, type OpenDocsProvider, type OpenDocsProviderConfig, type OpenDocsProviderId, type OpenDocsTarget, type OpenGraphImage, type OrderingItem, PAGE_AGENT_CONTRACT_END_MARKER, PAGE_AGENT_CONTRACT_START_MARKER, type PageActionsConfig, type PageAgentAppliesTo, type PageAgentCommand, type PageAgentFailureMode, type PageAgentFrontmatter, type PageAgentFrontmatterIssue, type PageAgentVerification, type PageFrontmatter, type PageOpenGraph, type PageSidebarFrontmatter, type PageTwitter, type PromptAction, type PromptProviderChoice, type ReadingTimeConfig, type ReadingTimeFormat, type ResolvedChangelogConfig, type ResolvedDocsAnalyticsConfig, type ResolvedDocsI18n, type ResolvedDocsObservabilityConfig, type ResolvedDocsRelatedLink, type ResolvedDocsTelemetryConfig, type RunDocsAgentConformanceOptions, type SerializeOpenDocsProviderOptions, type SerializedOpenDocsProvider, type SidebarComponentProps, type SidebarConfig, type SidebarFolderIndexBehavior, type SidebarFolderNode, type SidebarNode, type SidebarPageNode, type SidebarTree, type SimpleDocsSearchConfig, type ThemeToggleConfig, type TypesenseDocsSearchConfig, type TypographyConfig, type UIConfig, acceptsDocsMarkdown, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentContractCases, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, getPageAgentFrontmatterIssues, hasDocsMarkdownSignatureAgent, hasStructuredPageAgentContract, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, renderPageAgentContractMarkdown, renderPageAgentFrontmatterYamlLines, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentContractMcpTools, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, runDocsAgentConformance, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, stripGeneratedPageAgentContractMarkdown, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, upsertPageAgentContractMarkdown, validateDocsAgentFeedbackPayload };
|
package/dist/index.mjs
CHANGED
|
@@ -1,7 +1,9 @@
|
|
|
1
|
-
import { _ as extendTheme, a as resolveReadingTimeOptions, b as defineDocs, c as buildPageTwitter, d as resolveOGImage, f as resolveTitle, g as createTheme, h as
|
|
1
|
+
import { _ as extendTheme, a as resolveReadingTimeOptions, b as defineDocs, c as buildPageTwitter, d as resolveOGImage, f as resolveTitle, g as createTheme, h as runDocsAgentConformance, i as resolveReadingTimeFromSource, l as renderDocsPageStructuredDataJson, m as createDocsAgentContractCases, n as resolvePageReadingTime, o as buildDocsPageStructuredData, p as DOCS_AGENT_CONTRACT_VERSION, r as resolveReadingTimeFromContent, s as buildPageOpenGraph, t as estimateReadingTimeMinutes, u as resolveDocsMetadataBaseUrl, v as deepMerge, y as resolveChangelogConfig } from "./reading-time-BuK2YL23.mjs";
|
|
2
2
|
import { a as emitDocsAnalyticsEvent, c as resolveDocsAnalyticsConfig, i as emitDocsAgentTraceEvent, l as resolveDocsObservabilityConfig, n as createDocsAgentTraceContext, o as emitDocsObservabilityEvent, r as createDocsAgentTraceId, s as getDocsRequestAnalyticsProperties, t as DOCS_AGENT_TRACE_EVENT_TYPES } from "./analytics-BZEwTK-8.mjs";
|
|
3
|
-
import {
|
|
4
|
-
import { A as
|
|
5
|
-
import { a as
|
|
3
|
+
import { a as normalizePageAgentFrontmatter, c as stripGeneratedPageAgentContractMarkdown, i as hasStructuredPageAgentContract, l as upsertPageAgentContractMarkdown, n as PAGE_AGENT_CONTRACT_START_MARKER, o as renderPageAgentContractMarkdown, r as getPageAgentFrontmatterIssues, s as renderPageAgentFrontmatterYamlLines, t as PAGE_AGENT_CONTRACT_END_MARKER } from "./agent-contract-b0akaPcg.mjs";
|
|
4
|
+
import { $ as normalizeDocsUrlPath, A as acceptsDocsMarkdown, At as renderDocsSitemapMarkdown, B as getDocsMarkdownCanonicalLinkHeader, C as DEFAULT_OPENAPI_SCHEMA_ROUTE, Ct as DEFAULT_SITEMAP_MD_DOCS_ROUTE, D as DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, Dt as buildDocsSitemapManifest, E as DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, Et as DEFAULT_SITEMAP_XML_ROUTE, F as buildDocsMcpEndpointCandidates, Ft as toDocsSitemapMarkdownUrl, G as isDocsConfigRequest, H as hasDocsMarkdownSignatureAgent, I as createDocsMarkdownResponse, It as normalizeDocsRelated, J as isDocsMcpRequest, K as isDocsDiagnosticsRequest, L as detectDocsMarkdownAgentRequest, Lt as renderDocsRelatedMarkdownLines, M as buildDocsAgentFeedbackSchema, Mt as resolveDocsSitemapConfig, N as buildDocsConfigMap, Nt as resolveDocsSitemapPageLastmod, O as DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, Ot as createDocsSitemapResponse, P as buildDocsDiagnostics, Pt as resolveDocsSitemapRequest, Q as normalizeDocsPathSegment, R as findDocsMarkdownPage, S as DEFAULT_MCP_WELL_KNOWN_ROUTE, St as DEFAULT_SITEMAP_MANIFEST_PATH, T as DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, Tt as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, U as isDocsAgentDiscoveryRequest, V as getDocsMarkdownVaryHeader, W as isDocsAgentsRequest, X as isDocsSkillRequest, Y as isDocsPublicGetRequest, Z as matchesDocsLlmsTxtSection, _ as DEFAULT_LLMS_TXT_MAX_CHARS, _t as resolveDocsOpenApiDiscoveryConfig, a as DEFAULT_AGENT_MD_ROUTE, at as renderDocsSkillDocument, b as DEFAULT_MCP_PUBLIC_ROUTE, bt as toDocsMarkdownUrl, c as DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, ct as resolveDocsAgentFeedbackRequest, d as DEFAULT_DOCS_CONFIG_FORMAT, dt as resolveDocsLlmsTxtFormat, et as parseDocsAgentFeedbackData, f as DEFAULT_DOCS_CONFIG_ROUTE, ft as resolveDocsLlmsTxtRequest, g as DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, gt as resolveDocsMarkdownRequest, h as DEFAULT_LLMS_FULL_TXT_ROUTE, ht as resolveDocsMarkdownRecovery, i as DEFAULT_AGENT_FEEDBACK_ROUTE, it as renderDocsMarkdownNotFound, j as buildDocsAgentDiscoverySpec, jt as renderDocsSitemapXml, k as DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, kt as readDocsSitemapManifestFromContentMap, l as DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, lt as resolveDocsAgentMdxContent, m as DEFAULT_DOCS_DIAGNOSTICS_ROUTE, mt as resolveDocsMarkdownCanonicalUrl, n as DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, nt as renderDocsLlmsTxt, o as DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, ot as resolveDocsAgentContractMcpTools, p as DEFAULT_DOCS_DIAGNOSTICS_FORMAT, pt as resolveDocsLlmsTxtSections, q as isDocsLlmsTxtPublicRequest, r as DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, rt as renderDocsMarkdownDocument, s as DEFAULT_AGENT_SPEC_ROUTE, st as resolveDocsAgentFeedbackConfig, t as DEFAULT_AGENTS_MD_ROUTE, tt as renderDocsAgentsDocument, u as DEFAULT_DOCS_API_ROUTE, ut as resolveDocsAgentsFormat, v as DEFAULT_LLMS_TXT_ROUTE, vt as resolveDocsSkillFormat, w as DEFAULT_SKILL_MD_ROUTE, wt as DEFAULT_SITEMAP_MD_ROUTE, x as DEFAULT_MCP_ROUTE, xt as validateDocsAgentFeedbackPayload, y as DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, yt as selectDocsLlmsTxtContent, z as getDocsLlmsTxtMaxCharsIssue } from "./agent-BMxMpEa0.mjs";
|
|
5
|
+
import { A as getDocsTelemetryFeatures, C as resolvePageSidebarFolderIndexBehavior, D as emitDocsTelemetryEvent, E as emitDocsTelemetryAgentSurfaceEvent, M as resolveDocsTelemetryConfig, O as emitDocsTelemetryMcpToolEvent, S as applySidebarFolderIndexBehavior, T as resolveSidebarFolderIndexBehaviorForPath, _ as hashGeneratedAgentContent, a as createMcpSearchAdapter, b as serializeGeneratedAgentDocument, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, f as resolveSearchRequestConfig, g as GENERATED_AGENT_PROVENANCE_VERSION, h as GENERATED_AGENT_PROVENANCE_MARKER, i as createCustomSearchAdapter, j as inferDocsTelemetryAgentSurface, k as emitDocsTelemetryProjectEvent, l as inferDocsAskAIPackageHints, n as buildDocsSearchDocuments, o as createSimpleSearchAdapter, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, u as performDocsSearch, v as normalizeGeneratedAgentContent, w as resolveSidebarFolderIndexBehavior, x as stripGeneratedAgentProvenance, y as parseGeneratedAgentDocument } from "./search-CJNLkdjX.mjs";
|
|
6
|
+
import { n as resolveDocsLocale, r as resolveDocsPath, t as resolveDocsI18n } from "./i18n-CAlj1ADU.mjs";
|
|
7
|
+
import { a as analyzeDocsRobotsTxt, c as renderDocsRobotsGeneratedBlock, d as resolveDocsRobotsRequest, f as upsertDocsRobotsGeneratedBlock, i as DOCS_ROBOTS_GENERATED_BLOCK_START, l as renderDocsRobotsTxt, n as DEFAULT_ROBOTS_TXT_ROUTE, o as createDocsRobotsResponse, r as DOCS_ROBOTS_GENERATED_BLOCK_END, s as getDocsRobotsAllowRoutes, t as DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, u as resolveDocsRobotsConfig } from "./robots-C6uQG-fS.mjs";
|
|
6
8
|
|
|
7
|
-
export { DEFAULT_AGENTS_MD_ROUTE, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, DEFAULT_AGENT_FEEDBACK_ROUTE, DEFAULT_AGENT_MD_ROUTE, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_DOCS_CONFIG_FORMAT, DEFAULT_DOCS_CONFIG_ROUTE, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_ROUTE, DEFAULT_LLMS_FULL_TXT_ROUTE, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, DEFAULT_LLMS_TXT_MAX_CHARS, DEFAULT_LLMS_TXT_ROUTE, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, DEFAULT_OPENAPI_SCHEMA_ROUTE, DEFAULT_ROBOTS_TXT_ROUTE, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, hasDocsMarkdownSignatureAgent, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, validateDocsAgentFeedbackPayload };
|
|
9
|
+
export { DEFAULT_AGENTS_MD_ROUTE, DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, DEFAULT_AGENT_FEEDBACK_ROUTE, DEFAULT_AGENT_MD_ROUTE, DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, DEFAULT_AGENT_SPEC_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, DEFAULT_DOCS_AI_ROBOTS_USER_AGENTS, DEFAULT_DOCS_API_ROUTE, DEFAULT_DOCS_CONFIG_FORMAT, DEFAULT_DOCS_CONFIG_ROUTE, DEFAULT_DOCS_DIAGNOSTICS_FORMAT, DEFAULT_DOCS_DIAGNOSTICS_ROUTE, DEFAULT_LLMS_FULL_TXT_ROUTE, DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, DEFAULT_LLMS_TXT_MAX_CHARS, DEFAULT_LLMS_TXT_ROUTE, DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, DEFAULT_MCP_PUBLIC_ROUTE, DEFAULT_MCP_ROUTE, DEFAULT_MCP_WELL_KNOWN_ROUTE, DEFAULT_OPENAPI_SCHEMA_ROUTE, DEFAULT_ROBOTS_TXT_ROUTE, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_DOCS_ROUTE, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DEFAULT_SKILL_MD_ROUTE, DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, DOCS_AGENT_CONTRACT_VERSION, DOCS_AGENT_TRACE_EVENT_TYPES, DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, DOCS_ROBOTS_GENERATED_BLOCK_END, DOCS_ROBOTS_GENERATED_BLOCK_START, DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, GENERATED_AGENT_PROVENANCE_MARKER, GENERATED_AGENT_PROVENANCE_VERSION, PAGE_AGENT_CONTRACT_END_MARKER, PAGE_AGENT_CONTRACT_START_MARKER, acceptsDocsMarkdown, analyzeDocsRobotsTxt, applySidebarFolderIndexBehavior, buildDocsAgentDiscoverySpec, buildDocsAgentFeedbackSchema, buildDocsAskAIContext, buildDocsConfigMap, buildDocsDiagnostics, buildDocsMcpEndpointCandidates, buildDocsPageStructuredData, buildDocsSearchDocuments, buildDocsSitemapManifest, buildPageOpenGraph, buildPageTwitter, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentContractCases, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsMarkdownResponse, createDocsRobotsResponse, createDocsSitemapResponse, createMcpSearchAdapter, createSimpleSearchAdapter, createTheme, createTypesenseSearchAdapter, deepMerge, defineDocs, detectDocsMarkdownAgentRequest, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, emitDocsTelemetryAgentSurfaceEvent, emitDocsTelemetryEvent, emitDocsTelemetryMcpToolEvent, emitDocsTelemetryProjectEvent, estimateReadingTimeMinutes, extendTheme, findDocsMarkdownPage, formatDocsAskAIPackageHints, getDocsLlmsTxtMaxCharsIssue, getDocsMarkdownCanonicalLinkHeader, getDocsMarkdownVaryHeader, getDocsRequestAnalyticsProperties, getDocsRobotsAllowRoutes, getDocsTelemetryFeatures, getPageAgentFrontmatterIssues, hasDocsMarkdownSignatureAgent, hasStructuredPageAgentContract, hashGeneratedAgentContent, inferDocsAskAIPackageHints, inferDocsTelemetryAgentSurface, isDocsAgentDiscoveryRequest, isDocsAgentsRequest, isDocsConfigRequest, isDocsDiagnosticsRequest, isDocsLlmsTxtPublicRequest, isDocsMcpRequest, isDocsPublicGetRequest, isDocsSkillRequest, matchesDocsLlmsTxtSection, normalizeDocsPathSegment, normalizeDocsRelated, normalizeDocsUrlPath, normalizeGeneratedAgentContent, normalizePageAgentFrontmatter, parseDocsAgentFeedbackData, parseGeneratedAgentDocument, performDocsSearch, readDocsSitemapManifestFromContentMap, renderDocsAgentsDocument, renderDocsLlmsTxt, renderDocsMarkdownDocument, renderDocsMarkdownNotFound, renderDocsPageStructuredDataJson, renderDocsRelatedMarkdownLines, renderDocsRobotsGeneratedBlock, renderDocsRobotsTxt, renderDocsSitemapMarkdown, renderDocsSitemapXml, renderDocsSkillDocument, renderPageAgentContractMarkdown, renderPageAgentFrontmatterYamlLines, resolveAskAISearchRequestConfig, resolveChangelogConfig, resolveDocsAgentContractMcpTools, resolveDocsAgentFeedbackConfig, resolveDocsAgentFeedbackRequest, resolveDocsAgentMdxContent, resolveDocsAgentsFormat, resolveDocsAnalyticsConfig, resolveDocsI18n, resolveDocsLlmsTxtFormat, resolveDocsLlmsTxtRequest, resolveDocsLlmsTxtSections, resolveDocsLocale, resolveDocsMarkdownCanonicalUrl, resolveDocsMarkdownRecovery, resolveDocsMarkdownRequest, resolveDocsMetadataBaseUrl, resolveDocsObservabilityConfig, resolveDocsOpenApiDiscoveryConfig, resolveDocsPath, resolveDocsRobotsConfig, resolveDocsRobotsRequest, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolveDocsSkillFormat, resolveDocsTelemetryConfig, resolveOGImage, resolvePageReadingTime, resolvePageSidebarFolderIndexBehavior, resolveReadingTimeFromContent, resolveReadingTimeFromSource, resolveReadingTimeOptions, resolveSearchRequestConfig, resolveSidebarFolderIndexBehavior, resolveSidebarFolderIndexBehaviorForPath, resolveTitle, runDocsAgentConformance, selectDocsLlmsTxtContent, serializeGeneratedAgentDocument, stripGeneratedAgentProvenance, stripGeneratedPageAgentContractMarkdown, toDocsMarkdownUrl, toDocsSitemapMarkdownUrl, upsertDocsRobotsGeneratedBlock, upsertPageAgentContractMarkdown, validateDocsAgentFeedbackPayload };
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { a as devInstallCommand, c as fileExists, d as readFileSafe, f as spawnAndWaitFor, i as detectPackageManagerFromProject, l as formatPackageManagerDetection, n as detectGlobalCssFiles, o as exec, p as writeFileSafe, r as detectNextAppDir, t as detectFramework, u as installCommand } from "./utils-
|
|
2
|
-
import { $ as svelteDocsPublicHookTemplate, A as nextConfigMergedTemplate, B as nuxtServerApiDocsRouteTemplate, C as injectRootProviderIntoLayout, D as injectTanstackVitePlugins, E as injectTanstackRootProviderIntoRoute, F as nuxtDocsConfigTemplate, G as quickstartPageTemplate, H as nuxtServerDocsPublicMiddlewareTemplate, I as nuxtDocsPageTemplate, J as svelteDocsApiRouteTemplate, K as rootLayoutTemplate, L as nuxtGlobalCssTemplate, M as nextLocaleDocPageTemplate, N as nextLocalizedPageTemplate, O as installationPageTemplate, P as nuxtConfigTemplate, Q as svelteDocsPageTemplate, R as nuxtInstallationPageTemplate, S as injectNuxtCssImport, T as injectSvelteDocsPublicHook, U as nuxtWelcomePageTemplate, V as nuxtServerApiReferenceRouteTemplate, W as postcssConfigTemplate, X as svelteDocsLayoutServerTemplate, Y as svelteDocsConfigTemplate, Z as svelteDocsLayoutTemplate, _ as getAstroAdapterPkg, _t as tanstackViteConfigTemplate, a as astroDocsIndexTemplate, at as svelteWelcomePageTemplate, b as injectAstroDocsMiddleware, bt as welcomePageTemplate, c as astroDocsServerTemplate, ct as tanstackDocsCatchAllRouteTemplate, d as astroQuickstartPageTemplate, dt as tanstackDocsIndexRouteTemplate, et as svelteDocsServerTemplate, f as astroWelcomePageTemplate, ft as tanstackDocsPublicRouteTemplate, g as docsLayoutTemplate, gt as tanstackRootRouteTemplate, h as docsConfigTemplate, ht as tanstackQuickstartPageTemplate, i as astroDocsConfigTemplate, it as svelteRootLayoutTemplate, j as nextConfigTemplate, k as nextApiReferencePageTemplate, l as astroGlobalCssTemplate, lt as tanstackDocsConfigTemplate, m as customThemeTsTemplate, mt as tanstackInstallationPageTemplate, n as astroApiRouteTemplate, nt as svelteInstallationPageTemplate, o as astroDocsMiddlewareTemplate, ot as tanstackApiDocsRouteTemplate, p as customThemeCssTemplate, pt as tanstackDocsServerTemplate, q as svelteApiReferenceRouteTemplate, r as astroConfigTemplate, rt as svelteQuickstartPageTemplate, s as astroDocsPageTemplate, st as tanstackApiReferenceRouteTemplate, t as astroApiReferenceRouteTemplate, tt as svelteGlobalCssTemplate, u as astroInstallationPageTemplate, ut as tanstackDocsFunctionsTemplate, v as globalCssTemplate, vt as tanstackWelcomePageTemplate, w as injectSvelteCssImport, x as injectCssImport, y as injectAstroCssImport, yt as tsconfigTemplate, z as nuxtQuickstartPageTemplate } from "./templates-
|
|
1
|
+
import { a as devInstallCommand, c as fileExists, d as readFileSafe, f as spawnAndWaitFor, i as detectPackageManagerFromProject, l as formatPackageManagerDetection, n as detectGlobalCssFiles, o as exec, p as writeFileSafe, r as detectNextAppDir, t as detectFramework, u as installCommand } from "./utils-CMZTjRQT.mjs";
|
|
2
|
+
import { $ as svelteDocsPublicHookTemplate, A as nextConfigMergedTemplate, B as nuxtServerApiDocsRouteTemplate, C as injectRootProviderIntoLayout, D as injectTanstackVitePlugins, E as injectTanstackRootProviderIntoRoute, F as nuxtDocsConfigTemplate, G as quickstartPageTemplate, H as nuxtServerDocsPublicMiddlewareTemplate, I as nuxtDocsPageTemplate, J as svelteDocsApiRouteTemplate, K as rootLayoutTemplate, L as nuxtGlobalCssTemplate, M as nextLocaleDocPageTemplate, N as nextLocalizedPageTemplate, O as installationPageTemplate, P as nuxtConfigTemplate, Q as svelteDocsPageTemplate, R as nuxtInstallationPageTemplate, S as injectNuxtCssImport, T as injectSvelteDocsPublicHook, U as nuxtWelcomePageTemplate, V as nuxtServerApiReferenceRouteTemplate, W as postcssConfigTemplate, X as svelteDocsLayoutServerTemplate, Y as svelteDocsConfigTemplate, Z as svelteDocsLayoutTemplate, _ as getAstroAdapterPkg, _t as tanstackViteConfigTemplate, a as astroDocsIndexTemplate, at as svelteWelcomePageTemplate, b as injectAstroDocsMiddleware, bt as welcomePageTemplate, c as astroDocsServerTemplate, ct as tanstackDocsCatchAllRouteTemplate, d as astroQuickstartPageTemplate, dt as tanstackDocsIndexRouteTemplate, et as svelteDocsServerTemplate, f as astroWelcomePageTemplate, ft as tanstackDocsPublicRouteTemplate, g as docsLayoutTemplate, gt as tanstackRootRouteTemplate, h as docsConfigTemplate, ht as tanstackQuickstartPageTemplate, i as astroDocsConfigTemplate, it as svelteRootLayoutTemplate, j as nextConfigTemplate, k as nextApiReferencePageTemplate, l as astroGlobalCssTemplate, lt as tanstackDocsConfigTemplate, m as customThemeTsTemplate, mt as tanstackInstallationPageTemplate, n as astroApiRouteTemplate, nt as svelteInstallationPageTemplate, o as astroDocsMiddlewareTemplate, ot as tanstackApiDocsRouteTemplate, p as customThemeCssTemplate, pt as tanstackDocsServerTemplate, q as svelteApiReferenceRouteTemplate, r as astroConfigTemplate, rt as svelteQuickstartPageTemplate, s as astroDocsPageTemplate, st as tanstackApiReferenceRouteTemplate, t as astroApiReferenceRouteTemplate, tt as svelteGlobalCssTemplate, u as astroInstallationPageTemplate, ut as tanstackDocsFunctionsTemplate, v as globalCssTemplate, vt as tanstackWelcomePageTemplate, w as injectSvelteCssImport, x as injectCssImport, y as injectAstroCssImport, yt as tsconfigTemplate, z as nuxtQuickstartPageTemplate } from "./templates-Bty9M6lA.mjs";
|
|
3
3
|
import fs from "node:fs";
|
|
4
4
|
import path from "node:path";
|
|
5
5
|
import pc from "picocolors";
|
|
@@ -188,7 +188,7 @@ async function configureDocsCloudOnboarding(options) {
|
|
|
188
188
|
enabled = cloudAnswer;
|
|
189
189
|
}
|
|
190
190
|
if (!enabled) return;
|
|
191
|
-
const { initCloudConfig } = await import("./cloud-
|
|
191
|
+
const { initCloudConfig } = await import("./cloud-zs0qAnKJ.mjs");
|
|
192
192
|
printDocsCloudOnboardingInstructions(await initCloudConfig({
|
|
193
193
|
rootDir: options.rootDir,
|
|
194
194
|
configPath: getDocsCloudConfigPathForFramework(options.framework)
|
|
@@ -1,9 +1,10 @@
|
|
|
1
|
-
import "./agent-
|
|
2
|
-
import "./
|
|
3
|
-
import "./
|
|
1
|
+
import "./agent-contract-b0akaPcg.mjs";
|
|
2
|
+
import "./agent-BMxMpEa0.mjs";
|
|
3
|
+
import "./search-CJNLkdjX.mjs";
|
|
4
|
+
import "./sitemap-server-DnilMEiZ.mjs";
|
|
4
5
|
import { createFilesystemDocsMcpSource, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
|
|
5
6
|
import "./server.mjs";
|
|
6
|
-
import { c as readNavTitle, m as resolveDocsContentDir, n as extractObjectLiteral, o as readBooleanProperty, p as resolveDocsConfigPath, u as readStringProperty } from "./config-
|
|
7
|
+
import { c as readNavTitle, m as resolveDocsContentDir, n as extractObjectLiteral, o as readBooleanProperty, p as resolveDocsConfigPath, u as readStringProperty } from "./config-DhIyFsy9.mjs";
|
|
7
8
|
import { readFileSync } from "node:fs";
|
|
8
9
|
import pc from "picocolors";
|
|
9
10
|
|
|
@@ -86,11 +87,14 @@ function readMcpConfig(content) {
|
|
|
86
87
|
tools: {
|
|
87
88
|
listDocs: readBooleanProperty(block, "listDocs"),
|
|
88
89
|
listPages: readBooleanProperty(block, "listPages"),
|
|
90
|
+
listTasks: readBooleanProperty(block, "listTasks"),
|
|
91
|
+
readTask: readBooleanProperty(block, "readTask"),
|
|
89
92
|
readPage: readBooleanProperty(block, "readPage"),
|
|
90
93
|
searchDocs: readBooleanProperty(block, "searchDocs"),
|
|
91
94
|
getNavigation: readBooleanProperty(block, "getNavigation"),
|
|
92
95
|
getCodeExamples: readBooleanProperty(block, "getCodeExamples"),
|
|
93
|
-
getConfigSchema: readBooleanProperty(block, "getConfigSchema")
|
|
96
|
+
getConfigSchema: readBooleanProperty(block, "getConfigSchema"),
|
|
97
|
+
getContext: readBooleanProperty(block, "getContext")
|
|
94
98
|
}
|
|
95
99
|
};
|
|
96
100
|
}
|
package/dist/mcp.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
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";
|
|
2
2
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
3
|
|
|
4
4
|
//#region src/mcp.d.ts
|
|
@@ -8,9 +8,14 @@ interface DocsMcpPage {
|
|
|
8
8
|
title: string;
|
|
9
9
|
description?: string;
|
|
10
10
|
related?: DocsSearchSourcePage["related"];
|
|
11
|
+
agent?: PageAgentFrontmatter;
|
|
11
12
|
icon?: string;
|
|
12
13
|
sourcePath?: string;
|
|
13
14
|
lastModified?: string;
|
|
15
|
+
locale?: string;
|
|
16
|
+
framework?: string;
|
|
17
|
+
version?: string;
|
|
18
|
+
tags?: string[];
|
|
14
19
|
content: string;
|
|
15
20
|
rawContent?: string;
|
|
16
21
|
agentContent?: string;
|
|
@@ -41,10 +46,26 @@ interface DocsMcpDocsPageSummary {
|
|
|
41
46
|
url: string;
|
|
42
47
|
title: string;
|
|
43
48
|
description?: string;
|
|
49
|
+
agent?: DocsMcpAgentContractSummary;
|
|
44
50
|
icon?: string;
|
|
45
51
|
sourcePath?: string;
|
|
46
52
|
lastModified?: string;
|
|
47
53
|
}
|
|
54
|
+
interface DocsMcpAgentContractSummary {
|
|
55
|
+
hasContract: boolean;
|
|
56
|
+
task?: string;
|
|
57
|
+
outcome?: string;
|
|
58
|
+
appliesTo?: PageAgentFrontmatter["appliesTo"];
|
|
59
|
+
}
|
|
60
|
+
interface DocsMcpTaskSummary {
|
|
61
|
+
slug: string;
|
|
62
|
+
url: string;
|
|
63
|
+
title: string;
|
|
64
|
+
description?: string;
|
|
65
|
+
task?: string;
|
|
66
|
+
outcome?: string;
|
|
67
|
+
appliesTo?: PageAgentFrontmatter["appliesTo"];
|
|
68
|
+
}
|
|
48
69
|
interface DocsMcpDocsSection {
|
|
49
70
|
slug: string;
|
|
50
71
|
title: string;
|
|
@@ -88,6 +109,50 @@ interface DocsMcpConfigSchema {
|
|
|
88
109
|
code: string;
|
|
89
110
|
}>;
|
|
90
111
|
}
|
|
112
|
+
interface DocsMcpContextSource {
|
|
113
|
+
id: string;
|
|
114
|
+
title: string;
|
|
115
|
+
/** Page URL without a fragment. */
|
|
116
|
+
pageUrl: string;
|
|
117
|
+
/** Source URL for this exact context chunk, including its heading anchor when available. */
|
|
118
|
+
url: string;
|
|
119
|
+
section?: string;
|
|
120
|
+
anchor?: string;
|
|
121
|
+
sourcePath?: string;
|
|
122
|
+
lastModified?: string;
|
|
123
|
+
locale?: string;
|
|
124
|
+
framework?: string;
|
|
125
|
+
version?: string;
|
|
126
|
+
tags?: string[];
|
|
127
|
+
score?: number;
|
|
128
|
+
content: string;
|
|
129
|
+
/** JavaScript string length for this source's content only. */
|
|
130
|
+
chars: number;
|
|
131
|
+
/** Encoded UTF-8 bytes for this source's content only. */
|
|
132
|
+
utf8Bytes: number;
|
|
133
|
+
truncated: boolean;
|
|
134
|
+
}
|
|
135
|
+
interface DocsMcpContextResult {
|
|
136
|
+
query: string;
|
|
137
|
+
filters: {
|
|
138
|
+
framework?: string;
|
|
139
|
+
version?: string;
|
|
140
|
+
locale?: string;
|
|
141
|
+
};
|
|
142
|
+
budget: {
|
|
143
|
+
/** Caller-provided token target; retained as the stable input contract. */requestedTokens: number; /** Dependency-free conservative accounting strategy. */
|
|
144
|
+
strategy: "utf8-bytes"; /** Hard UTF-8 byte ceiling for the complete assembled `context`. */
|
|
145
|
+
maxUtf8Bytes: number; /** Exact UTF-8 bytes used by the complete assembled `context`. */
|
|
146
|
+
usedUtf8Bytes: number; /** Conservative token-count upper bound derived from `usedUtf8Bytes`. */
|
|
147
|
+
conservativeTokenUpperBound: number;
|
|
148
|
+
remainingUtf8Bytes: number;
|
|
149
|
+
truncated: boolean;
|
|
150
|
+
};
|
|
151
|
+
resultCount: number;
|
|
152
|
+
candidateCount: number;
|
|
153
|
+
context: string;
|
|
154
|
+
sources: DocsMcpContextSource[];
|
|
155
|
+
}
|
|
91
156
|
interface DocsMcpPageNode {
|
|
92
157
|
type: "page";
|
|
93
158
|
name: string;
|
|
@@ -110,8 +175,27 @@ interface DocsMcpNavigationTree {
|
|
|
110
175
|
interface DocsMcpSource {
|
|
111
176
|
entry?: string;
|
|
112
177
|
siteTitle?: string;
|
|
113
|
-
getPages(locale?: string): DocsMcpPage[] | Promise<DocsMcpPage[]>;
|
|
114
|
-
getNavigation(locale?: string): DocsMcpNavigationTree | Promise<DocsMcpNavigationTree>;
|
|
178
|
+
getPages(locale?: string, context?: DocsMcpRequestContext): DocsMcpPage[] | Promise<DocsMcpPage[]>;
|
|
179
|
+
getNavigation(locale?: string, context?: DocsMcpRequestContext): DocsMcpNavigationTree | Promise<DocsMcpNavigationTree>;
|
|
180
|
+
}
|
|
181
|
+
/** Request-scoped identity available to custom MCP sources. */
|
|
182
|
+
interface DocsMcpRequestContext {
|
|
183
|
+
transport: "http" | "stdio";
|
|
184
|
+
request?: Request;
|
|
185
|
+
auth?: DocsMcpAuthPrincipal;
|
|
186
|
+
}
|
|
187
|
+
interface DocsMcpResolvedSecurityConfig {
|
|
188
|
+
allowedOrigins: DocsMcpAllowedOrigins;
|
|
189
|
+
authenticate?: DocsMcpAuthenticate;
|
|
190
|
+
maxBodyBytes: number;
|
|
191
|
+
cors: DocsMcpResolvedCorsConfig;
|
|
192
|
+
}
|
|
193
|
+
interface DocsMcpResolvedCorsConfig {
|
|
194
|
+
enabled: boolean;
|
|
195
|
+
allowedHeaders: string[];
|
|
196
|
+
exposedHeaders: string[];
|
|
197
|
+
allowCredentials: boolean;
|
|
198
|
+
maxAgeSeconds: number;
|
|
115
199
|
}
|
|
116
200
|
interface DocsMcpResolvedConfig {
|
|
117
201
|
enabled: boolean;
|
|
@@ -122,11 +206,16 @@ interface DocsMcpResolvedConfig {
|
|
|
122
206
|
listDocs: boolean;
|
|
123
207
|
listPages: boolean;
|
|
124
208
|
readPage: boolean;
|
|
209
|
+
listTasks?: boolean;
|
|
210
|
+
readTask?: boolean;
|
|
125
211
|
searchDocs: boolean;
|
|
126
212
|
getNavigation: boolean;
|
|
127
213
|
getCodeExamples: boolean;
|
|
128
214
|
getConfigSchema: boolean;
|
|
215
|
+
getContext: boolean;
|
|
129
216
|
};
|
|
217
|
+
/** Resolved HTTP-only security policy. Omitted on manually constructed legacy values. */
|
|
218
|
+
security?: DocsMcpResolvedSecurityConfig;
|
|
130
219
|
}
|
|
131
220
|
interface DocsMcpHttpHandlers {
|
|
132
221
|
GET: (context: {
|
|
@@ -138,6 +227,9 @@ interface DocsMcpHttpHandlers {
|
|
|
138
227
|
DELETE: (context: {
|
|
139
228
|
request: Request;
|
|
140
229
|
}) => Promise<Response>;
|
|
230
|
+
OPTIONS: (context: {
|
|
231
|
+
request: Request;
|
|
232
|
+
}) => Promise<Response>;
|
|
141
233
|
}
|
|
142
234
|
interface CreateDocsMcpServerOptions {
|
|
143
235
|
source: DocsMcpSource;
|
|
@@ -149,6 +241,8 @@ interface CreateDocsMcpServerOptions {
|
|
|
149
241
|
observability?: boolean | DocsObservabilityConfig;
|
|
150
242
|
defaultName?: string;
|
|
151
243
|
defaultVersion?: string;
|
|
244
|
+
/** Internal request context used to expose an authenticated principal to custom sources. */
|
|
245
|
+
requestContext?: DocsMcpRequestContext;
|
|
152
246
|
}
|
|
153
247
|
interface CreateFilesystemDocsMcpSourceOptions {
|
|
154
248
|
rootDir?: string;
|
|
@@ -157,6 +251,10 @@ interface CreateFilesystemDocsMcpSourceOptions {
|
|
|
157
251
|
siteTitle?: string;
|
|
158
252
|
ordering?: "alphabetical" | "numeric" | OrderingItem[];
|
|
159
253
|
}
|
|
254
|
+
declare const DEFAULT_DOCS_MCP_MAX_BODY_BYTES: number;
|
|
255
|
+
declare const DEFAULT_DOCS_MCP_CORS_MAX_AGE_SECONDS = 600;
|
|
256
|
+
declare const DEFAULT_DOCS_MCP_CORS_ALLOWED_HEADERS: readonly string[];
|
|
257
|
+
declare const DEFAULT_DOCS_MCP_CORS_EXPOSED_HEADERS: readonly string[];
|
|
160
258
|
declare function normalizeDocsMcpRoute(route?: string): string;
|
|
161
259
|
declare function resolveDocsMcpConfig(mcp?: boolean | DocsMcpConfig, defaults?: {
|
|
162
260
|
defaultName?: string;
|
|
@@ -168,4 +266,4 @@ declare function createDocsMcpServer(options: CreateDocsMcpServerOptions): Promi
|
|
|
168
266
|
declare function createDocsMcpHttpHandler(options: CreateDocsMcpServerOptions): DocsMcpHttpHandlers;
|
|
169
267
|
declare function runDocsMcpStdio(options: CreateDocsMcpServerOptions): Promise<void>;
|
|
170
268
|
//#endregion
|
|
171
|
-
export { DocsMcpCodeExample, DocsMcpConfigSchema, DocsMcpConfigSchemaOption, DocsMcpDocsList, DocsMcpDocsPageSummary, DocsMcpDocsSection, DocsMcpFolderNode, DocsMcpHttpHandlers, DocsMcpNavigationNode, DocsMcpNavigationTree, DocsMcpPage, DocsMcpPageNode, DocsMcpResolvedConfig, DocsMcpSource, createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio };
|
|
269
|
+
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 };
|