@farming-labs/docs 0.2.74 → 0.2.75
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-BJ0KXN-A.mjs → agent-BHqaZx-X.mjs} +2 -0
- package/dist/{agent-D0LEY2Vy.mjs → agent-DxTa3PLB.mjs} +2 -2
- package/dist/agent-cAPjC2jb.d.mts +922 -0
- package/dist/{agent-evals-LIScgQVm.mjs → agent-evals-21LZ_uEl.mjs} +1 -1
- package/dist/{agent-export-B92pNe6g.mjs → agent-export-3VheegEK.mjs} +5 -5
- package/dist/agent-skills-bundle.d.mts +1 -1
- package/dist/{agent-skills-server-BqvIGQb1.d.mts → agent-skills-server-Cix64aGB.d.mts} +2 -2
- package/dist/agent-skills-vite.d.mts +3 -3
- package/dist/{agents-C228QGbp.mjs → agents-ByTdP0Hl.mjs} +4 -4
- package/dist/cli/index.mjs +14 -14
- package/dist/client/react.d.mts +1 -1
- package/dist/{cloud-ask-ai-6X9pVjIY.d.mts → cloud-ask-ai-Bt0rzFbe.d.mts} +1 -1
- package/dist/docs-cloud-server.d.mts +2 -2
- package/dist/{doctor-CgrUZ3tY.mjs → doctor-C34VVF85.mjs} +9 -8
- package/dist/{golden-evaluations-DTEPZeb0.mjs → golden-evaluations-D_oDJwGv.mjs} +2 -2
- package/dist/index.d.mts +4 -875
- package/dist/index.mjs +4 -4
- package/dist/{mcp-YD37HlPY.mjs → mcp-Bnqfu8P5.mjs} +5 -4
- package/dist/mcp.d.mts +8 -4
- package/dist/mcp.mjs +236 -16
- package/dist/{prompt-references-BIS1eXt4.mjs → prompt-references-CfyYOa_W.mjs} +2 -2
- package/dist/{retrieval-digest-9Kp3uSaZ.d.mts → retrieval-digest-CFOcSKTo.d.mts} +4 -48
- package/dist/{review-Dbzkdl6K.mjs → review-Dw6oCQX3.mjs} +4 -4
- package/dist/{robots-RbgmSvPH.mjs → robots-DaYBoy_A.mjs} +1 -1
- package/dist/{robots-DUO0r4UI.mjs → robots-KWLujSLI.mjs} +2 -2
- package/dist/{search-DIyIl-tE.mjs → search-BmC8wVr0.mjs} +1 -1
- package/dist/{search-hcqaEZVN.mjs → search-DBdmbUkc.mjs} +4 -4
- package/dist/server.d.mts +7 -6
- package/dist/server.mjs +4 -4
- package/dist/{sitemap-jhkS_jYx.mjs → sitemap-CrzG5Wpf.mjs} +4 -4
- package/dist/{sitemap-server-BfyBM7_V.mjs → sitemap-server-B9LZQ1FE.mjs} +1 -1
- package/dist/{standards-discovery-CdrOE-05.d.mts → standards-discovery-DBI1PD7m.d.mts} +1 -1
- package/dist/{types-clg5J1R4.d.mts → types-BDRwrExu.d.mts} +5 -0
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { $ as DocsAgentSkillsInput, $n as PageAgentFailureMode, $t as DocsReviewCiMode, A as DocsAgentA2ASecurityScheme, An as DocsTelemetryFeatures, At as DocsFeedbackData, B as DocsAgentEvaluationSourceReference, Bn as LlmsTxtSectionConfig, Bt as DocsMcpOriginContext, C as DocsAgentA2AOAuthDeviceCodeFlow, Cn as DocsSearchWarningCode, Ct as DocsCodeBlocksPlannerProvider, D as DocsAgentA2AOpenIdConnectSecurityScheme, Dn as DocsTelemetryEvent, Dt as DocsCodeBlocksValidationMode, E as DocsAgentA2AOAuthPasswordFlow, En as DocsTelemetryConfig, Et as DocsCodeBlocksValidateConfig, F as DocsAgentEvaluationAnswerInput, Fn as GithubConfig, Ft as DocsMcpAuthenticate, G as DocsAgentFeedbackData, Gn as OpenDocsProviderConfig, Gt as DocsNav, H as DocsAgentEvaluationTaskInput, Hn as OGConfig, Ht as DocsMcpSecurityConfig, I as DocsAgentEvaluationAnswerProvider, In as LastUpdatedConfig, It as DocsMcpAuthenticateContext, J as DocsAgentGoldenExpectedExample, Jn as OpenGraphImage, Jt as DocsObservabilityEventInput, K as DocsAgentGoldenAnswerExpectation, Kn as OpenDocsProviderId, Kt as DocsObservabilityConfig, L as DocsAgentEvaluationAnswerRequest, Ln as LlmsTxtConfig, Lt as DocsMcpAuthenticateResult, M as DocsAgentA2ASkill, Mn as DocsTheme, Mt as DocsI18nConfig, N as DocsAgentCompactConfig, Nn as FeedbackConfig, Nt as DocsMcpAllowedOrigins, O as DocsAgentA2AProtocolBinding, On as DocsTelemetryEventInput, Ot as DocsCodeBlocksValidationPolicy, P as DocsAgentConfig, Pn as FontStyle, Pt as DocsMcpAuthPrincipal, Q as DocsAgentSkillsConfig, Qn as PageAgentCommand, Qt as DocsReviewCiConfig, R as DocsAgentEvaluationAnswerResult, Rn as LlmsTxtMaxCharsConfig, Rt as DocsMcpConfig, S as DocsAgentA2AOAuthClientCredentialsFlow, Sn as DocsSearchWarning, St as DocsCodeBlocksPlannerConfig, T as DocsAgentA2AOAuthImplicitFlow, Tn as DocsTelemetryAgentSurface, Tt as DocsCodeBlocksRunnerProvider, U as DocsAgentEvaluationsConfig, Un as OpenDocsConfig, Ut as DocsMcpToolsConfig, V as DocsAgentEvaluationSurface, Vn as McpDocsSearchConfig, Vt as DocsMcpProtectedResourceConfig, W as DocsAgentFeedbackContext, Wn as OpenDocsProvider, Wt as DocsMetadata, X as DocsAgentGoldenTaskExpectation, Xn as PageActionsConfig, Xt as DocsRetrievalSourceProvenance, Y as DocsAgentGoldenTask, Yn as OrderingItem, Yt as DocsRelatedItem, Z as DocsAgentGoldenTaskFilters, Zn as PageAgentAppliesTo, Zt as DocsRetrievalSourceScope, _ as DocsAgentA2AHttpAuthSecurityScheme, _n as DocsSearchRequest, _r as ThemeToggleConfig, _t as DocsCloudConfig, a as ApiReferenceRenderer, an as DocsRobotsRule, ar as PageTwitter, at as DocsAnalyticsEventInput, b as DocsAgentA2AOAuth2SecurityScheme, bn as DocsSearchResultType, br as UIConfig, bt as DocsCloudPublishConfig, c as ChangelogFrontmatter, cn as DocsSearchAdapterFactory, cr as ResolvedDocsRelatedLink, ct as DocsAnalyticsSource, d as CopyMarkdownFormat, dn as DocsSearchDocument, dr as SidebarFolderIndexBehavior, dt as DocsAskAIFeedbackConfig, en as DocsReviewConfig, er as PageAgentFrontmatter, et as DocsAgentTraceEventInput, f as CustomDocsSearchConfig, fn as DocsSearchEmbeddingsConfig, fr as SidebarFolderNode, ft as DocsAskAIFeedbackData, g as DocsAgentA2AExtension, gn as DocsSearchQuery, gr as SimpleDocsSearchConfig, gt as DocsCloudApiKeyConfig, h as DocsAgentA2AConfig, hn as DocsSearchFilters, hr as SidebarTree, ht as DocsAskAIMcpConfig, i as ApiReferenceConfig, in as DocsRobotsConfig, ir as PageSidebarFrontmatter, it as DocsAnalyticsEvent, j as DocsAgentA2ASecurityScopeList, jn as DocsTelemetryFramework, jt as DocsFeedbackValue, k as DocsAgentA2ASecurityRequirement, kn as DocsTelemetryEventType, kt as DocsConfig, l as CodeBlockCopyData, ln as DocsSearchChunkingConfig, lr as SidebarComponentProps, lt as DocsAskAIActionData, m as DocsAgentA2ACapabilities, mn as DocsSearchFilterInput, mr as SidebarPageNode, mt as DocsAskAIFeedbackValue, n as AgentFeedbackConfig, nn as DocsReviewScoreConfig, nr as PageFrontmatter, nt as DocsAgentTraceStatus, o as BreadcrumbConfig, on as DocsSearchAdapter, or as ReadingTimeConfig, ot as DocsAnalyticsEventType, p as DocsAgentA2AApiKeySecurityScheme, pn as DocsSearchFilterField, pr as SidebarNode, pt as DocsAskAIFeedbackMessage, q as DocsAgentGoldenExampleVerification, qn as OpenDocsTarget, qt as DocsObservabilityEvent, r as AlgoliaDocsSearchConfig, rn as DocsReviewSeverity, rr as PageOpenGraph, rt as DocsAnalyticsConfig, s as ChangelogConfig, sn as DocsSearchAdapterContext, sr as ReadingTimeFormat, st as DocsAnalyticsInput, t as AIConfig, tn as DocsReviewRulesConfig, tr as PageAgentVerification, tt as DocsAgentTraceEventType, u as CopyMarkdownConfig, un as DocsSearchConfig, ur as SidebarConfig, ut as DocsAskAIActionType, v as DocsAgentA2AInterfaceConfig, vn as DocsSearchResponse, vr as TypesenseDocsSearchConfig, vt as DocsCloudFeatureConfig, w as DocsAgentA2AOAuthFlows, wn as DocsSitemapConfig, wt as DocsCodeBlocksRunnerConfig, x as DocsAgentA2AOAuthAuthorizationCodeFlow, xn as DocsSearchSourcePage, xt as DocsCodeBlocksConfig, y as DocsAgentA2AMutualTlsSecurityScheme, yn as DocsSearchResult, yr as TypographyConfig, yt as DocsCloudPreviewConfig, z as DocsAgentEvaluationAnswerRunner, zn as LlmsTxtMaxCharsMode, zt as DocsMcpCorsConfig } from "./types-
|
|
1
|
+
import { $ as DocsAgentSkillsInput, $n as PageAgentFailureMode, $t as DocsReviewCiMode, A as DocsAgentA2ASecurityScheme, An as DocsTelemetryFeatures, At as DocsFeedbackData, B as DocsAgentEvaluationSourceReference, Bn as LlmsTxtSectionConfig, Bt as DocsMcpOriginContext, C as DocsAgentA2AOAuthDeviceCodeFlow, Cn as DocsSearchWarningCode, Ct as DocsCodeBlocksPlannerProvider, D as DocsAgentA2AOpenIdConnectSecurityScheme, Dn as DocsTelemetryEvent, Dt as DocsCodeBlocksValidationMode, E as DocsAgentA2AOAuthPasswordFlow, En as DocsTelemetryConfig, Et as DocsCodeBlocksValidateConfig, F as DocsAgentEvaluationAnswerInput, Fn as GithubConfig, Ft as DocsMcpAuthenticate, G as DocsAgentFeedbackData, Gn as OpenDocsProviderConfig, Gt as DocsNav, H as DocsAgentEvaluationTaskInput, Hn as OGConfig, Ht as DocsMcpSecurityConfig, I as DocsAgentEvaluationAnswerProvider, In as LastUpdatedConfig, It as DocsMcpAuthenticateContext, J as DocsAgentGoldenExpectedExample, Jn as OpenGraphImage, Jt as DocsObservabilityEventInput, K as DocsAgentGoldenAnswerExpectation, Kn as OpenDocsProviderId, Kt as DocsObservabilityConfig, L as DocsAgentEvaluationAnswerRequest, Ln as LlmsTxtConfig, Lt as DocsMcpAuthenticateResult, M as DocsAgentA2ASkill, Mn as DocsTheme, Mt as DocsI18nConfig, N as DocsAgentCompactConfig, Nn as FeedbackConfig, Nt as DocsMcpAllowedOrigins, O as DocsAgentA2AProtocolBinding, On as DocsTelemetryEventInput, Ot as DocsCodeBlocksValidationPolicy, P as DocsAgentConfig, Pn as FontStyle, Pt as DocsMcpAuthPrincipal, Q as DocsAgentSkillsConfig, Qn as PageAgentCommand, Qt as DocsReviewCiConfig, R as DocsAgentEvaluationAnswerResult, Rn as LlmsTxtMaxCharsConfig, Rt as DocsMcpConfig, S as DocsAgentA2AOAuthClientCredentialsFlow, Sn as DocsSearchWarning, St as DocsCodeBlocksPlannerConfig, T as DocsAgentA2AOAuthImplicitFlow, Tn as DocsTelemetryAgentSurface, Tt as DocsCodeBlocksRunnerProvider, U as DocsAgentEvaluationsConfig, Un as OpenDocsConfig, Ut as DocsMcpToolsConfig, V as DocsAgentEvaluationSurface, Vn as McpDocsSearchConfig, Vt as DocsMcpProtectedResourceConfig, W as DocsAgentFeedbackContext, Wn as OpenDocsProvider, Wt as DocsMetadata, X as DocsAgentGoldenTaskExpectation, Xn as PageActionsConfig, Xt as DocsRetrievalSourceProvenance, Y as DocsAgentGoldenTask, Yn as OrderingItem, Yt as DocsRelatedItem, Z as DocsAgentGoldenTaskFilters, Zn as PageAgentAppliesTo, Zt as DocsRetrievalSourceScope, _ as DocsAgentA2AHttpAuthSecurityScheme, _n as DocsSearchRequest, _r as ThemeToggleConfig, _t as DocsCloudConfig, a as ApiReferenceRenderer, an as DocsRobotsRule, ar as PageTwitter, at as DocsAnalyticsEventInput, b as DocsAgentA2AOAuth2SecurityScheme, bn as DocsSearchResultType, br as UIConfig, bt as DocsCloudPublishConfig, c as ChangelogFrontmatter, cn as DocsSearchAdapterFactory, cr as ResolvedDocsRelatedLink, ct as DocsAnalyticsSource, d as CopyMarkdownFormat, dn as DocsSearchDocument, dr as SidebarFolderIndexBehavior, dt as DocsAskAIFeedbackConfig, en as DocsReviewConfig, er as PageAgentFrontmatter, et as DocsAgentTraceEventInput, f as CustomDocsSearchConfig, fn as DocsSearchEmbeddingsConfig, fr as SidebarFolderNode, ft as DocsAskAIFeedbackData, g as DocsAgentA2AExtension, gn as DocsSearchQuery, gr as SimpleDocsSearchConfig, gt as DocsCloudApiKeyConfig, h as DocsAgentA2AConfig, hn as DocsSearchFilters, hr as SidebarTree, ht as DocsAskAIMcpConfig, i as ApiReferenceConfig, in as DocsRobotsConfig, ir as PageSidebarFrontmatter, it as DocsAnalyticsEvent, j as DocsAgentA2ASecurityScopeList, jn as DocsTelemetryFramework, jt as DocsFeedbackValue, k as DocsAgentA2ASecurityRequirement, kn as DocsTelemetryEventType, kt as DocsConfig, l as CodeBlockCopyData, ln as DocsSearchChunkingConfig, lr as SidebarComponentProps, lt as DocsAskAIActionData, m as DocsAgentA2ACapabilities, mn as DocsSearchFilterInput, mr as SidebarPageNode, mt as DocsAskAIFeedbackValue, n as AgentFeedbackConfig, nn as DocsReviewScoreConfig, nr as PageFrontmatter, nt as DocsAgentTraceStatus, o as BreadcrumbConfig, on as DocsSearchAdapter, or as ReadingTimeConfig, ot as DocsAnalyticsEventType, p as DocsAgentA2AApiKeySecurityScheme, pn as DocsSearchFilterField, pr as SidebarNode, pt as DocsAskAIFeedbackMessage, q as DocsAgentGoldenExampleVerification, qn as OpenDocsTarget, qt as DocsObservabilityEvent, r as AlgoliaDocsSearchConfig, rn as DocsReviewSeverity, rr as PageOpenGraph, rt as DocsAnalyticsConfig, s as ChangelogConfig, sn as DocsSearchAdapterContext, sr as ReadingTimeFormat, st as DocsAnalyticsInput, t as AIConfig, tn as DocsReviewRulesConfig, tr as PageAgentVerification, tt as DocsAgentTraceEventType, u as CopyMarkdownConfig, un as DocsSearchConfig, ur as SidebarConfig, ut as DocsAskAIActionType, v as DocsAgentA2AInterfaceConfig, vn as DocsSearchResponse, vr as TypesenseDocsSearchConfig, vt as DocsCloudFeatureConfig, w as DocsAgentA2AOAuthFlows, wn as DocsSitemapConfig, wt as DocsCodeBlocksRunnerConfig, x as DocsAgentA2AOAuthAuthorizationCodeFlow, xn as DocsSearchSourcePage, xt as DocsCodeBlocksConfig, y as DocsAgentA2AMutualTlsSecurityScheme, yn as DocsSearchResult, yr as TypographyConfig, yt as DocsCloudPreviewConfig, z as DocsAgentEvaluationAnswerRunner, zn as LlmsTxtMaxCharsMode, zt as DocsMcpCorsConfig } from "./types-BDRwrExu.mjs";
|
|
2
2
|
import { AGENT_SKILL_COMPATIBILITY_MAX_LENGTH, AGENT_SKILL_DESCRIPTION_MAX_LENGTH, AGENT_SKILL_FRONTMATTER_FIELDS, AGENT_SKILL_NAME_MAX_LENGTH, DocsAgentSkillFrontmatter, DocsAgentSkillFrontmatterError, DocsAgentSkillFrontmatterField, DocsAgentSkillFrontmatterIssue, DocsAgentSkillFrontmatterValidation, DocsAgentSkillFrontmatterValidationOptions, isDocsAgentSkillName, parseDocsAgentSkillFrontmatter, validateDocsAgentSkillFrontmatter } from "./agent-skills-spec.mjs";
|
|
3
|
-
import { $ as resolveDocsStandardsDiscoveryRequest, A as DocsAgentSkillIndexEntry, B as DocsStandardsDiscoveryRequest, C as DOCS_AGENT_MANIFEST_FORMAT, D as DocsA2AAgentCard, E as DOCS_AGENT_MANIFEST_VERSION, F as DocsApiCatalogOptions, G as buildDocsApiCatalog, H as appendDocsDiscoveryLinkHeader, I as DocsDiscoveryApiRouteOptions, J as getDocsAgentManifestLinkHeader, K as buildDocsLegacySkillsIndex, L as DocsPublishedAgentSkill, M as DocsApiCatalog, N as DocsApiCatalogLinkContext, O as DocsA2AAgentCardOptions, P as DocsApiCatalogLinkTarget, Q as resolveDocsPublishedAgentSkill, R as DocsPublishedAgentSkillFile, S as DEFAULT_LEGACY_SKILLS_ROUTE_PREFIX, T as DOCS_AGENT_MANIFEST_SCHEMA_URI, U as buildDocsA2AAgentCard, V as DocsStandardsDiscoveryRouteOptions, W as buildDocsAgentSkillsIndex, X as isDocsStandardsDiscoveryRequest, Y as getDocsDiscoveryLinkHeader, Z as resolveDocsDiscoveryApiRoute, _ as DEFAULT_AGENT_SKILL_RESOURCE_FORMAT, a as DEFAULT_A2A_AGENT_CARD_FORMAT, b as DEFAULT_LEGACY_SKILLS_INDEX_FORMAT, c as DEFAULT_A2A_PROTOCOL_VERSION, d as DEFAULT_AGENT_SKILLS_INDEX_ROUTE, et as sha256DocsDiscoveryContent, f as DEFAULT_AGENT_SKILLS_ROUTE_PATTERN, g as DEFAULT_AGENT_SKILL_FORMAT, h as DEFAULT_AGENT_SKILL_FILE_FORMAT, i as CreateDocsStandardsResponseOptions, j as DocsAgentSkillsIndex, k as DocsA2AAgentInterface, l as DEFAULT_AGENT_SKILLS_ARCHIVE_ROUTE_PATTERN, m as DEFAULT_AGENT_SKILL_ARCHIVE_FORMAT, n as API_CATALOG_MEDIA_TYPE, o as DEFAULT_A2A_AGENT_CARD_ROUTE, p as DEFAULT_AGENT_SKILLS_ROUTE_PREFIX, q as createDocsStandardsResponse, r as API_CATALOG_PROFILE_URI, s as DEFAULT_A2A_PROTOCOL_BINDING, t as AGENT_SKILLS_DISCOVERY_SCHEMA_URI, u as DEFAULT_AGENT_SKILLS_INDEX_FORMAT, v as DEFAULT_API_CATALOG_FORMAT, w as DOCS_AGENT_MANIFEST_SCHEMA_MEDIA_TYPE, x as DEFAULT_LEGACY_SKILLS_INDEX_ROUTE, y as DEFAULT_API_CATALOG_ROUTE, z as DocsPublishedAgentSkillOptions } from "./standards-discovery-
|
|
4
|
-
import { A as DocsSitemapFormat, B as resolveDocsSitemapConfig, C as resolveDocsSearchRequest,
|
|
5
|
-
import {
|
|
3
|
+
import { $ as resolveDocsStandardsDiscoveryRequest, A as DocsAgentSkillIndexEntry, B as DocsStandardsDiscoveryRequest, C as DOCS_AGENT_MANIFEST_FORMAT, D as DocsA2AAgentCard, E as DOCS_AGENT_MANIFEST_VERSION, F as DocsApiCatalogOptions, G as buildDocsApiCatalog, H as appendDocsDiscoveryLinkHeader, I as DocsDiscoveryApiRouteOptions, J as getDocsAgentManifestLinkHeader, K as buildDocsLegacySkillsIndex, L as DocsPublishedAgentSkill, M as DocsApiCatalog, N as DocsApiCatalogLinkContext, O as DocsA2AAgentCardOptions, P as DocsApiCatalogLinkTarget, Q as resolveDocsPublishedAgentSkill, R as DocsPublishedAgentSkillFile, S as DEFAULT_LEGACY_SKILLS_ROUTE_PREFIX, T as DOCS_AGENT_MANIFEST_SCHEMA_URI, U as buildDocsA2AAgentCard, V as DocsStandardsDiscoveryRouteOptions, W as buildDocsAgentSkillsIndex, X as isDocsStandardsDiscoveryRequest, Y as getDocsDiscoveryLinkHeader, Z as resolveDocsDiscoveryApiRoute, _ as DEFAULT_AGENT_SKILL_RESOURCE_FORMAT, a as DEFAULT_A2A_AGENT_CARD_FORMAT, b as DEFAULT_LEGACY_SKILLS_INDEX_FORMAT, c as DEFAULT_A2A_PROTOCOL_VERSION, d as DEFAULT_AGENT_SKILLS_INDEX_ROUTE, et as sha256DocsDiscoveryContent, f as DEFAULT_AGENT_SKILLS_ROUTE_PATTERN, g as DEFAULT_AGENT_SKILL_FORMAT, h as DEFAULT_AGENT_SKILL_FILE_FORMAT, i as CreateDocsStandardsResponseOptions, j as DocsAgentSkillsIndex, k as DocsA2AAgentInterface, l as DEFAULT_AGENT_SKILLS_ARCHIVE_ROUTE_PATTERN, m as DEFAULT_AGENT_SKILL_ARCHIVE_FORMAT, n as API_CATALOG_MEDIA_TYPE, o as DEFAULT_A2A_AGENT_CARD_ROUTE, p as DEFAULT_AGENT_SKILLS_ROUTE_PREFIX, q as createDocsStandardsResponse, r as API_CATALOG_PROFILE_URI, s as DEFAULT_A2A_PROTOCOL_BINDING, t as AGENT_SKILLS_DISCOVERY_SCHEMA_URI, u as DEFAULT_AGENT_SKILLS_INDEX_FORMAT, v as DEFAULT_API_CATALOG_FORMAT, w as DOCS_AGENT_MANIFEST_SCHEMA_MEDIA_TYPE, x as DEFAULT_LEGACY_SKILLS_INDEX_ROUTE, y as DEFAULT_API_CATALOG_ROUTE, z as DocsPublishedAgentSkillOptions } from "./standards-discovery-DBI1PD7m.mjs";
|
|
4
|
+
import { A as DocsSitemapFormat, B as resolveDocsSitemapConfig, C as resolveDocsSearchRequest, D as DEFAULT_SITEMAP_MD_ROUTE, E as DEFAULT_SITEMAP_MD_DOCS_ROUTE, F as buildDocsSitemapManifest, H as resolveDocsSitemapRequest, I as createDocsSitemapResponse, J as PromptAction, L as readDocsSitemapManifestFromContentMap, M as DocsSitemapManifestPage, N as DocsSitemapPageInput, O as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, P as DocsSitemapResolvedConfig, R as renderDocsSitemapMarkdown, S as resolveDocsSearchFilters, T as DEFAULT_SITEMAP_MANIFEST_PATH, U as toDocsSitemapMarkdownUrl, V as resolveDocsSitemapPageLastmod, X as SerializeOpenDocsProviderOptions, Y as PromptProviderChoice, Z as SerializedOpenDocsProvider, _ as performDocsSearch, _t as resolveDocsObservabilityConfig, a as buildDocsAskAIContext, b as resolveDocsRetrievalLastModified, c as createAlgoliaSearchAdapter, ct as ResolvedDocsAnalyticsConfig, d as createSimpleSearchAdapter, dt as createDocsAgentTraceId, f as createTypesenseSearchAdapter, ft as emitDocsAgentTraceEvent, g as normalizeDocsSearchFilters, gt as resolveDocsAnalyticsConfig, h as inferDocsAskAIPackageHints, ht as getDocsRequestAnalyticsProperties, i as PerformDocsSearchOptions, j as DocsSitemapManifest, k as DEFAULT_SITEMAP_XML_ROUTE, l as createCustomSearchAdapter, lt as ResolvedDocsObservabilityConfig, m as formatDocsAskAIPackageHints, mt as emitDocsObservabilityEvent, n as isDocsRetrievalCanonicalUrl, o as buildDocsRetrievalDigestProjection, ot as DOCS_AGENT_TRACE_EVENT_TYPES, p as enrichDocsSearchDocumentsWithProvenance, pt as emitDocsAnalyticsEvent, r as EnrichDocsSearchDocumentsWithProvenanceOptions, s as buildDocsSearchDocuments, st as DocsAgentTraceContext, t as digestDocsRetrievalContent, u as createMcpSearchAdapter, ut as createDocsAgentTraceContext, v as performDocsSearchWithMetadata, w as resolveSearchRequestConfig, x as resolveDocsSearchAudience, y as resolveAskAISearchRequestConfig, z as renderDocsSitemapXml } from "./retrieval-digest-CFOcSKTo.mjs";
|
|
5
|
+
import { $ as DocsMarkdownPage, $t as resolveDocsLlmsTxtRequest, A as DocsAgentFeedbackDiscoveryConfig, An as DocsPathMatch, At as hasDocsMarkdownSignatureAgent, B as DocsDiagnosticsIssueSeverity, Bt as normalizeDocsPathSegment, C as DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN, Cn as DEFAULT_MCP_ROUTE, Ct as createDocsMarkdownResponse, D as DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN, Dn as getDocsMcpResourcePaths, Dt as getDocsLlmsTxtMaxCharsIssue, E as DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER, En as getDocsMcpProtectedResourceMetadataRoutes, Et as findDocsMarkdownPage, F as DocsConfigMapJsonValue, Ft as isDocsLlmsTxtPublicRequest, G as DocsLlmsTxtGeneratedSection, Gt as renderDocsMarkdownDocument, H as DocsDiagnosticsStatus, Ht as parseDocsAgentFeedbackData, I as DocsConfigMapPointer, It as isDocsMarkdownSectionIndexRequest, J as DocsLlmsTxtRequest, Jt as resolveDocsAgentContractMcpTools, K as DocsLlmsTxtMaxCharsIssue, Kt as renderDocsMarkdownNotFound, L as DocsDiagnostics, Lt as isDocsPublicGetRequest, M as DocsAgentFeedbackResolvedConfig, Mn as resolveDocsI18n, Mt as isDocsAgentsRequest, N as DocsAgentsDocumentOptions, Nn as resolveDocsLocale, Nt as isDocsConfigRequest, O as DocsAgentContractMcpTools, On as hasDocsMcpProtectedResourceConfig, Ot as getDocsMarkdownCanonicalLinkHeader, P as DocsConfigMap, Pn as resolveDocsPath, Pt as isDocsDiagnosticsRequest, Q as DocsMarkdownAgentDetection, Qt as resolveDocsLlmsTxtFormat, R as DocsDiagnosticsFeature, Rt as isDocsSkillRequest, S as DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE, Sn as DEFAULT_MCP_PUBLIC_ROUTE, St as collectDocsMarkdownSections, T as DOCS_MARKDOWN_SECTION_INDEX_FORMAT, Tn as buildDocsMcpProtectedResourceMetadataRoute, Tt as detectDocsMarkdownAgentRequest, U as DocsLlmsDiscoveryConfig, Ut as renderDocsAgentsDocument, V as DocsDiagnosticsOptions, Vt as normalizeDocsUrlPath, W as DocsLlmsTxtGeneratedContent, Wt as renderDocsLlmsTxt, X as DocsLlmsTxtResolvedSection, Xt as resolveDocsAgentFeedbackRequest, Y as DocsLlmsTxtResolvedMaxChars, Yt as resolveDocsAgentFeedbackConfig, Z as DocsLlmsTxtSelectedContent, Zt as resolveDocsAgentsFormat, _ as DEFAULT_LLMS_TXT_MAX_CHARS, _n as findDocsAudienceMdxIssues, _t as buildDocsAgentFeedbackSchema, a as DEFAULT_AGENT_MD_ROUTE, an as resolveDocsOpenApiDiscoveryConfig, at as DocsMarkdownSectionIndexOptions, b as DEFAULT_OPENAPI_SCHEMA_ROUTE, bn as resolveDocsAudienceMdxContent, bt as buildDocsMarkdownSectionIndex, c as DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE, cn as selectDocsLlmsTxtContent, ct as DocsMarkdownSectionResult, d as DEFAULT_DOCS_CONFIG_FORMAT, dn as validateDocsAgentFeedbackPayload, dt as DocsOpenApiDiscoveryConfig, en as resolveDocsLlmsTxtSections, et as DocsMarkdownRecoveryMatch, f as DEFAULT_DOCS_CONFIG_ROUTE, fn as DocsAudienceMdxIssue, ft as DocsOpenApiResolvedDiscoveryConfig, g as DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE, gt as buildDocsAgentDiscoverySpec, h as DEFAULT_LLMS_FULL_TXT_ROUTE, ht as acceptsDocsMarkdown, i as DEFAULT_AGENT_FEEDBACK_ROUTE, in as resolveDocsMarkdownSectionRequest, it as DocsMarkdownSectionIndex, j as DocsAgentFeedbackRequest, jn as ResolvedDocsI18n, jt as isDocsAgentDiscoveryRequest, k as DocsAgentDiscoverySpecOptions, kn as isDocsMcpRequest, kt as getDocsMarkdownVaryHeader, l as DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE, ln as selectDocsMarkdownSection, lt as DocsMcpEndpointCandidate, m as DEFAULT_DOCS_DIAGNOSTICS_ROUTE, mt as DocsStandardsDiscoveryResponseOptions, n as DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE, nn as resolveDocsMarkdownRecovery, nt as DocsMarkdownResponseOptions, o as DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE, on as resolveDocsRequestApiRoute, ot as DocsMarkdownSectionMetadata, p as DEFAULT_DOCS_DIAGNOSTICS_FORMAT, pn as DocsContentAudience, pt as DocsSkillDocumentOptions, q as DocsLlmsTxtPageInput, qt as renderDocsSkillDocument, r as DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA, rn as resolveDocsMarkdownRequest, rt as DocsMarkdownSection, s as DEFAULT_AGENT_SPEC_ROUTE, sn as resolveDocsSkillFormat, st as DocsMarkdownSectionRequest, t as DEFAULT_AGENTS_MD_ROUTE, tn as resolveDocsMarkdownCanonicalUrl, tt as DocsMarkdownRecoveryResult, u as DEFAULT_DOCS_API_ROUTE, un as toDocsMarkdownUrl, ut as DocsMcpEndpointCandidateOptions, v as DEFAULT_LLMS_TXT_ROUTE, vn as resolveDocsAgentMdxContent, vt as buildDocsConfigMap, w as DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN, wn as DEFAULT_MCP_WELL_KNOWN_ROUTE, wt as createDocsStandardsDiscoveryResponse, x as DEFAULT_SKILL_MD_ROUTE, xn as DEFAULT_MCP_PROTECTED_RESOURCE_METADATA_ROUTE, xt as buildDocsMcpEndpointCandidates, y as DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE, yn as resolveDocsAudienceExposure, yt as buildDocsDiagnostics, z as DocsDiagnosticsIssue, zt as matchesDocsLlmsTxtSection } from "./agent-cAPjC2jb.mjs";
|
|
6
6
|
|
|
7
7
|
//#region src/define-docs.d.ts
|
|
8
8
|
/**
|
|
@@ -114,21 +114,6 @@ declare function createTheme(baseTheme: DocsTheme): (overrides?: Partial<DocsThe
|
|
|
114
114
|
*/
|
|
115
115
|
declare function extendTheme(baseTheme: DocsTheme, extensions: Partial<DocsTheme>): DocsTheme;
|
|
116
116
|
//#endregion
|
|
117
|
-
//#region src/i18n.d.ts
|
|
118
|
-
interface ResolvedDocsI18n {
|
|
119
|
-
locales: string[];
|
|
120
|
-
defaultLocale: string;
|
|
121
|
-
}
|
|
122
|
-
interface DocsPathMatch {
|
|
123
|
-
/** Slug path relative to the docs root (no leading slash). */
|
|
124
|
-
slug: string;
|
|
125
|
-
/** Entry path used for URLs (no locale segment). */
|
|
126
|
-
entryPath: string;
|
|
127
|
-
}
|
|
128
|
-
declare function resolveDocsI18n(config?: DocsI18nConfig | null): ResolvedDocsI18n | null;
|
|
129
|
-
declare function resolveDocsLocale(searchParams: URLSearchParams, i18n?: ResolvedDocsI18n | null): string | undefined;
|
|
130
|
-
declare function resolveDocsPath(pathname: string, entry: string): DocsPathMatch;
|
|
131
|
-
//#endregion
|
|
132
117
|
//#region src/agent-conformance.d.ts
|
|
133
118
|
declare const DOCS_AGENT_CONTRACT_VERSION = "1.3";
|
|
134
119
|
type DocsAgentAdapter = "next" | "tanstack-start" | "sveltekit" | "astro" | "nuxt";
|
|
@@ -346,862 +331,6 @@ declare function parseGeneratedAgentDocument(raw: string): ParsedGeneratedAgentD
|
|
|
346
331
|
declare function stripGeneratedAgentProvenance(raw: string): string;
|
|
347
332
|
declare function serializeGeneratedAgentDocument(content: string, provenance: GeneratedAgentProvenance): string;
|
|
348
333
|
//#endregion
|
|
349
|
-
//#region src/mcp-auth.d.ts
|
|
350
|
-
declare const DEFAULT_MCP_ROUTE = "/api/docs/mcp";
|
|
351
|
-
declare const DEFAULT_MCP_PUBLIC_ROUTE = "/mcp";
|
|
352
|
-
declare const DEFAULT_MCP_WELL_KNOWN_ROUTE = "/.well-known/mcp";
|
|
353
|
-
declare const DEFAULT_MCP_PROTECTED_RESOURCE_METADATA_ROUTE = "/.well-known/oauth-protected-resource";
|
|
354
|
-
declare function getDocsMcpResourcePaths(route?: string): string[];
|
|
355
|
-
declare function buildDocsMcpProtectedResourceMetadataRoute(resourcePath: string): string;
|
|
356
|
-
declare function getDocsMcpProtectedResourceMetadataRoutes(route?: string): string[];
|
|
357
|
-
declare function hasDocsMcpProtectedResourceConfig(mcp?: boolean | DocsMcpConfig): boolean;
|
|
358
|
-
declare function isDocsMcpRequest(url: URL, mcp?: boolean | DocsMcpConfig): boolean;
|
|
359
|
-
//#endregion
|
|
360
|
-
//#region src/agent.d.ts
|
|
361
|
-
declare const DEFAULT_DOCS_API_ROUTE = "/api/docs";
|
|
362
|
-
declare const DEFAULT_DOCS_CONFIG_FORMAT = "docs-config-map.v1";
|
|
363
|
-
declare const DEFAULT_DOCS_CONFIG_ROUTE = "/api/docs?format=config";
|
|
364
|
-
declare const DEFAULT_DOCS_DIAGNOSTICS_FORMAT = "docs-diagnostics.v1";
|
|
365
|
-
declare const DEFAULT_DOCS_DIAGNOSTICS_ROUTE = "/api/docs?format=diagnostics";
|
|
366
|
-
declare const DEFAULT_OPENAPI_SCHEMA_ROUTE = "/api/docs?format=openapi";
|
|
367
|
-
declare const DEFAULT_AGENT_SPEC_ROUTE = "/api/docs/agent/spec";
|
|
368
|
-
declare const DEFAULT_AGENT_SPEC_WELL_KNOWN_ROUTE = "/.well-known/agent";
|
|
369
|
-
declare const DEFAULT_AGENT_SPEC_WELL_KNOWN_JSON_ROUTE = "/.well-known/agent.json";
|
|
370
|
-
declare const DEFAULT_LLMS_TXT_ROUTE = "/llms.txt";
|
|
371
|
-
declare const DEFAULT_LLMS_FULL_TXT_ROUTE = "/llms-full.txt";
|
|
372
|
-
declare const DEFAULT_LLMS_TXT_WELL_KNOWN_ROUTE = "/.well-known/llms.txt";
|
|
373
|
-
declare const DEFAULT_LLMS_FULL_TXT_WELL_KNOWN_ROUTE = "/.well-known/llms-full.txt";
|
|
374
|
-
declare const DEFAULT_LLMS_TXT_MAX_CHARS = 50000;
|
|
375
|
-
declare const DEFAULT_SKILL_MD_ROUTE = "/skill.md";
|
|
376
|
-
declare const DEFAULT_SKILL_MD_WELL_KNOWN_ROUTE = "/.well-known/skill.md";
|
|
377
|
-
declare const DEFAULT_AGENTS_MD_ROUTE = "/AGENTS.md";
|
|
378
|
-
declare const DEFAULT_AGENTS_MD_WELL_KNOWN_ROUTE = "/.well-known/AGENTS.md";
|
|
379
|
-
declare const DEFAULT_AGENT_MD_ROUTE = "/AGENT.md";
|
|
380
|
-
declare const DEFAULT_AGENT_MD_WELL_KNOWN_ROUTE = "/.well-known/AGENT.md";
|
|
381
|
-
declare const DEFAULT_AGENT_FEEDBACK_ROUTE = "/api/docs/agent/feedback";
|
|
382
|
-
declare const DEFAULT_AGENT_FEEDBACK_PAYLOAD_SCHEMA: Record<string, unknown>;
|
|
383
|
-
declare const DOCS_MARKDOWN_SIGNATURE_AGENT_HEADER = "Signature-Agent";
|
|
384
|
-
declare const DOCS_MARKDOWN_SECTION_INDEX_FORMAT = "docs-markdown-sections.v2";
|
|
385
|
-
declare const DOCS_AI_AGENT_USER_AGENT_HEADER_PATTERN: string;
|
|
386
|
-
declare const DOCS_TRADITIONAL_BOT_USER_AGENT_HEADER_PATTERN: string;
|
|
387
|
-
declare const DOCS_BOT_LIKE_USER_AGENT_HEADER_PATTERN: string;
|
|
388
|
-
interface DocsMcpEndpointCandidate {
|
|
389
|
-
baseUrl: string;
|
|
390
|
-
route: string;
|
|
391
|
-
url: string;
|
|
392
|
-
label: string;
|
|
393
|
-
}
|
|
394
|
-
interface DocsMcpEndpointCandidateOptions {
|
|
395
|
-
includeOriginFallback?: boolean;
|
|
396
|
-
includeRootDomainFallback?: boolean;
|
|
397
|
-
includeMcpSubdomainFallback?: boolean;
|
|
398
|
-
}
|
|
399
|
-
interface DocsAgentFeedbackResolvedConfig {
|
|
400
|
-
enabled: boolean;
|
|
401
|
-
route: string;
|
|
402
|
-
schemaRoute: string;
|
|
403
|
-
payloadSchema: Record<string, unknown>;
|
|
404
|
-
schema: Record<string, unknown>;
|
|
405
|
-
onFeedback?: (data: DocsAgentFeedbackData) => void | Promise<void>;
|
|
406
|
-
}
|
|
407
|
-
interface DocsAgentFeedbackRequest {
|
|
408
|
-
kind: "schema" | "submit";
|
|
409
|
-
}
|
|
410
|
-
interface DocsAgentFeedbackDiscoveryConfig {
|
|
411
|
-
enabled?: boolean;
|
|
412
|
-
route?: string;
|
|
413
|
-
schemaRoute?: string;
|
|
414
|
-
}
|
|
415
|
-
interface DocsLlmsDiscoveryConfig extends DocsDiscoveryApiRouteOptions {
|
|
416
|
-
enabled?: boolean;
|
|
417
|
-
/** Whether this deployment actually serves the RFC 9727 API catalog. Defaults to true. */
|
|
418
|
-
apiCatalog?: boolean;
|
|
419
|
-
baseUrl?: string;
|
|
420
|
-
siteTitle?: string;
|
|
421
|
-
siteDescription?: string;
|
|
422
|
-
maxChars?: LlmsTxtMaxCharsConfig;
|
|
423
|
-
sections?: LlmsTxtSectionConfig[];
|
|
424
|
-
openapi?: boolean | DocsOpenApiDiscoveryConfig;
|
|
425
|
-
}
|
|
426
|
-
interface DocsOpenApiDiscoveryConfig {
|
|
427
|
-
enabled?: boolean;
|
|
428
|
-
url?: string;
|
|
429
|
-
/** Whether `url` came from the framework default or explicit configuration. */
|
|
430
|
-
urlSource?: "default" | "configured";
|
|
431
|
-
source?: "generated" | "configured";
|
|
432
|
-
specUrl?: string;
|
|
433
|
-
apiReferencePath?: string;
|
|
434
|
-
}
|
|
435
|
-
interface DocsOpenApiResolvedDiscoveryConfig {
|
|
436
|
-
enabled: boolean;
|
|
437
|
-
url?: string;
|
|
438
|
-
/** Whether `url` came from the framework default or explicit configuration. */
|
|
439
|
-
urlSource?: "default" | "configured";
|
|
440
|
-
source?: "generated" | "configured";
|
|
441
|
-
specUrl?: string;
|
|
442
|
-
apiReferencePath?: string;
|
|
443
|
-
}
|
|
444
|
-
type DocsConfigMapJsonPrimitive = string | number | boolean | null;
|
|
445
|
-
type DocsConfigMapJsonValue = DocsConfigMapJsonPrimitive | DocsConfigMapJsonValue[] | {
|
|
446
|
-
[key: string]: DocsConfigMapJsonValue;
|
|
447
|
-
};
|
|
448
|
-
interface DocsConfigMapPointer {
|
|
449
|
-
/** Dot-path form for humans and TypeScript users, e.g. `mcp.tools.readPage`. */
|
|
450
|
-
path: string;
|
|
451
|
-
/** Coarse value kind at this pointer. */
|
|
452
|
-
kind: string;
|
|
453
|
-
}
|
|
454
|
-
interface DocsConfigMap {
|
|
455
|
-
schemaVersion: 1;
|
|
456
|
-
format: typeof DEFAULT_DOCS_CONFIG_FORMAT;
|
|
457
|
-
source: {
|
|
458
|
-
/** Best-effort source label; adapters only receive the runtime config object. */file: string; /** Best-effort language hint based on serializing the runtime config object. */
|
|
459
|
-
language: "ts" | "tsx";
|
|
460
|
-
};
|
|
461
|
-
serialization: {
|
|
462
|
-
mode: "json-safe";
|
|
463
|
-
redacted: string;
|
|
464
|
-
nonSerializable: "described";
|
|
465
|
-
};
|
|
466
|
-
values: {
|
|
467
|
-
[key: string]: DocsConfigMapJsonValue;
|
|
468
|
-
};
|
|
469
|
-
/** RFC 6901 JSON Pointer index for mapping response values back to docs.config paths. */
|
|
470
|
-
pointers: Record<string, DocsConfigMapPointer>;
|
|
471
|
-
}
|
|
472
|
-
type DocsDiagnosticsStatus = "enabled" | "disabled";
|
|
473
|
-
type DocsDiagnosticsIssueSeverity = "warning" | "error";
|
|
474
|
-
interface DocsDiagnosticsIssue {
|
|
475
|
-
severity: DocsDiagnosticsIssueSeverity;
|
|
476
|
-
code: string;
|
|
477
|
-
path?: string;
|
|
478
|
-
message: string;
|
|
479
|
-
}
|
|
480
|
-
interface DocsDiagnosticsFeature {
|
|
481
|
-
status: DocsDiagnosticsStatus;
|
|
482
|
-
reason?: string;
|
|
483
|
-
route?: string | null;
|
|
484
|
-
routes?: Record<string, string | null>;
|
|
485
|
-
agentEndpoint?: string | null;
|
|
486
|
-
structuredAgentEndpoint?: string | null;
|
|
487
|
-
audienceParam?: string;
|
|
488
|
-
defaultAudience?: "human" | "agent";
|
|
489
|
-
supportedAudiences?: Array<"human" | "agent">;
|
|
490
|
-
filterParams?: {
|
|
491
|
-
framework: "framework";
|
|
492
|
-
version: "version";
|
|
493
|
-
package: "package";
|
|
494
|
-
tags: "tags";
|
|
495
|
-
};
|
|
496
|
-
responseFormat?: "docs-search.v1";
|
|
497
|
-
warningsField?: "warnings";
|
|
498
|
-
provider?: string;
|
|
499
|
-
mode?: string;
|
|
500
|
-
transport?: "GET" | "POST" | "GET/HEAD" | "GET/POST";
|
|
501
|
-
tools?: Record<string, boolean>;
|
|
502
|
-
human?: boolean;
|
|
503
|
-
agent?: boolean;
|
|
504
|
-
}
|
|
505
|
-
interface DocsDiagnostics {
|
|
506
|
-
schemaVersion: 1;
|
|
507
|
-
format: typeof DEFAULT_DOCS_DIAGNOSTICS_FORMAT;
|
|
508
|
-
ok: boolean;
|
|
509
|
-
adapter: string | null;
|
|
510
|
-
routes: {
|
|
511
|
-
docs: string;
|
|
512
|
-
api: string;
|
|
513
|
-
config: string;
|
|
514
|
-
diagnostics: string;
|
|
515
|
-
agentSpec: string;
|
|
516
|
-
apiCatalog: string | null;
|
|
517
|
-
agentSkillsIndex: string;
|
|
518
|
-
agentSkillsArtifact: string;
|
|
519
|
-
agents: string;
|
|
520
|
-
skill: string;
|
|
521
|
-
search: string | null;
|
|
522
|
-
agentSearch: string | null;
|
|
523
|
-
askAi: string | null;
|
|
524
|
-
mcp: string | null;
|
|
525
|
-
llmsTxt: string | null;
|
|
526
|
-
llmsFullTxt: string | null;
|
|
527
|
-
sitemapXml: string | null;
|
|
528
|
-
sitemapMarkdown: string | null;
|
|
529
|
-
robots: string | null;
|
|
530
|
-
openapi: string | null;
|
|
531
|
-
apiReference: string | null;
|
|
532
|
-
};
|
|
533
|
-
features: {
|
|
534
|
-
staticExport: DocsDiagnosticsFeature;
|
|
535
|
-
config: DocsDiagnosticsFeature;
|
|
536
|
-
diagnostics: DocsDiagnosticsFeature;
|
|
537
|
-
apiCatalog: DocsDiagnosticsFeature;
|
|
538
|
-
search: DocsDiagnosticsFeature;
|
|
539
|
-
ai: DocsDiagnosticsFeature;
|
|
540
|
-
mcp: DocsDiagnosticsFeature;
|
|
541
|
-
feedback: DocsDiagnosticsFeature;
|
|
542
|
-
llmsTxt: DocsDiagnosticsFeature;
|
|
543
|
-
sitemap: DocsDiagnosticsFeature;
|
|
544
|
-
robots: DocsDiagnosticsFeature;
|
|
545
|
-
apiReference: DocsDiagnosticsFeature;
|
|
546
|
-
agents: DocsDiagnosticsFeature;
|
|
547
|
-
skills: DocsDiagnosticsFeature;
|
|
548
|
-
locales: DocsDiagnosticsFeature;
|
|
549
|
-
};
|
|
550
|
-
warnings: DocsDiagnosticsIssue[];
|
|
551
|
-
errors: DocsDiagnosticsIssue[];
|
|
552
|
-
}
|
|
553
|
-
interface DocsDiagnosticsOptions extends DocsDiscoveryApiRouteOptions {
|
|
554
|
-
adapter?: string;
|
|
555
|
-
/** Effective RFC 9727 catalog availability after runtime overrides are applied. */
|
|
556
|
-
apiCatalog?: boolean;
|
|
557
|
-
entry?: string;
|
|
558
|
-
i18n?: ResolvedDocsI18n | null;
|
|
559
|
-
mcp?: DocsMcpResolvedConfig;
|
|
560
|
-
feedback?: DocsAgentFeedbackDiscoveryConfig;
|
|
561
|
-
openapi?: boolean | DocsOpenApiDiscoveryConfig;
|
|
562
|
-
}
|
|
563
|
-
interface DocsLlmsTxtResolvedMaxChars {
|
|
564
|
-
mode: LlmsTxtMaxCharsMode;
|
|
565
|
-
chars: number;
|
|
566
|
-
}
|
|
567
|
-
interface DocsLlmsTxtResolvedSection {
|
|
568
|
-
title: string;
|
|
569
|
-
description?: string;
|
|
570
|
-
match: string[];
|
|
571
|
-
route: string;
|
|
572
|
-
fullRoute: string;
|
|
573
|
-
maxChars: DocsLlmsTxtResolvedMaxChars;
|
|
574
|
-
}
|
|
575
|
-
interface DocsLlmsTxtRequest {
|
|
576
|
-
format: "llms" | "llms-full";
|
|
577
|
-
section?: DocsLlmsTxtResolvedSection;
|
|
578
|
-
}
|
|
579
|
-
interface DocsLlmsTxtPageInput {
|
|
580
|
-
url: string;
|
|
581
|
-
/** Override the Markdown link emitted in llms.txt. */
|
|
582
|
-
markdownUrl?: string;
|
|
583
|
-
title: string;
|
|
584
|
-
description?: string;
|
|
585
|
-
content: string;
|
|
586
|
-
rawContent?: string;
|
|
587
|
-
agentContent?: string;
|
|
588
|
-
agentRawContent?: string;
|
|
589
|
-
agentFallbackContent?: string;
|
|
590
|
-
agentFallbackRawContent?: string;
|
|
591
|
-
}
|
|
592
|
-
interface DocsLlmsTxtGeneratedSection extends DocsLlmsTxtResolvedSection {
|
|
593
|
-
llmsTxt: string;
|
|
594
|
-
llmsFullTxt: string;
|
|
595
|
-
}
|
|
596
|
-
interface DocsLlmsTxtGeneratedContent {
|
|
597
|
-
llmsTxt: string;
|
|
598
|
-
llmsFullTxt: string;
|
|
599
|
-
maxChars: DocsLlmsTxtResolvedMaxChars;
|
|
600
|
-
sections: DocsLlmsTxtGeneratedSection[];
|
|
601
|
-
}
|
|
602
|
-
interface DocsLlmsTxtSelectedContent {
|
|
603
|
-
content: string;
|
|
604
|
-
label: string;
|
|
605
|
-
maxChars: DocsLlmsTxtResolvedMaxChars;
|
|
606
|
-
}
|
|
607
|
-
interface DocsLlmsTxtMaxCharsIssue {
|
|
608
|
-
mode: Exclude<LlmsTxtMaxCharsMode, "off">;
|
|
609
|
-
chars: number;
|
|
610
|
-
actual: number;
|
|
611
|
-
label: string;
|
|
612
|
-
message: string;
|
|
613
|
-
}
|
|
614
|
-
interface DocsAgentDiscoverySpecOptions extends DocsDiscoveryApiRouteOptions {
|
|
615
|
-
origin: string;
|
|
616
|
-
entry?: string;
|
|
617
|
-
/** Public rendered docs path when it differs from `entry`. */
|
|
618
|
-
docsPath?: string;
|
|
619
|
-
/** Whether this deployment actually serves the RFC 9727 API catalog. Defaults to true. */
|
|
620
|
-
apiCatalog?: boolean;
|
|
621
|
-
i18n?: ResolvedDocsI18n | null;
|
|
622
|
-
search?: boolean | DocsSearchConfig;
|
|
623
|
-
mcp: DocsMcpResolvedConfig;
|
|
624
|
-
feedback?: DocsAgentFeedbackDiscoveryConfig;
|
|
625
|
-
llms?: DocsLlmsDiscoveryConfig;
|
|
626
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
627
|
-
robots?: boolean | DocsRobotsConfig;
|
|
628
|
-
openapi?: boolean | DocsOpenApiDiscoveryConfig;
|
|
629
|
-
markdown?: {
|
|
630
|
-
acceptHeader?: boolean;
|
|
631
|
-
signatureAgentHeader?: boolean; /** Whether runtime Markdown routes support `?sections` metadata discovery. Defaults to true. */
|
|
632
|
-
sectionDiscovery?: boolean;
|
|
633
|
-
};
|
|
634
|
-
/** Additional validated project skills to cross-list in custom discovery. */
|
|
635
|
-
publishedSkills?: readonly DocsPublishedAgentSkill[];
|
|
636
|
-
/** Explicit metadata for a real A2A service; omitted sites do not publish an Agent Card. */
|
|
637
|
-
agentCard?: DocsA2AAgentCardOptions;
|
|
638
|
-
}
|
|
639
|
-
interface DocsSkillDocumentOptions extends DocsDiscoveryApiRouteOptions {
|
|
640
|
-
origin: string;
|
|
641
|
-
entry?: string;
|
|
642
|
-
/** Public rendered docs path when it differs from `entry`. */
|
|
643
|
-
docsPath?: string;
|
|
644
|
-
/** Whether this deployment actually serves the RFC 9727 API catalog. Defaults to true. */
|
|
645
|
-
apiCatalog?: boolean;
|
|
646
|
-
search?: boolean | DocsSearchConfig;
|
|
647
|
-
mcp: DocsMcpResolvedConfig;
|
|
648
|
-
feedback?: DocsAgentFeedbackDiscoveryConfig;
|
|
649
|
-
llms?: DocsLlmsDiscoveryConfig;
|
|
650
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
651
|
-
robots?: boolean | DocsRobotsConfig;
|
|
652
|
-
openapi?: boolean | DocsOpenApiDiscoveryConfig;
|
|
653
|
-
markdown?: {
|
|
654
|
-
acceptHeader?: boolean;
|
|
655
|
-
signatureAgentHeader?: boolean; /** Whether runtime Markdown routes support `?sections` metadata discovery. Defaults to true. */
|
|
656
|
-
sectionDiscovery?: boolean;
|
|
657
|
-
};
|
|
658
|
-
}
|
|
659
|
-
interface DocsAgentsDocumentOptions extends DocsSkillDocumentOptions {}
|
|
660
|
-
interface DocsStandardsDiscoveryResponseOptions extends DocsAgentDiscoverySpecOptions {
|
|
661
|
-
request: Request;
|
|
662
|
-
preferredSkillDocument?: string | null;
|
|
663
|
-
fallbackSkillDocument: string;
|
|
664
|
-
}
|
|
665
|
-
interface DocsAgentContractMcpTools {
|
|
666
|
-
list?: "list_tasks";
|
|
667
|
-
read?: "read_task";
|
|
668
|
-
}
|
|
669
|
-
interface DocsMarkdownPage {
|
|
670
|
-
slug?: string;
|
|
671
|
-
url: string;
|
|
672
|
-
title: string;
|
|
673
|
-
description?: string;
|
|
674
|
-
/** Override the public Markdown representation URL when it differs from `${url}.md`. */
|
|
675
|
-
markdownUrl?: string;
|
|
676
|
-
lastModified?: string;
|
|
677
|
-
lastmod?: string;
|
|
678
|
-
related?: ResolvedDocsRelatedLink[];
|
|
679
|
-
agent?: PageAgentFrontmatter;
|
|
680
|
-
content: string;
|
|
681
|
-
rawContent?: string;
|
|
682
|
-
agentContent?: string;
|
|
683
|
-
agentRawContent?: string;
|
|
684
|
-
agentFallbackContent?: string;
|
|
685
|
-
agentFallbackRawContent?: string;
|
|
686
|
-
}
|
|
687
|
-
interface DocsMarkdownDocumentOptions {
|
|
688
|
-
llms?: boolean | DocsLlmsDiscoveryConfig | LlmsTxtConfig;
|
|
689
|
-
origin?: string;
|
|
690
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
691
|
-
}
|
|
692
|
-
interface DocsMarkdownSection {
|
|
693
|
-
id: string;
|
|
694
|
-
heading: string;
|
|
695
|
-
level: number;
|
|
696
|
-
content: string;
|
|
697
|
-
startLine: number;
|
|
698
|
-
endLine: number;
|
|
699
|
-
}
|
|
700
|
-
interface DocsMarkdownSectionMetadata {
|
|
701
|
-
id: string;
|
|
702
|
-
heading: string;
|
|
703
|
-
level: number;
|
|
704
|
-
parentId?: string;
|
|
705
|
-
startLine: number;
|
|
706
|
-
endLine: number;
|
|
707
|
-
estimatedTokens: number;
|
|
708
|
-
utf8Bytes: number;
|
|
709
|
-
canonicalUrl: string;
|
|
710
|
-
markdownUrl: string;
|
|
711
|
-
}
|
|
712
|
-
interface DocsMarkdownSectionIndex {
|
|
713
|
-
schemaVersion: 2;
|
|
714
|
-
format: typeof DOCS_MARKDOWN_SECTION_INDEX_FORMAT;
|
|
715
|
-
canonicalUrl: string;
|
|
716
|
-
markdownUrl: string;
|
|
717
|
-
sectionIndexUrl: string;
|
|
718
|
-
lineNumbering: "body";
|
|
719
|
-
sectionCount: number;
|
|
720
|
-
estimatedTokens: number;
|
|
721
|
-
utf8Bytes: number;
|
|
722
|
-
fetchBudget?: {
|
|
723
|
-
tokenBudget?: number;
|
|
724
|
-
byteBudget?: number;
|
|
725
|
-
};
|
|
726
|
-
sections: DocsMarkdownSectionMetadata[];
|
|
727
|
-
}
|
|
728
|
-
interface DocsMarkdownSectionIndexOptions {
|
|
729
|
-
canonicalUrl: string;
|
|
730
|
-
markdownUrl: string;
|
|
731
|
-
sectionIndexUrl?: string;
|
|
732
|
-
tokenBudget?: number | null;
|
|
733
|
-
byteBudget?: number | null;
|
|
734
|
-
}
|
|
735
|
-
interface DocsMarkdownSectionRequest {
|
|
736
|
-
section?: string | null;
|
|
737
|
-
tokenBudget?: number | null;
|
|
738
|
-
byteBudget?: number | null;
|
|
739
|
-
}
|
|
740
|
-
interface DocsMarkdownSectionResult {
|
|
741
|
-
found: boolean;
|
|
742
|
-
requestedSection?: string;
|
|
743
|
-
section?: DocsMarkdownSection;
|
|
744
|
-
document: string;
|
|
745
|
-
truncated: boolean;
|
|
746
|
-
tokenBudget?: number;
|
|
747
|
-
byteBudget?: number;
|
|
748
|
-
estimatedTokens: number;
|
|
749
|
-
utf8Bytes: number;
|
|
750
|
-
availableSections: DocsMarkdownSection[];
|
|
751
|
-
}
|
|
752
|
-
interface DocsMarkdownNotFoundOptions extends DocsDiscoveryApiRouteOptions {
|
|
753
|
-
entry?: string;
|
|
754
|
-
requestedPath: string;
|
|
755
|
-
origin?: string;
|
|
756
|
-
pages?: DocsMarkdownPage[];
|
|
757
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
758
|
-
}
|
|
759
|
-
interface DocsMarkdownRecoveryMatch {
|
|
760
|
-
title: string;
|
|
761
|
-
url: string;
|
|
762
|
-
markdownUrl: string;
|
|
763
|
-
description?: string;
|
|
764
|
-
confidence: number;
|
|
765
|
-
}
|
|
766
|
-
interface DocsMarkdownRecoveryResult {
|
|
767
|
-
matches: DocsMarkdownRecoveryMatch[];
|
|
768
|
-
redirect?: DocsMarkdownRecoveryMatch;
|
|
769
|
-
}
|
|
770
|
-
interface DocsMarkdownCanonicalUrlOptions {
|
|
771
|
-
origin: string;
|
|
772
|
-
entry?: string;
|
|
773
|
-
requestedPath: string;
|
|
774
|
-
locale?: string | null;
|
|
775
|
-
}
|
|
776
|
-
interface DocsMarkdownResponseOptions extends DocsMarkdownNotFoundOptions {
|
|
777
|
-
request: Request;
|
|
778
|
-
document: string | null;
|
|
779
|
-
/** Override the human-readable canonical URL, for example when docsPath differs from entry. */
|
|
780
|
-
canonicalUrl?: string;
|
|
781
|
-
/** Override the selected Markdown representation URL. */
|
|
782
|
-
contentLocation?: string;
|
|
783
|
-
locale?: string | null;
|
|
784
|
-
/** Exact source modification timestamp. Date-only values are intentionally ignored. */
|
|
785
|
-
lastModified?: string | Date | null;
|
|
786
|
-
cacheControl?: string;
|
|
787
|
-
}
|
|
788
|
-
declare function normalizeDocsPathSegment(value: string): string;
|
|
789
|
-
declare function normalizeDocsUrlPath(value: string): string;
|
|
790
|
-
declare function isDocsConfigRequest(url: URL): boolean;
|
|
791
|
-
declare function isDocsDiagnosticsRequest(url: URL): boolean;
|
|
792
|
-
/** Prefer an explicitly configured API route; otherwise infer a query-form route from the request. */
|
|
793
|
-
declare function resolveDocsRequestApiRoute(url: URL, configuredApiRoute?: string): string;
|
|
794
|
-
declare function buildDocsConfigMap(config: DocsConfig | Record<string, unknown>, options?: {
|
|
795
|
-
file?: string;
|
|
796
|
-
}): DocsConfigMap;
|
|
797
|
-
declare function buildDocsDiagnostics(config: DocsConfig | Record<string, unknown>, options?: DocsDiagnosticsOptions): DocsDiagnostics;
|
|
798
|
-
declare function buildDocsAgentFeedbackSchema(payloadSchema: Record<string, unknown>): Record<string, unknown>;
|
|
799
|
-
declare function resolveDocsAgentFeedbackConfig(feedback?: boolean | FeedbackConfig): DocsAgentFeedbackResolvedConfig;
|
|
800
|
-
declare function resolveDocsAgentFeedbackRequest(url: URL, feedback: DocsAgentFeedbackResolvedConfig): DocsAgentFeedbackRequest | null;
|
|
801
|
-
declare function parseDocsAgentFeedbackData(request: Request): Promise<{
|
|
802
|
-
ok: true;
|
|
803
|
-
data: DocsAgentFeedbackData;
|
|
804
|
-
} | {
|
|
805
|
-
ok: false;
|
|
806
|
-
response: Response;
|
|
807
|
-
}>;
|
|
808
|
-
declare function validateDocsAgentFeedbackPayload(value: unknown, schema: Record<string, unknown>, valuePath?: string): string | undefined;
|
|
809
|
-
declare function toDocsMarkdownUrl(url: string, options?: {
|
|
810
|
-
locale?: string;
|
|
811
|
-
}): string;
|
|
812
|
-
declare function resolveDocsMarkdownCanonicalUrl({
|
|
813
|
-
origin,
|
|
814
|
-
entry,
|
|
815
|
-
requestedPath,
|
|
816
|
-
locale
|
|
817
|
-
}: DocsMarkdownCanonicalUrlOptions): string;
|
|
818
|
-
declare function getDocsMarkdownCanonicalLinkHeader(options: DocsMarkdownCanonicalUrlOptions): string;
|
|
819
|
-
declare function resolveDocsLlmsTxtSections(llms?: boolean | DocsLlmsDiscoveryConfig | LlmsTxtConfig): DocsLlmsTxtResolvedSection[];
|
|
820
|
-
declare function matchesDocsLlmsTxtSection(pageUrl: string, section: DocsLlmsTxtResolvedSection): boolean;
|
|
821
|
-
declare function resolveDocsLlmsTxtRequest(url: URL, llms?: boolean | DocsLlmsDiscoveryConfig | LlmsTxtConfig, basePath?: string, options?: DocsDiscoveryApiRouteOptions): DocsLlmsTxtRequest | null;
|
|
822
|
-
declare function renderDocsLlmsTxt(pages: DocsLlmsTxtPageInput[], options?: DocsLlmsDiscoveryConfig): DocsLlmsTxtGeneratedContent;
|
|
823
|
-
declare function selectDocsLlmsTxtContent(content: DocsLlmsTxtGeneratedContent, request: DocsLlmsTxtRequest): DocsLlmsTxtSelectedContent | null;
|
|
824
|
-
declare function getDocsLlmsTxtMaxCharsIssue(label: string, content: string, maxChars: DocsLlmsTxtResolvedMaxChars): DocsLlmsTxtMaxCharsIssue | null;
|
|
825
|
-
/** Build and serve standards-based discovery without replacing the custom agent manifest. */
|
|
826
|
-
declare function createDocsStandardsDiscoveryResponse({
|
|
827
|
-
request,
|
|
828
|
-
preferredSkillDocument,
|
|
829
|
-
fallbackSkillDocument,
|
|
830
|
-
origin,
|
|
831
|
-
entry,
|
|
832
|
-
docsPath,
|
|
833
|
-
apiCatalog: explicitApiCatalog,
|
|
834
|
-
apiRoute,
|
|
835
|
-
i18n: _i18n,
|
|
836
|
-
search: _search,
|
|
837
|
-
mcp,
|
|
838
|
-
feedback,
|
|
839
|
-
llms,
|
|
840
|
-
sitemap,
|
|
841
|
-
robots,
|
|
842
|
-
openapi,
|
|
843
|
-
markdown: _markdown,
|
|
844
|
-
publishedSkills,
|
|
845
|
-
agentCard
|
|
846
|
-
}: DocsStandardsDiscoveryResponseOptions): Promise<Response | null>;
|
|
847
|
-
declare function isDocsAgentDiscoveryRequest(url: URL, options?: DocsDiscoveryApiRouteOptions): boolean;
|
|
848
|
-
declare function buildDocsMcpEndpointCandidates(baseUrl: string, routes?: readonly string[], options?: DocsMcpEndpointCandidateOptions): DocsMcpEndpointCandidate[];
|
|
849
|
-
declare function isDocsSkillRequest(url: URL, options?: DocsDiscoveryApiRouteOptions): boolean;
|
|
850
|
-
declare function resolveDocsSkillFormat(url: URL): "skill" | null;
|
|
851
|
-
declare function isDocsAgentsRequest(url: URL, options?: DocsDiscoveryApiRouteOptions): boolean;
|
|
852
|
-
declare function resolveDocsAgentsFormat(url: URL): "agents" | null;
|
|
853
|
-
declare function isDocsPublicGetRequest(entry: string, url: URL, request: Request, options?: DocsDiscoveryApiRouteOptions & {
|
|
854
|
-
sitemap?: boolean | DocsSitemapConfig;
|
|
855
|
-
llms?: boolean | DocsLlmsDiscoveryConfig | LlmsTxtConfig;
|
|
856
|
-
robots?: boolean | DocsRobotsConfig;
|
|
857
|
-
}): boolean;
|
|
858
|
-
declare function isDocsLlmsTxtPublicRequest(url: URL, llms?: boolean | DocsLlmsDiscoveryConfig | LlmsTxtConfig, basePath?: string, options?: DocsDiscoveryApiRouteOptions): boolean;
|
|
859
|
-
declare function resolveDocsLlmsTxtFormat(url: URL, basePath?: string, options?: DocsDiscoveryApiRouteOptions): "llms" | "llms-full" | null;
|
|
860
|
-
declare function resolveDocsMarkdownRequest(entry: string, url: URL, request: Request, options?: DocsDiscoveryApiRouteOptions): {
|
|
861
|
-
requestedPath: string;
|
|
862
|
-
} | null;
|
|
863
|
-
declare function hasDocsMarkdownSignatureAgent(request: Request): boolean;
|
|
864
|
-
type DocsMarkdownAgentDetection = {
|
|
865
|
-
detected: true;
|
|
866
|
-
method: "signature_agent" | "user_agent" | "heuristic";
|
|
867
|
-
} | {
|
|
868
|
-
detected: false;
|
|
869
|
-
method: null;
|
|
870
|
-
};
|
|
871
|
-
declare function detectDocsMarkdownAgentRequest(request: Request): DocsMarkdownAgentDetection;
|
|
872
|
-
declare function getDocsMarkdownVaryHeader(request: Request): string | null;
|
|
873
|
-
declare function resolveDocsMarkdownRecovery({
|
|
874
|
-
entry,
|
|
875
|
-
requestedPath,
|
|
876
|
-
pages
|
|
877
|
-
}: DocsMarkdownNotFoundOptions): DocsMarkdownRecoveryResult;
|
|
878
|
-
declare function resolveDocsMarkdownSectionRequest(url: URL): DocsMarkdownSectionRequest | null;
|
|
879
|
-
declare function isDocsMarkdownSectionIndexRequest(url: URL): boolean;
|
|
880
|
-
declare function collectDocsMarkdownSections(document: string): DocsMarkdownSection[];
|
|
881
|
-
declare function buildDocsMarkdownSectionIndex(document: string, options: DocsMarkdownSectionIndexOptions): DocsMarkdownSectionIndex;
|
|
882
|
-
declare function selectDocsMarkdownSection(document: string, request: DocsMarkdownSectionRequest): DocsMarkdownSectionResult;
|
|
883
|
-
declare function renderDocsMarkdownNotFound({
|
|
884
|
-
entry,
|
|
885
|
-
apiRoute,
|
|
886
|
-
requestedPath,
|
|
887
|
-
origin,
|
|
888
|
-
pages,
|
|
889
|
-
sitemap
|
|
890
|
-
}: DocsMarkdownNotFoundOptions): string;
|
|
891
|
-
/** Build one standards-aware Markdown response for every framework adapter. */
|
|
892
|
-
declare function createDocsMarkdownResponse(options: DocsMarkdownResponseOptions): Response;
|
|
893
|
-
declare function findDocsMarkdownPage<T extends DocsMarkdownPage>(entry: string, pages: T[], requestedPath: string): T | null;
|
|
894
|
-
declare function renderDocsMarkdownDocument(page: DocsMcpPage | DocsSearchSourcePage, options?: DocsMarkdownDocumentOptions): string;
|
|
895
|
-
declare function renderDocsMarkdownDocument(page: DocsMarkdownPage, options?: DocsMarkdownDocumentOptions): string;
|
|
896
|
-
declare function renderDocsSkillDocument(options: DocsSkillDocumentOptions): string;
|
|
897
|
-
declare function renderDocsAgentsDocument(options: DocsAgentsDocumentOptions): string;
|
|
898
|
-
/** Resolve only the task tools that the advertised MCP endpoint actually exposes. */
|
|
899
|
-
declare function resolveDocsAgentContractMcpTools(mcp: DocsMcpResolvedConfig): DocsAgentContractMcpTools | undefined;
|
|
900
|
-
declare function buildDocsAgentDiscoverySpec({
|
|
901
|
-
origin,
|
|
902
|
-
entry,
|
|
903
|
-
apiRoute,
|
|
904
|
-
apiCatalog: explicitApiCatalog,
|
|
905
|
-
i18n,
|
|
906
|
-
search,
|
|
907
|
-
mcp,
|
|
908
|
-
feedback,
|
|
909
|
-
llms,
|
|
910
|
-
sitemap,
|
|
911
|
-
robots,
|
|
912
|
-
openapi,
|
|
913
|
-
markdown,
|
|
914
|
-
publishedSkills,
|
|
915
|
-
agentCard
|
|
916
|
-
}: DocsAgentDiscoverySpecOptions): {
|
|
917
|
-
$schema: string;
|
|
918
|
-
format: string;
|
|
919
|
-
version: string;
|
|
920
|
-
name: string;
|
|
921
|
-
baseUrl: string;
|
|
922
|
-
site: {
|
|
923
|
-
title: string;
|
|
924
|
-
description: string | undefined;
|
|
925
|
-
entry: string;
|
|
926
|
-
baseUrl: string;
|
|
927
|
-
};
|
|
928
|
-
locales: {
|
|
929
|
-
enabled: boolean;
|
|
930
|
-
available: string[];
|
|
931
|
-
default: string | null;
|
|
932
|
-
queryParam: string;
|
|
933
|
-
fallbackQueryParam: string;
|
|
934
|
-
};
|
|
935
|
-
capabilities: {
|
|
936
|
-
markdownRoutes: boolean;
|
|
937
|
-
markdownSectionDiscovery: boolean;
|
|
938
|
-
agentMdOverrides: boolean;
|
|
939
|
-
agentBlocks: boolean;
|
|
940
|
-
structuredAgentContracts: boolean;
|
|
941
|
-
agents: boolean;
|
|
942
|
-
llms: boolean;
|
|
943
|
-
skills: boolean;
|
|
944
|
-
apiCatalog: boolean;
|
|
945
|
-
agentSkillsDiscovery: boolean;
|
|
946
|
-
mcp: boolean;
|
|
947
|
-
search: boolean;
|
|
948
|
-
sitemap: boolean;
|
|
949
|
-
robots: boolean;
|
|
950
|
-
structuredData: boolean;
|
|
951
|
-
apiReference: boolean;
|
|
952
|
-
openapi: boolean;
|
|
953
|
-
agentFeedback: boolean;
|
|
954
|
-
locales: boolean;
|
|
955
|
-
};
|
|
956
|
-
api: {
|
|
957
|
-
openapi: string;
|
|
958
|
-
agentCard?: string | undefined;
|
|
959
|
-
agentSkillsIndex: string;
|
|
960
|
-
legacySkillsIndex: string;
|
|
961
|
-
apiCatalog?: string | undefined;
|
|
962
|
-
apiCatalogQuery?: string | undefined;
|
|
963
|
-
docs: string;
|
|
964
|
-
config: string;
|
|
965
|
-
diagnostics: string;
|
|
966
|
-
agentSpec: string;
|
|
967
|
-
agentSpecDefault: string;
|
|
968
|
-
agentSpecFallback: string;
|
|
969
|
-
agentSpecWellKnown: string;
|
|
970
|
-
agentSpecWellKnownJson: string;
|
|
971
|
-
agentSpecQuery: string;
|
|
972
|
-
agents: string;
|
|
973
|
-
};
|
|
974
|
-
apiCatalog: {
|
|
975
|
-
enabled: boolean;
|
|
976
|
-
route: string | null;
|
|
977
|
-
api: string | null;
|
|
978
|
-
mediaType: string;
|
|
979
|
-
profile: string;
|
|
980
|
-
};
|
|
981
|
-
config: {
|
|
982
|
-
format: string;
|
|
983
|
-
endpoint: string;
|
|
984
|
-
};
|
|
985
|
-
markdown: {
|
|
986
|
-
enabled: boolean;
|
|
987
|
-
acceptHeader: string | null;
|
|
988
|
-
signatureAgentHeader: string | null;
|
|
989
|
-
pagePattern: string;
|
|
990
|
-
rootPage: string;
|
|
991
|
-
apiPattern: string;
|
|
992
|
-
sectionDiscovery: {
|
|
993
|
-
format?: string | undefined;
|
|
994
|
-
indexParam?: string | undefined;
|
|
995
|
-
sectionParam?: string | undefined;
|
|
996
|
-
tokenBudgetParam?: string | undefined;
|
|
997
|
-
byteBudgetParam?: string | undefined;
|
|
998
|
-
enabled: boolean;
|
|
999
|
-
};
|
|
1000
|
-
resolutionOrder: string[];
|
|
1001
|
-
};
|
|
1002
|
-
agentContract: {
|
|
1003
|
-
usefulContractFields: string[];
|
|
1004
|
-
fields: {
|
|
1005
|
-
readonly tokenBudget: "number";
|
|
1006
|
-
readonly task: "string";
|
|
1007
|
-
readonly outcome: "string";
|
|
1008
|
-
readonly appliesTo: {
|
|
1009
|
-
readonly framework: "string|string[]";
|
|
1010
|
-
readonly version: "string|string[]";
|
|
1011
|
-
readonly package: "string|string[]";
|
|
1012
|
-
};
|
|
1013
|
-
readonly prerequisites: "string[]";
|
|
1014
|
-
readonly files: "string[]";
|
|
1015
|
-
readonly commands: "Array<string|{run,cwd?,description?}>";
|
|
1016
|
-
readonly sideEffects: "string[]";
|
|
1017
|
-
readonly verification: "Array<string|{description?,run?,expect?}>";
|
|
1018
|
-
readonly rollback: "string[]";
|
|
1019
|
-
readonly failureModes: "Array<string|{symptom,resolution?}>";
|
|
1020
|
-
};
|
|
1021
|
-
mcpTools?: DocsAgentContractMcpTools | undefined;
|
|
1022
|
-
enabled: boolean;
|
|
1023
|
-
schemaVersion: string;
|
|
1024
|
-
source: string;
|
|
1025
|
-
frontmatterPath: string;
|
|
1026
|
-
markdownSection: string;
|
|
1027
|
-
mcpField: string;
|
|
1028
|
-
};
|
|
1029
|
-
llms: {
|
|
1030
|
-
sections?: {
|
|
1031
|
-
title: string;
|
|
1032
|
-
description: string | undefined;
|
|
1033
|
-
match: string[];
|
|
1034
|
-
txt: string;
|
|
1035
|
-
full: string;
|
|
1036
|
-
}[] | undefined;
|
|
1037
|
-
enabled: boolean;
|
|
1038
|
-
defaultTxt: string;
|
|
1039
|
-
defaultFull: string;
|
|
1040
|
-
txt: string;
|
|
1041
|
-
full: string;
|
|
1042
|
-
publicTxt: string;
|
|
1043
|
-
publicFull: string;
|
|
1044
|
-
wellKnownTxt: string;
|
|
1045
|
-
wellKnownFull: string;
|
|
1046
|
-
};
|
|
1047
|
-
sitemap: {
|
|
1048
|
-
enabled: boolean;
|
|
1049
|
-
xml: {
|
|
1050
|
-
enabled: boolean;
|
|
1051
|
-
route: string;
|
|
1052
|
-
api: string;
|
|
1053
|
-
defaultRoute: string;
|
|
1054
|
-
};
|
|
1055
|
-
markdown: {
|
|
1056
|
-
enabled: boolean;
|
|
1057
|
-
route: string;
|
|
1058
|
-
docsRoute: string | undefined;
|
|
1059
|
-
wellKnownRoute: string;
|
|
1060
|
-
api: string;
|
|
1061
|
-
defaultRoute: string;
|
|
1062
|
-
defaultDocsRoute: string;
|
|
1063
|
-
defaultWellKnownRoute: string;
|
|
1064
|
-
};
|
|
1065
|
-
};
|
|
1066
|
-
robots: {
|
|
1067
|
-
enabled: boolean;
|
|
1068
|
-
route: string;
|
|
1069
|
-
defaultRoute: string;
|
|
1070
|
-
};
|
|
1071
|
-
structuredData: {
|
|
1072
|
-
enabled: boolean;
|
|
1073
|
-
format: string;
|
|
1074
|
-
schema: string;
|
|
1075
|
-
fields: string[];
|
|
1076
|
-
canonicalUrlField: string;
|
|
1077
|
-
breadcrumbType: string;
|
|
1078
|
-
agentContractType: string;
|
|
1079
|
-
};
|
|
1080
|
-
openapi: {
|
|
1081
|
-
enabled: boolean;
|
|
1082
|
-
url: string | null;
|
|
1083
|
-
source: "generated" | "configured" | null;
|
|
1084
|
-
specUrl: string | null;
|
|
1085
|
-
apiReferencePath: string | null;
|
|
1086
|
-
format: string;
|
|
1087
|
-
};
|
|
1088
|
-
search: {
|
|
1089
|
-
enabled: boolean;
|
|
1090
|
-
endpoint: string;
|
|
1091
|
-
agentEndpoint: string;
|
|
1092
|
-
structuredAgentEndpoint: string;
|
|
1093
|
-
method: string;
|
|
1094
|
-
queryParam: string;
|
|
1095
|
-
localeParam: string;
|
|
1096
|
-
audienceParam: string;
|
|
1097
|
-
defaultAudience: string;
|
|
1098
|
-
supportedAudiences: string[];
|
|
1099
|
-
responseParam: string;
|
|
1100
|
-
structuredResponseValue: string;
|
|
1101
|
-
responseFormat: string;
|
|
1102
|
-
filterParams: {
|
|
1103
|
-
framework: string;
|
|
1104
|
-
version: string;
|
|
1105
|
-
package: string;
|
|
1106
|
-
tags: string;
|
|
1107
|
-
};
|
|
1108
|
-
repeatedFilterParams: string[];
|
|
1109
|
-
warningsField: string;
|
|
1110
|
-
};
|
|
1111
|
-
agents: {
|
|
1112
|
-
enabled: boolean;
|
|
1113
|
-
file: string;
|
|
1114
|
-
route: string;
|
|
1115
|
-
wellKnown: string;
|
|
1116
|
-
api: string;
|
|
1117
|
-
generatedFallback: boolean;
|
|
1118
|
-
aliases: string[];
|
|
1119
|
-
};
|
|
1120
|
-
skills: {
|
|
1121
|
-
enabled: boolean;
|
|
1122
|
-
file: string;
|
|
1123
|
-
route: string;
|
|
1124
|
-
wellKnown: string;
|
|
1125
|
-
api: string;
|
|
1126
|
-
generatedFallback: boolean;
|
|
1127
|
-
registry: string;
|
|
1128
|
-
install: string;
|
|
1129
|
-
discovery: {
|
|
1130
|
-
schema: string;
|
|
1131
|
-
index: string;
|
|
1132
|
-
artifact: string;
|
|
1133
|
-
archive: string;
|
|
1134
|
-
file: string;
|
|
1135
|
-
legacyIndex: string;
|
|
1136
|
-
apiIndex: string;
|
|
1137
|
-
apiArtifact: string;
|
|
1138
|
-
apiFile: string;
|
|
1139
|
-
digest: string;
|
|
1140
|
-
};
|
|
1141
|
-
published: {
|
|
1142
|
-
name: string;
|
|
1143
|
-
description: string;
|
|
1144
|
-
type: "skill-md" | "archive";
|
|
1145
|
-
url: string;
|
|
1146
|
-
digest: `sha256:${string}`;
|
|
1147
|
-
files: {
|
|
1148
|
-
path: string;
|
|
1149
|
-
url: string;
|
|
1150
|
-
digest: `sha256:${string}`;
|
|
1151
|
-
}[];
|
|
1152
|
-
}[];
|
|
1153
|
-
recommended: {
|
|
1154
|
-
name: string;
|
|
1155
|
-
description: string;
|
|
1156
|
-
}[];
|
|
1157
|
-
};
|
|
1158
|
-
mcp: {
|
|
1159
|
-
protectedResource?: {
|
|
1160
|
-
metadataEndpoints: string[];
|
|
1161
|
-
authorizationServers: string[];
|
|
1162
|
-
scopesSupported: string[];
|
|
1163
|
-
requiredScopes: string[];
|
|
1164
|
-
} | undefined;
|
|
1165
|
-
enabled: boolean;
|
|
1166
|
-
endpoint: string;
|
|
1167
|
-
defaultEndpoint: string;
|
|
1168
|
-
publicEndpoint: string;
|
|
1169
|
-
wellKnownEndpoint: string;
|
|
1170
|
-
publicEndpoints: string[];
|
|
1171
|
-
canonicalEndpoint: string;
|
|
1172
|
-
name: string;
|
|
1173
|
-
version: string;
|
|
1174
|
-
tools: {
|
|
1175
|
-
listDocs: boolean;
|
|
1176
|
-
listPages: boolean;
|
|
1177
|
-
readPage: boolean;
|
|
1178
|
-
listTasks?: boolean;
|
|
1179
|
-
readTask?: boolean;
|
|
1180
|
-
searchDocs: boolean;
|
|
1181
|
-
getNavigation: boolean;
|
|
1182
|
-
getCodeExamples: boolean;
|
|
1183
|
-
getConfigSchema: boolean;
|
|
1184
|
-
getContext: boolean;
|
|
1185
|
-
};
|
|
1186
|
-
};
|
|
1187
|
-
feedback: {
|
|
1188
|
-
enabled: boolean;
|
|
1189
|
-
schema: string;
|
|
1190
|
-
submit: string;
|
|
1191
|
-
schemaQuery: string;
|
|
1192
|
-
submitQuery: string;
|
|
1193
|
-
};
|
|
1194
|
-
instructions: {
|
|
1195
|
-
preferMarkdownRoutes: boolean;
|
|
1196
|
-
useMcpWhenAvailable: boolean;
|
|
1197
|
-
useOpenApiWhenAvailable: boolean;
|
|
1198
|
-
readFeedbackSchemaBeforeSubmitting: boolean;
|
|
1199
|
-
doNotAssumeFeedbackPayloadShape: boolean;
|
|
1200
|
-
};
|
|
1201
|
-
};
|
|
1202
|
-
declare function acceptsDocsMarkdown(request: Request): boolean;
|
|
1203
|
-
declare function resolveDocsOpenApiDiscoveryConfig(openapi?: boolean | DocsOpenApiDiscoveryConfig): DocsOpenApiResolvedDiscoveryConfig;
|
|
1204
|
-
//#endregion
|
|
1205
334
|
//#region src/markdown-sections.d.ts
|
|
1206
335
|
interface DocsMarkdownHeadingAnchor {
|
|
1207
336
|
/** Heading source without a trailing Fumadocs custom-id marker. */
|