@shoalrun/cli 0.0.0-stage → 0.1.0-alpha.12
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/AUTHORING.md +269 -0
- package/CHANGELOG.md +89 -0
- package/LICENSE +202 -0
- package/README.md +191 -2
- package/agent-docs/.well-known/shoalrun/navigation/docs-50f26fe22670.txt +24 -0
- package/agent-docs/.well-known/shoalrun/navigation/examples-tab-50f26fe22670.txt +22 -0
- package/agent-docs/.well-known/shoalrun/navigation/project-updates-50f26fe22670.txt +37 -0
- package/agent-docs/.well-known/shoalrun/navigation/reference-tab-50f26fe22670.txt +22 -0
- package/agent-docs/SNAPSHOT.json +9 -0
- package/agent-docs/about.md +49 -0
- package/agent-docs/api-docs/focused-contracts.md +68 -0
- package/agent-docs/api-docs/generate.md +189 -0
- package/agent-docs/api-docs/generate.sections/add-useful-examples.md +47 -0
- package/agent-docs/api-docs/generate.sections/choose-generated-references-or-mdx.md +50 -0
- package/agent-docs/api-docs/generate.sections/describe-filters-that-do-not-use-their-openapi-parameter-name.md +52 -0
- package/agent-docs/api-docs/generate.sections/generate-many-pages-selectively.md +71 -0
- package/agent-docs/api-docs/generate.sections/link-guides-to-api-references.md +48 -0
- package/agent-docs/api-docs/generate.sections/map-extension-values-to-shoalrun-status.md +52 -0
- package/agent-docs/api-docs/generate.sections/override-generated-reference-order-in-navigation.md +60 -0
- package/agent-docs/api-docs/generate.sections/related-reading.md +38 -0
- package/agent-docs/api-docs/generate.sections/use-a-template-for-editorial-context.md +45 -0
- package/agent-docs/api-docs/support.md +97 -0
- package/agent-docs/author/add-page.md +126 -0
- package/agent-docs/author/agent-overview.md +59 -0
- package/agent-docs/author/agent-workflow.md +65 -0
- package/agent-docs/author/agents.md +53 -0
- package/agent-docs/author/analytics.md +286 -0
- package/agent-docs/author/analytics.sections/adapter-exports-and-consent.md +51 -0
- package/agent-docs/author/analytics.sections/built-in-events.md +52 -0
- package/agent-docs/author/analytics.sections/configure-an-adapter.md +51 -0
- package/agent-docs/author/analytics.sections/custom-interactions.md +57 -0
- package/agent-docs/author/analytics.sections/event-format.md +59 -0
- package/agent-docs/author/analytics.sections/html-markdown-and-agents.md +42 -0
- package/agent-docs/author/analytics.sections/inspect-events-locally.md +36 -0
- package/agent-docs/author/analytics.sections/map-events-to-your-service.md +42 -0
- package/agent-docs/author/analytics.sections/posthog-example.md +126 -0
- package/agent-docs/author/analytics.sections/related-reading.md +42 -0
- package/agent-docs/author/authoring-agent.md +102 -0
- package/agent-docs/author/coding-agent.md +90 -0
- package/agent-docs/author/components/action-link.md +47 -0
- package/agent-docs/author/components/api-embeds.md +271 -0
- package/agent-docs/author/components/api-embeds.sections/apiexample.md +121 -0
- package/agent-docs/author/components/api-embeds.sections/html-markdown-and-agents.md +37 -0
- package/agent-docs/author/components/api-embeds.sections/related-reading.md +37 -0
- package/agent-docs/author/components/badge.md +80 -0
- package/agent-docs/author/components/breadcrumbs.md +57 -0
- package/agent-docs/author/components/callout.md +135 -0
- package/agent-docs/author/components/cards.md +168 -0
- package/agent-docs/author/components/cards.sections/add-a-lucide-icon.md +50 -0
- package/agent-docs/author/components/cards.sections/build-a-collection.md +69 -0
- package/agent-docs/author/components/cards.sections/curate-a-reading-list.md +66 -0
- package/agent-docs/author/components/cards.sections/html-markdown-and-agents.md +37 -0
- package/agent-docs/author/components/cards.sections/link-to-one-document.md +45 -0
- package/agent-docs/author/components/cards.sections/override-card-text.md +58 -0
- package/agent-docs/author/components/cards.sections/related-reading.md +43 -0
- package/agent-docs/author/components/code-blocks.md +121 -0
- package/agent-docs/author/components/collapsible.md +103 -0
- package/agent-docs/author/components/cookbook-chooser.md +90 -0
- package/agent-docs/author/components/custom/react.md +190 -0
- package/agent-docs/author/components/custom/react.sections/html-markdown-and-agents.md +36 -0
- package/agent-docs/author/components/custom/react.sections/interactive-react-example.md +88 -0
- package/agent-docs/author/components/custom/react.sections/registration.md +41 -0
- package/agent-docs/author/components/custom/react.sections/related-reading.md +30 -0
- package/agent-docs/author/components/custom/react.sections/share-the-model-with-the-browser.md +47 -0
- package/agent-docs/author/components/custom/react.sections/where-the-content-lives.md +100 -0
- package/agent-docs/author/components/custom.md +183 -0
- package/agent-docs/author/components/definition-list.md +56 -0
- package/agent-docs/author/components/diagrams/d2-gallery.md +861 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/basic-shapes.md +163 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/flows-and-structures.md +375 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/html-markdown-and-agents.md +33 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/layout-engines.md +169 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/related-reading.md +37 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/sequences-and-grids.md +123 -0
- package/agent-docs/author/components/diagrams/d2-gallery.sections/styles-and-code.md +125 -0
- package/agent-docs/author/components/diagrams/pele-gallery.md +1317 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/charts-and-planning.md +341 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/flowchart-shapes.md +269 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/flows-and-behavior.md +273 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/html-markdown-and-agents.md +31 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/related-reading.md +35 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/specialized-diagrams.md +229 -0
- package/agent-docs/author/components/diagrams/pele-gallery.sections/systems-and-structures.md +291 -0
- package/agent-docs/author/components/diagrams.md +163 -0
- package/agent-docs/author/components/doc-link.md +62 -0
- package/agent-docs/author/components/fields.md +123 -0
- package/agent-docs/author/components/file-tree.md +88 -0
- package/agent-docs/author/components/images.md +105 -0
- package/agent-docs/author/components/info-hint.md +65 -0
- package/agent-docs/author/components/kbd.md +47 -0
- package/agent-docs/author/components/math.md +43 -0
- package/agent-docs/author/components/only.md +69 -0
- package/agent-docs/author/components/progress.md +57 -0
- package/agent-docs/author/components/related-reading.md +52 -0
- package/agent-docs/author/components/steps.md +127 -0
- package/agent-docs/author/components/tables.md +68 -0
- package/agent-docs/author/components/tabs.md +133 -0
- package/agent-docs/author/components/timeline.md +80 -0
- package/agent-docs/author/components/tooltips.md +62 -0
- package/agent-docs/author/components/walkthroughs.md +392 -0
- package/agent-docs/author/components/walkthroughs.sections/attributes.md +45 -0
- package/agent-docs/author/components/walkthroughs.sections/build-up-code.md +133 -0
- package/agent-docs/author/components/walkthroughs.sections/choose-a-layout.md +141 -0
- package/agent-docs/author/components/walkthroughs.sections/explain-one-file.md +126 -0
- package/agent-docs/author/components/walkthroughs.sections/html-markdown-and-agents.md +38 -0
- package/agent-docs/author/components/walkthroughs.sections/related-reading.md +36 -0
- package/agent-docs/author/components/walkthroughs.sections/syntax.md +51 -0
- package/agent-docs/author/components/walkthroughs.sections/take-code-from-a-file.md +34 -0
- package/agent-docs/author/components.md +81 -0
- package/agent-docs/author/content.md +74 -0
- package/agent-docs/author/cookbooks.md +119 -0
- package/agent-docs/author/css.md +241 -0
- package/agent-docs/author/css.sections/borders-fields-and-navigation-tokens.md +70 -0
- package/agent-docs/author/css.sections/core-color-tokens.md +71 -0
- package/agent-docs/author/css.sections/html-markdown-and-agents.md +54 -0
- package/agent-docs/author/css.sections/page-attributes.md +69 -0
- package/agent-docs/author/css.sections/page-transitions.md +60 -0
- package/agent-docs/author/css.sections/responsive-behavior.md +58 -0
- package/agent-docs/author/css.sections/status-code-and-callout-tokens.md +89 -0
- package/agent-docs/author/css.sections/typography-shape-and-width-tokens.md +71 -0
- package/agent-docs/author/custom-metadata.md +177 -0
- package/agent-docs/author/custom-metadata.sections/add-a-custom-page-field.md +68 -0
- package/agent-docs/author/custom-metadata.sections/choose-text-for-each-surface.md +54 -0
- package/agent-docs/author/custom-metadata.sections/preview-changes-to-metadata-providers.md +33 -0
- package/agent-docs/author/custom-metadata.sections/read-metadata-from-a-project-module.md +57 -0
- package/agent-docs/author/custom-metadata.sections/related-reading.md +29 -0
- package/agent-docs/author/design-templates.md +49 -0
- package/agent-docs/author/design-writing-guides.md +73 -0
- package/agent-docs/author/frontmatter-reference.md +150 -0
- package/agent-docs/author/frontmatter-reference.sections/choose-a-publication-and-visibility.md +44 -0
- package/agent-docs/author/frontmatter-reference.sections/control-output-details.md +41 -0
- package/agent-docs/author/frontmatter-reference.sections/global-defaults-and-enforced-values.md +31 -0
- package/agent-docs/author/frontmatter-reference.sections/html-markdown-and-agents.md +31 -0
- package/agent-docs/author/frontmatter-reference.sections/identify-and-route-a-page.md +40 -0
- package/agent-docs/author/frontmatter-reference.sections/point-agents-to-it.md +37 -0
- package/agent-docs/author/frontmatter-reference.sections/project-defined-fields.md +41 -0
- package/agent-docs/author/frontmatter-reference.sections/related-reading.md +35 -0
- package/agent-docs/author/frontmatter-reference.sections/use-the-local-files-while-authoring.md +33 -0
- package/agent-docs/author/frontmatter-reference.sections/when-the-files-update.md +31 -0
- package/agent-docs/author/frontmatter.md +255 -0
- package/agent-docs/author/frontmatter.sections/audience-badges.md +66 -0
- package/agent-docs/author/frontmatter.sections/give-deprecation-guidance.md +88 -0
- package/agent-docs/author/frontmatter.sections/global-defaults-and-enforced-values.md +75 -0
- package/agent-docs/author/frontmatter.sections/optional-native-fields.md +90 -0
- package/agent-docs/author/frontmatter.sections/publication-fields.md +85 -0
- package/agent-docs/author/frontmatter.sections/publishing-policy.md +71 -0
- package/agent-docs/author/frontmatter.sections/related-metadata-tasks.md +72 -0
- package/agent-docs/author/frontmatter.sections/related-reading.md +72 -0
- package/agent-docs/author/frontmatter.sections/required-after-inheritance.md +84 -0
- package/agent-docs/author/frontmatter.sections/seo-fields.md +79 -0
- package/agent-docs/author/frontmatter.sections/validation-rules.md +75 -0
- package/agent-docs/author/markdown-metadata.md +207 -0
- package/agent-docs/author/navigation.md +269 -0
- package/agent-docs/author/navigation.sections/arrange-authored-pages.md +58 -0
- package/agent-docs/author/navigation.sections/fill-an-api-tag-group.md +48 -0
- package/agent-docs/author/navigation.sections/hide-group-page-counts.md +45 -0
- package/agent-docs/author/navigation.sections/html-markdown-and-agents.md +40 -0
- package/agent-docs/author/navigation.sections/local-api-preview.md +47 -0
- package/agent-docs/author/navigation.sections/mix-guides-and-api-references.md +65 -0
- package/agent-docs/author/navigation.sections/optionally-split-a-large-menu-into-files.md +97 -0
- package/agent-docs/author/navigation.sections/reach-navigation-while-reading.md +38 -0
- package/agent-docs/author/navigation.sections/related-reading.md +44 -0
- package/agent-docs/author/navigation.sections/split-navigation-into-tabs.md +67 -0
- package/agent-docs/author/navigation.sections/subject-lifecycle-labels.md +42 -0
- package/agent-docs/author/reader-views.md +200 -0
- package/agent-docs/author/reader-views.sections/configure-the-choices.md +65 -0
- package/agent-docs/author/reader-views.sections/connect-your-own-control.md +59 -0
- package/agent-docs/author/reader-views.sections/how-it-works-for-agents.md +41 -0
- package/agent-docs/author/reader-views.sections/mark-pages.md +49 -0
- package/agent-docs/author/reader-views.sections/mark-sections-and-add-an-entry-choice.md +49 -0
- package/agent-docs/author/reader-views.sections/place-filter-controls.md +43 -0
- package/agent-docs/author/reader-views.sections/try-the-controls-here.md +64 -0
- package/agent-docs/author/recipe-drafts.md +181 -0
- package/agent-docs/author/recipe-drafts.sections/1-write-one-reusable-step.md +82 -0
- package/agent-docs/author/recipe-drafts.sections/2-list-the-steps-for-one-complete-goal.md +60 -0
- package/agent-docs/author/recipe-drafts.sections/3-generate-a-draft-and-review-it.md +55 -0
- package/agent-docs/author/recipe-drafts.sections/4-maintain-shoalrun-s-published-recipe-snapshots.md +66 -0
- package/agent-docs/author/recipe-drafts.sections/related-reading.md +45 -0
- package/agent-docs/author/recipe-drafts.sections/start-an-ingredient-from-an-api-example.md +50 -0
- package/agent-docs/author/recipes.md +127 -0
- package/agent-docs/author/recipes.sections/how-agents-use-this.md +50 -0
- package/agent-docs/author/recipes.sections/one-example-from-shoalrun.md +64 -0
- package/agent-docs/author/recipes.sections/related-reading.md +36 -0
- package/agent-docs/author/recipes.sections/try-a-complete-workflow.md +42 -0
- package/agent-docs/author/recipes.sections/use-recipes-for-task-oriented-how-tos.md +52 -0
- package/agent-docs/author/recipes.sections/what-changing-an-ingredient-updates.md +44 -0
- package/agent-docs/author/recipes.sections/what-each-file-does.md +48 -0
- package/agent-docs/author/recipes.sections/what-happens-and-when.md +45 -0
- package/agent-docs/author/related-reading.md +147 -0
- package/agent-docs/author/related-reading.sections/automatic-footers.md +35 -0
- package/agent-docs/author/related-reading.sections/declare-relationships.md +68 -0
- package/agent-docs/author/related-reading.sections/display-related-documents.md +54 -0
- package/agent-docs/author/related-reading.sections/html-markdown-and-agents.md +28 -0
- package/agent-docs/author/related-reading.sections/inspect-output-and-changes.md +32 -0
- package/agent-docs/author/related-reading.sections/reading-paths-in-section-markdown.md +32 -0
- package/agent-docs/author/related-reading.sections/related-reading.md +34 -0
- package/agent-docs/author/related-reading.sections/where-relationship-explanations-come-from.md +34 -0
- package/agent-docs/author/release-notes.md +153 -0
- package/agent-docs/author/search.md +299 -0
- package/agent-docs/author/search.sections/choose-a-provider.md +52 -0
- package/agent-docs/author/search.sections/cli-and-mcp-ranking-details.md +49 -0
- package/agent-docs/author/search.sections/hosted-semantic-search-limits.md +55 -0
- package/agent-docs/author/search.sections/html-markdown-and-agents.md +37 -0
- package/agent-docs/author/search.sections/lexical-search.md +78 -0
- package/agent-docs/author/search.sections/local-semantic-preview.md +43 -0
- package/agent-docs/author/search.sections/read-a-search-result-with-an-agent.md +41 -0
- package/agent-docs/author/search.sections/related-reading.md +45 -0
- package/agent-docs/author/search.sections/reuse-the-lexical-index.md +81 -0
- package/agent-docs/author/search.sections/turn-search-off.md +46 -0
- package/agent-docs/author/search.sections/use-the-search-box.md +39 -0
- package/agent-docs/author/search.sections/write-a-custom-provider.md +98 -0
- package/agent-docs/author/snippets.md +122 -0
- package/agent-docs/author/taxonomy.md +121 -0
- package/agent-docs/author/templates.md +231 -0
- package/agent-docs/author/templates.sections/built-in-feature-templates.md +52 -0
- package/agent-docs/author/templates.sections/built-in-templates.md +48 -0
- package/agent-docs/author/templates.sections/choose-formatting-enforcement-for-your-project.md +69 -0
- package/agent-docs/author/templates.sections/create-or-edit-a-project-template.md +76 -0
- package/agent-docs/author/templates.sections/keep-the-four-shapes-distinct.md +46 -0
- package/agent-docs/author/templates.sections/project-added-templates.md +39 -0
- package/agent-docs/author/templates.sections/related-reading.md +47 -0
- package/agent-docs/author/templates.sections/scaffold-a-page.md +53 -0
- package/agent-docs/author/templates.sections/short-cli-and-derived-values.md +56 -0
- package/agent-docs/author/templates.sections/what-every-template-gives-you.md +44 -0
- package/agent-docs/author/workspace/commands.md +92 -0
- package/agent-docs/author/workspace.md +104 -0
- package/agent-docs/author/writing-style.md +147 -0
- package/agent-docs/author/writing-style.sections/adapt-this-example.md +28 -0
- package/agent-docs/author/writing-style.sections/choose-components-by-reader-need.md +44 -0
- package/agent-docs/author/writing-style.sections/evidence-and-uncertainty.md +32 -0
- package/agent-docs/author/writing-style.sections/example-audience-and-scope.md +28 -0
- package/agent-docs/author/writing-style.sections/ingredients-recipes-and-cookbooks.md +36 -0
- package/agent-docs/author/writing-style.sections/page-purpose-and-structure.md +49 -0
- package/agent-docs/author/writing-style.sections/procedures-and-examples.md +32 -0
- package/agent-docs/author/writing-style.sections/related-reading.md +32 -0
- package/agent-docs/author/writing-style.sections/review-a-draft.md +30 -0
- package/agent-docs/author/writing-style.sections/reviewed-writing-examples.md +39 -0
- package/agent-docs/author/writing-style.sections/voice-and-explanations.md +39 -0
- package/agent-docs/changelog/2026-10-14-agent-readiness.md +29 -0
- package/agent-docs/changelog/2026-10-15-evaluation-builds.md +84 -0
- package/agent-docs/changelog/2026-10-16-navigation-layouts.md +72 -0
- package/agent-docs/changelog/2026-10-17-mcp-hosting.md +60 -0
- package/agent-docs/changelog/2026-10-18-search-and-tooltips.md +46 -0
- package/agent-docs/changelog/2026-10-19-visual-navigation.md +44 -0
- package/agent-docs/changelog/2026-10-25.md +45 -0
- package/agent-docs/changelog/2026-10-26.md +66 -0
- package/agent-docs/changelog/2026-10-27.md +85 -0
- package/agent-docs/changelog/authoring-preview.md +40 -0
- package/agent-docs/changelog/authoring-search.md +39 -0
- package/agent-docs/changelog/authoring-tools.md +34 -0
- package/agent-docs/changelog/working-tree-skill.md +38 -0
- package/agent-docs/changelog.md +115 -0
- package/agent-docs/chat/checks.md +175 -0
- package/agent-docs/chat/checks.sections/answer-ahead-of-time.md +38 -0
- package/agent-docs/chat/checks.sections/answer-for-one-audience.md +66 -0
- package/agent-docs/chat/checks.sections/answer-without-a-model.md +54 -0
- package/agent-docs/chat/checks.sections/follow-up-questions.md +54 -0
- package/agent-docs/chat/checks.sections/how-an-answer-is-checked.md +67 -0
- package/agent-docs/chat/checks.sections/questions-with-several-parts.md +44 -0
- package/agent-docs/chat/checks.sections/related-reading.md +42 -0
- package/agent-docs/chat/checks.sections/reuse-answers.md +50 -0
- package/agent-docs/chat/host.md +222 -0
- package/agent-docs/chat/host.sections/cap-the-daily-spend.md +78 -0
- package/agent-docs/chat/host.sections/keep-a-record-of-questions.md +64 -0
- package/agent-docs/chat/host.sections/related-reading.md +43 -0
- package/agent-docs/chat/passage-index.md +228 -0
- package/agent-docs/chat/passage-index.sections/build-the-index.md +72 -0
- package/agent-docs/chat/passage-index.sections/embed-passages.md +103 -0
- package/agent-docs/chat/passage-index.sections/how-the-default-chunker-splits-a-page.md +53 -0
- package/agent-docs/chat/passage-index.sections/limits.md +45 -0
- package/agent-docs/chat/passage-index.sections/passage-ids-and-links.md +52 -0
- package/agent-docs/chat/passage-index.sections/related-reading.md +42 -0
- package/agent-docs/chat/passage-index.sections/what-a-passage-contains.md +91 -0
- package/agent-docs/chat/prepared-answers.md +116 -0
- package/agent-docs/chat/settings.md +213 -0
- package/agent-docs/chat/settings.sections/choose-the-scorer.md +63 -0
- package/agent-docs/chat/settings.sections/configure-chat.md +80 -0
- package/agent-docs/chat/settings.sections/configure-retrieval.md +62 -0
- package/agent-docs/chat/settings.sections/related-reading.md +32 -0
- package/agent-docs/chat/settings.sections/send-extra-request-fields.md +42 -0
- package/agent-docs/chat/settings.sections/use-more-than-one-model.md +62 -0
- package/agent-docs/chat/settings.sections/when-the-scorer-is-down.md +42 -0
- package/agent-docs/chat/setup.md +97 -0
- package/agent-docs/chat.md +102 -0
- package/agent-docs/cli.md +445 -0
- package/agent-docs/cli.sections/audit-a-project-and-api-sources.md +102 -0
- package/agent-docs/cli.sections/author-pages.md +94 -0
- package/agent-docs/cli.sections/build-and-serve.md +144 -0
- package/agent-docs/cli.sections/inspect-config-and-operations.md +41 -0
- package/agent-docs/cli.sections/npm-scripts-in-this-repository.md +45 -0
- package/agent-docs/cli.sections/related-reading.md +33 -0
- package/agent-docs/cli.sections/search-and-chat.md +132 -0
- package/agent-docs/cli.sections/start-a-project.md +37 -0
- package/agent-docs/cli.sections/working-tree-authoring-tools.md +35 -0
- package/agent-docs/concepts.md +133 -0
- package/agent-docs/config/apis.md +136 -0
- package/agent-docs/config/content.md +264 -0
- package/agent-docs/config/content.sections/authoring.md +58 -0
- package/agent-docs/config/content.sections/badges.md +34 -0
- package/agent-docs/config/content.sections/callouts.md +34 -0
- package/agent-docs/config/content.sections/cookbooks.md +38 -0
- package/agent-docs/config/content.sections/frontmatter.md +75 -0
- package/agent-docs/config/content.sections/readerfilters.md +44 -0
- package/agent-docs/config/content.sections/related-reading.md +34 -0
- package/agent-docs/config/content.sections/relationships.md +76 -0
- package/agent-docs/config/content.sections/snippets.md +61 -0
- package/agent-docs/config/content.sections/templates.md +57 -0
- package/agent-docs/config/content.sections/variables.md +55 -0
- package/agent-docs/config/examples.md +362 -0
- package/agent-docs/config/examples.sections/feature-showcase.md +63 -0
- package/agent-docs/config/examples.sections/minimal-site.md +85 -0
- package/agent-docs/config/examples.sections/multilingual-help-center.md +115 -0
- package/agent-docs/config/examples.sections/parcel-api-documentation.md +158 -0
- package/agent-docs/config/examples.sections/related-reading.md +55 -0
- package/agent-docs/config/examples.sections/shared-company-preset.md +123 -0
- package/agent-docs/config/integrations.md +76 -0
- package/agent-docs/config/outputs.md +160 -0
- package/agent-docs/config/outputs.sections/exports.md +57 -0
- package/agent-docs/config/outputs.sections/metadata.md +42 -0
- package/agent-docs/config/outputs.sections/related-reading.md +34 -0
- package/agent-docs/config/publishing.md +219 -0
- package/agent-docs/config/publishing.sections/navigation.md +92 -0
- package/agent-docs/config/publishing.sections/redirects.md +79 -0
- package/agent-docs/config/publishing.sections/related-reading.md +33 -0
- package/agent-docs/config/site.md +193 -0
- package/agent-docs/config/site.sections/related-reading.md +33 -0
- package/agent-docs/config/site.sections/theme.md +74 -0
- package/agent-docs/config.md +195 -0
- package/agent-docs/configuration.md +386 -0
- package/agent-docs/configuration.sections/build-several-sites-from-shared-content.md +36 -0
- package/agent-docs/configuration.sections/change-inherited-lists-deliberately.md +76 -0
- package/agent-docs/configuration.sections/extract-a-section-with-include.md +75 -0
- package/agent-docs/configuration.sections/inspect-and-validate-changes.md +77 -0
- package/agent-docs/configuration.sections/related-reading.md +42 -0
- package/agent-docs/configuration.sections/separate-config-inheritance-from-page-metadata.md +54 -0
- package/agent-docs/configuration.sections/share-defaults-through-extends.md +121 -0
- package/agent-docs/configuration.sections/start-with-one-working-file.md +83 -0
- package/agent-docs/configuration.sections/understand-the-three-stages.md +59 -0
- package/agent-docs/configuration.sections/understand-where-paths-point.md +53 -0
- package/agent-docs/connect/mcp.md +85 -0
- package/agent-docs/contribute/agent-skills.md +72 -0
- package/agent-docs/cookbooks/authoring.md +72 -0
- package/agent-docs/cookbooks/site-workflows.md +63 -0
- package/agent-docs/cookbooks/welcome-email.md +59 -0
- package/agent-docs/documents.json +19807 -0
- package/agent-docs/example-api/cedar/create-enrollment-7af3e5d2.md +594 -0
- package/agent-docs/example-api/cedar/get-legacy-parcel-6758d051.md +122 -0
- package/agent-docs/example-api/cedar/get-parcel-edee10e6.md +122 -0
- package/agent-docs/example-api/cedar/list-parcels-0345fb5f.md +271 -0
- package/agent-docs/example-api/cedar/parcel-delivered-7d1ba6db.md +122 -0
- package/agent-docs/example-api/cedar/upload-manifest-1af17891.md +101 -0
- package/agent-docs/example-api/cedar.md +39 -0
- package/agent-docs/example-api/create-note.md +344 -0
- package/agent-docs/example-api/generated/get-note-cbedb319.md +165 -0
- package/agent-docs/example-api/write-note.md +55 -0
- package/agent-docs/explore.md +54 -0
- package/agent-docs/glossary.md +823 -0
- package/agent-docs/index.md +249 -0
- package/agent-docs/ingredients/audit-site.md +27 -0
- package/agent-docs/ingredients/build-site.md +29 -0
- package/agent-docs/ingredients/compile-framework.md +28 -0
- package/agent-docs/ingredients/complete-page.md +30 -0
- package/agent-docs/ingredients/inspect-agent-bundle.md +28 -0
- package/agent-docs/ingredients/inspect-build.md +41 -0
- package/agent-docs/ingredients/preview-site.md +31 -0
- package/agent-docs/ingredients/refresh-agent-bundle.md +29 -0
- package/agent-docs/ingredients/scaffold-page.md +28 -0
- package/agent-docs/non-goals.md +58 -0
- package/agent-docs/provenance.json +10 -0
- package/agent-docs/publish/agent-discovery.md +79 -0
- package/agent-docs/publish/agent-friendliness.md +201 -0
- package/agent-docs/publish/agent-friendliness.sections/discover-a-page-with-a-small-context-budget.md +61 -0
- package/agent-docs/publish/agent-friendliness.sections/distinguish-examples-from-a-real-service.md +48 -0
- package/agent-docs/publish/agent-friendliness.sections/evidence-has-a-scope.md +46 -0
- package/agent-docs/publish/agent-friendliness.sections/keep-shared-instructions-complete.md +48 -0
- package/agent-docs/publish/agent-friendliness.sections/related-reading.md +52 -0
- package/agent-docs/publish/agent-friendliness.sections/secret-handshake.md +50 -0
- package/agent-docs/publish/agent-friendliness.sections/try-the-page-controls.md +62 -0
- package/agent-docs/publish/agent-friendliness.sections/use-the-transport-your-client-supports.md +50 -0
- package/agent-docs/publish/agent-friendliness.sections/verify-the-page-and-detect-changes.md +58 -0
- package/agent-docs/publish/agent-friendliness.sections/what-an-agent-reads.md +68 -0
- package/agent-docs/publish/agent-friendliness.sections/what-happens-to-an-unsupported-component.md +60 -0
- package/agent-docs/publish/api-references.md +219 -0
- package/agent-docs/publish/api-references.sections/author-the-reference-page.md +65 -0
- package/agent-docs/publish/api-references.sections/build-and-verify-the-output.md +48 -0
- package/agent-docs/publish/api-references.sections/inspect-the-machine-readable-contract.md +36 -0
- package/agent-docs/publish/api-references.sections/next-steps.md +62 -0
- package/agent-docs/publish/api-references.sections/preview-a-small-api-reference.md +38 -0
- package/agent-docs/publish/api-references.sections/put-the-spec-in-your-project.md +62 -0
- package/agent-docs/publish/api-references.sections/register-the-operation.md +64 -0
- package/agent-docs/publish/api-references.sections/related-reading.md +42 -0
- package/agent-docs/publish/api-references.sections/review-imported-content-before-publishing.md +54 -0
- package/agent-docs/publish/api-references.sections/what-readers-get.md +38 -0
- package/agent-docs/publish/audit.md +160 -0
- package/agent-docs/publish/audit.sections/add-project-tests.md +57 -0
- package/agent-docs/publish/audit.sections/check-agent-evaluation-reports.md +52 -0
- package/agent-docs/publish/audit.sections/check-before-pushing.md +80 -0
- package/agent-docs/publish/audit.sections/connect-a-documentation-test-suite.md +54 -0
- package/agent-docs/publish/audit.sections/read-the-report.md +67 -0
- package/agent-docs/publish/audit.sections/related-reading.md +47 -0
- package/agent-docs/publish/content-export.md +208 -0
- package/agent-docs/publish/content-export.sections/assets-downloads-and-notices.md +40 -0
- package/agent-docs/publish/content-export.sections/check-the-result.md +27 -0
- package/agent-docs/publish/content-export.sections/export-selected-pages.md +113 -0
- package/agent-docs/publish/content-export.sections/inspect-the-manifest.md +29 -0
- package/agent-docs/publish/content-export.sections/prerequisites.md +29 -0
- package/agent-docs/publish/content-export.sections/related-reading.md +35 -0
- package/agent-docs/publish/content-export.sections/review-exported-api-material.md +44 -0
- package/agent-docs/publish/content-export.sections/try-the-help-drawer-example.md +34 -0
- package/agent-docs/publish/content-export.sections/what-the-representations-retain.md +43 -0
- package/agent-docs/publish/content-negotiation.md +121 -0
- package/agent-docs/publish/content-negotiation.sections/hosting-contract.md +60 -0
- package/agent-docs/publish/content-negotiation.sections/missing-pages.md +51 -0
- package/agent-docs/publish/content-negotiation.sections/related-reading.md +45 -0
- package/agent-docs/publish/content-negotiation.sections/validators-and-manifest-links.md +49 -0
- package/agent-docs/publish/content-negotiation.sections/verify-the-deployed-url.md +62 -0
- package/agent-docs/publish/content-negotiation.sections/what-if-the-host-cannot-negotiate.md +47 -0
- package/agent-docs/publish/content-negotiation.sections/what-shoalrun-builds-and-what-the-host-does.md +49 -0
- package/agent-docs/publish/content-negotiation.sections/why-this-matters.md +47 -0
- package/agent-docs/publish/deployment-check.md +72 -0
- package/agent-docs/publish/evals.md +175 -0
- package/agent-docs/publish/evals.sections/add-the-audit-hook.md +63 -0
- package/agent-docs/publish/evals.sections/check-the-report.md +36 -0
- package/agent-docs/publish/evals.sections/define-a-task-file.md +47 -0
- package/agent-docs/publish/evals.sections/diagnose-a-different-build.md +42 -0
- package/agent-docs/publish/evals.sections/prepare-a-report-for-the-built-site.md +39 -0
- package/agent-docs/publish/evals.sections/related-reading.md +36 -0
- package/agent-docs/publish/evals.sections/run-and-review-the-tasks.md +54 -0
- package/agent-docs/publish/evals.sections/shoalrun-s-own-example.md +42 -0
- package/agent-docs/publish/host-adapters.md +60 -0
- package/agent-docs/publish/manni.md +227 -0
- package/agent-docs/publish/manni.sections/check-the-result.md +40 -0
- package/agent-docs/publish/manni.sections/how-this-site-uses-manni.md +83 -0
- package/agent-docs/publish/manni.sections/optional-custom-policies.md +42 -0
- package/agent-docs/publish/manni.sections/prerequisites.md +40 -0
- package/agent-docs/publish/mcp-analytics.md +356 -0
- package/agent-docs/publish/mcp-analytics.sections/adapter-exports.md +50 -0
- package/agent-docs/publish/mcp-analytics.sections/enable-analytics.md +45 -0
- package/agent-docs/publish/mcp-analytics.sections/event-fields-and-service-mappings.md +53 -0
- package/agent-docs/publish/mcp-analytics.sections/optionally-collect-intent-and-group-calls.md +62 -0
- package/agent-docs/publish/mcp-analytics.sections/optionally-identify-the-client-and-model.md +54 -0
- package/agent-docs/publish/mcp-analytics.sections/related-reading.md +36 -0
- package/agent-docs/publish/mcp-analytics.sections/safeguards-and-limits.md +46 -0
- package/agent-docs/publish/mcp.md +190 -0
- package/agent-docs/publish/mcp.sections/check-budgets-and-errors.md +52 -0
- package/agent-docs/publish/mcp.sections/choose-the-documentation-source.md +51 -0
- package/agent-docs/publish/mcp.sections/configure-the-client.md +55 -0
- package/agent-docs/publish/mcp.sections/generate-a-vercel-endpoint.md +50 -0
- package/agent-docs/publish/mcp.sections/related-reading.md +42 -0
- package/agent-docs/publish/mcp.sections/search-then-read.md +53 -0
- package/agent-docs/publish/mcp.sections/serve-a-public-endpoint-on-node.md +79 -0
- package/agent-docs/publish/mcp.sections/verify-the-connection.md +40 -0
- package/agent-docs/publish/mcp.sections/why-offer-mcp-for-public-docs.md +42 -0
- package/agent-docs/publish/openapi-extension-mappings.md +84 -0
- package/agent-docs/publish/output.md +220 -0
- package/agent-docs/publish/output.sections/api-contracts.md +48 -0
- package/agent-docs/publish/output.sections/code-highlighting.md +38 -0
- package/agent-docs/publish/output.sections/current-limits.md +40 -0
- package/agent-docs/publish/output.sections/incremental-sync.md +69 -0
- package/agent-docs/publish/output.sections/manifest-records-and-sections.md +46 -0
- package/agent-docs/publish/output.sections/navigation-section-indexes.md +42 -0
- package/agent-docs/publish/output.sections/page-formats.md +46 -0
- package/agent-docs/publish/output.sections/published-output-contract.md +58 -0
- package/agent-docs/publish/output.sections/reader-appearance-and-controls.md +44 -0
- package/agent-docs/publish/output.sections/related-reading.md +34 -0
- package/agent-docs/publish/output.sections/response-identity.md +38 -0
- package/agent-docs/publish/output.sections/site-files.md +64 -0
- package/agent-docs/publish/output.sections/validate-an-existing-build-locally.md +48 -0
- package/agent-docs/publish/output.sections/where-files-go.md +49 -0
- package/agent-docs/publish/publications.md +153 -0
- package/agent-docs/publish/revisions.md +104 -0
- package/agent-docs/publish/seo.md +119 -0
- package/agent-docs/publish/single-source-sites.md +168 -0
- package/agent-docs/publish/troubleshooting.md +112 -0
- package/agent-docs/publish/vercel.md +130 -0
- package/agent-docs/publish/vercel.sections/check-the-deployment.md +54 -0
- package/agent-docs/publish/vercel.sections/include-an-mcp-endpoint.md +38 -0
- package/agent-docs/publish/vercel.sections/prepare-your-project.md +52 -0
- package/agent-docs/publish/vercel.sections/related-reading.md +38 -0
- package/agent-docs/publish.md +95 -0
- package/agent-docs/recipes/add-page.md +194 -0
- package/agent-docs/recipes/add-page.sections/audit-the-shoalrun-docs-project.md +40 -0
- package/agent-docs/recipes/add-page.sections/before-you-start.md +32 -0
- package/agent-docs/recipes/add-page.sections/build-the-shoalrun-docs-site.md +42 -0
- package/agent-docs/recipes/add-page.sections/check-agent-search-and-page-lookup.md +42 -0
- package/agent-docs/recipes/add-page.sections/check-the-built-page-artifacts.md +54 -0
- package/agent-docs/recipes/add-page.sections/check-the-outcome.md +28 -0
- package/agent-docs/recipes/add-page.sections/complete-the-guide-and-add-navigation.md +42 -0
- package/agent-docs/recipes/add-page.sections/install-the-site-dependencies.md +41 -0
- package/agent-docs/recipes/add-page.sections/regenerate-the-agent-documentation-bundle.md +43 -0
- package/agent-docs/recipes/add-page.sections/related-reading.md +30 -0
- package/agent-docs/recipes/add-page.sections/scaffold-a-new-guide.md +42 -0
- package/agent-docs/recipes/audit-docs.md +121 -0
- package/agent-docs/recipes/build-docs.md +104 -0
- package/agent-docs/recipes/preview-hybrid-search.md +84 -0
- package/agent-docs/recipes/preview-page.md +123 -0
- package/agent-docs/recipes/queue-email.md +49 -0
- package/agent-docs/recipes/refresh-agent-docs.md +127 -0
- package/agent-docs/recipes/send-welcome-email.md +92 -0
- package/agent-docs/reference/agent-skills.md +73 -0
- package/agent-docs/search-and-chat.md +87 -0
- package/agent-docs/search-index.json +1 -0
- package/agent-docs/start.md +201 -0
- package/agent-docs/start.sections/add-the-page-to-navigation.md +50 -0
- package/agent-docs/start.sections/build-and-check-both-outputs.md +50 -0
- package/agent-docs/start.sections/build-this-site.md +35 -0
- package/agent-docs/start.sections/check-writing-style.md +35 -0
- package/agent-docs/start.sections/create-a-page.md +105 -0
- package/agent-docs/start.sections/make-it-yours.md +37 -0
- package/agent-docs/start.sections/migrating-from-github-packages.md +35 -0
- package/agent-docs/start.sections/prerequisites.md +37 -0
- package/agent-docs/start.sections/related-reading.md +45 -0
- package/agent-docs/start.sections/start-your-own-project.md +53 -0
- package/agent-docs/status.md +75 -0
- package/agent-docs/styling/color-modes.md +89 -0
- package/agent-docs/styling/footer.md +69 -0
- package/agent-docs/styling/header.md +67 -0
- package/agent-docs/styling/layouts.md +197 -0
- package/agent-docs/styling/layouts.sections/build-a-landing-page.md +61 -0
- package/agent-docs/styling/layouts.sections/build-a-splash-page.md +88 -0
- package/agent-docs/styling/layouts.sections/control-navigation-tabs.md +51 -0
- package/agent-docs/styling/layouts.sections/customize-the-hero.md +50 -0
- package/agent-docs/styling/layouts.sections/hero.md +83 -0
- package/agent-docs/styling/layouts.sections/html-markdown-and-agents.md +40 -0
- package/agent-docs/styling/layouts.sections/related-reading.md +42 -0
- package/agent-docs/styling/palettes.md +144 -0
- package/agent-docs/styling/share-images.md +109 -0
- package/agent-docs/styling/themes.md +128 -0
- package/agent-docs/styling/try.md +94 -0
- package/agent-docs/what-is-shoalrun.md +56 -0
- package/assets/analytics.js +72 -0
- package/assets/ask-widget.js +320 -0
- package/assets/code-samples.js +28 -0
- package/assets/components.js +32 -0
- package/assets/cookbook-chooser.js +170 -0
- package/assets/copy-markdown.js +24 -0
- package/assets/example-panel.js +77 -0
- package/assets/file-tree.js +49 -0
- package/assets/image-viewer.js +41 -0
- package/assets/mode.js +26 -0
- package/assets/navigation.js +233 -0
- package/assets/reader-filters.js +305 -0
- package/assets/reader.js +111 -0
- package/assets/search-highlight.js +32 -0
- package/assets/search-lexical.js +66 -0
- package/assets/search.js +150 -0
- package/assets/table-filter.js +63 -0
- package/assets/tabs.js +80 -0
- package/assets/theme-preview.css +17 -0
- package/assets/theme-preview.js +135 -0
- package/assets/theme-switcher.js +113 -0
- package/assets/tooltips.js +81 -0
- package/assets/walkthrough.js +233 -0
- package/dist/agent-discovery.d.ts +11 -0
- package/dist/agent-discovery.js +37 -0
- package/dist/analytics.d.ts +2 -0
- package/dist/analytics.js +13 -0
- package/dist/answer-cache.d.ts +24 -0
- package/dist/answer-cache.js +55 -0
- package/dist/answer-cards.d.ts +71 -0
- package/dist/answer-cards.js +148 -0
- package/dist/api-embeds.d.ts +22 -0
- package/dist/api-embeds.js +84 -0
- package/dist/api-identity.d.ts +6 -0
- package/dist/api-identity.js +7 -0
- package/dist/api-materialize.d.ts +12 -0
- package/dist/api-materialize.js +120 -0
- package/dist/api-publication-plan.d.ts +86 -0
- package/dist/api-publication-plan.js +187 -0
- package/dist/api-publication-review.d.ts +23 -0
- package/dist/api-publication-review.js +58 -0
- package/dist/api-selection.d.ts +21 -0
- package/dist/api-selection.js +84 -0
- package/dist/api.d.ts +74 -0
- package/dist/api.js +782 -0
- package/dist/artifact-bundle.d.ts +96 -0
- package/dist/artifact-bundle.js +306 -0
- package/dist/ask-function.d.ts +19 -0
- package/dist/ask-function.js +139 -0
- package/dist/ask-handler.d.ts +38 -0
- package/dist/ask-handler.js +157 -0
- package/dist/ask-log-kv.d.ts +14 -0
- package/dist/ask-log-kv.js +69 -0
- package/dist/ask-log.d.ts +106 -0
- package/dist/ask-log.js +159 -0
- package/dist/ask-setup.d.ts +43 -0
- package/dist/ask-setup.js +99 -0
- package/dist/ask.d.ts +152 -0
- package/dist/ask.js +532 -0
- package/dist/audit.d.ts +29 -0
- package/dist/audit.js +171 -0
- package/dist/authored-change.d.ts +22 -0
- package/dist/authored-change.js +47 -0
- package/dist/authoring-api.d.ts +18 -0
- package/dist/authoring-api.js +15 -0
- package/dist/authoring-findings.d.ts +31 -0
- package/dist/authoring-findings.js +104 -0
- package/dist/authoring-guidance.d.ts +15 -0
- package/dist/authoring-guidance.js +57 -0
- package/dist/authoring-preview.d.ts +24 -0
- package/dist/authoring-preview.js +160 -0
- package/dist/authoring-project-command.d.ts +7 -0
- package/dist/authoring-project-command.js +52 -0
- package/dist/authoring-project.d.ts +104 -0
- package/dist/authoring-project.js +287 -0
- package/dist/authoring-review-command.d.ts +1 -0
- package/dist/authoring-review-command.js +68 -0
- package/dist/authoring-review.d.ts +72 -0
- package/dist/authoring-review.js +71 -0
- package/dist/authoring-snapshot.d.ts +66 -0
- package/dist/authoring-snapshot.js +293 -0
- package/dist/authoring-validation-command.d.ts +1 -0
- package/dist/authoring-validation-command.js +54 -0
- package/dist/authoring-validation.d.ts +101 -0
- package/dist/authoring-validation.js +348 -0
- package/dist/badges.d.ts +16 -0
- package/dist/badges.js +57 -0
- package/dist/budget-store.d.ts +21 -0
- package/dist/budget-store.js +90 -0
- package/dist/budget.d.ts +45 -0
- package/dist/budget.js +128 -0
- package/dist/build-info.d.ts +10 -0
- package/dist/build-info.js +15 -0
- package/dist/callouts.d.ts +18 -0
- package/dist/callouts.js +63 -0
- package/dist/cards.d.ts +35 -0
- package/dist/cards.js +237 -0
- package/dist/chat-config.d.ts +117 -0
- package/dist/chat-config.js +400 -0
- package/dist/chat-pause.d.ts +1 -0
- package/dist/chat-pause.js +3 -0
- package/dist/chat.d.ts +46 -0
- package/dist/chat.js +78 -0
- package/dist/cli-discovery.d.ts +4 -0
- package/dist/cli-discovery.js +86 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +750 -0
- package/dist/code-samples.d.ts +50 -0
- package/dist/code-samples.js +181 -0
- package/dist/compact-discovery.d.ts +15 -0
- package/dist/compact-discovery.js +78 -0
- package/dist/compiler-config.d.ts +67 -0
- package/dist/compiler-config.js +66 -0
- package/dist/compiler.d.ts +208 -0
- package/dist/compiler.js +524 -0
- package/dist/component-bundle.d.ts +4 -0
- package/dist/component-bundle.js +32 -0
- package/dist/component-content.d.ts +78 -0
- package/dist/component-content.js +47 -0
- package/dist/component-manifest.d.ts +15 -0
- package/dist/component-manifest.js +84 -0
- package/dist/component-names.d.ts +1 -0
- package/dist/component-names.js +1 -0
- package/dist/component-plugins.d.ts +28 -0
- package/dist/component-plugins.js +141 -0
- package/dist/component-transform.d.ts +10 -0
- package/dist/component-transform.js +697 -0
- package/dist/components.d.ts +2 -0
- package/dist/components.js +1 -0
- package/dist/config.d.ts +29 -0
- package/dist/config.js +149 -0
- package/dist/content-export-assets.d.ts +23 -0
- package/dist/content-export-assets.js +103 -0
- package/dist/content-export-command.d.ts +20 -0
- package/dist/content-export-command.js +57 -0
- package/dist/content-export-config.d.ts +16 -0
- package/dist/content-export-config.js +50 -0
- package/dist/content-export-render.d.ts +12 -0
- package/dist/content-export-render.js +132 -0
- package/dist/content-export.d.ts +30 -0
- package/dist/content-export.js +307 -0
- package/dist/content-filter.d.ts +4 -0
- package/dist/content-filter.js +16 -0
- package/dist/content-source.d.ts +100 -0
- package/dist/content-source.js +42 -0
- package/dist/content-workspace.d.ts +293 -0
- package/dist/content-workspace.js +69 -0
- package/dist/content.d.ts +41 -0
- package/dist/content.js +176 -0
- package/dist/cookbook-chooser.d.ts +19 -0
- package/dist/cookbook-chooser.js +56 -0
- package/dist/dev.d.ts +2 -0
- package/dist/dev.js +113 -0
- package/dist/diagram-svg.d.ts +1 -0
- package/dist/diagram-svg.js +44 -0
- package/dist/diagrams.d.ts +7 -0
- package/dist/diagrams.js +102 -0
- package/dist/docs-author.d.ts +86 -0
- package/dist/docs-author.js +380 -0
- package/dist/docs-command.d.ts +8 -0
- package/dist/docs-command.js +62 -0
- package/dist/docs-eval.d.ts +146 -0
- package/dist/docs-eval.js +231 -0
- package/dist/docs-mcp.d.ts +12 -0
- package/dist/docs-mcp.js +82 -0
- package/dist/docs-tool.d.ts +81 -0
- package/dist/docs-tool.js +7 -0
- package/dist/document-sync.d.ts +36 -0
- package/dist/document-sync.js +58 -0
- package/dist/documentation-core.d.ts +148 -0
- package/dist/documentation-core.js +160 -0
- package/dist/embeddings.d.ts +68 -0
- package/dist/embeddings.js +198 -0
- package/dist/focused-audit.d.ts +10 -0
- package/dist/focused-audit.js +69 -0
- package/dist/focused-openapi.d.ts +2 -0
- package/dist/focused-openapi.js +140 -0
- package/dist/fonts.d.ts +54 -0
- package/dist/fonts.js +92 -0
- package/dist/freshness.d.ts +7 -0
- package/dist/freshness.js +58 -0
- package/dist/frontmatter.d.ts +24 -0
- package/dist/frontmatter.js +342 -0
- package/dist/function-package.d.ts +1 -0
- package/dist/function-package.js +58 -0
- package/dist/highlight.d.ts +14 -0
- package/dist/highlight.js +114 -0
- package/dist/html-renderer.d.ts +10 -0
- package/dist/html-renderer.js +63 -0
- package/dist/icons.d.ts +8 -0
- package/dist/icons.js +40 -0
- package/dist/index-build.d.ts +55 -0
- package/dist/index-build.js +227 -0
- package/dist/ingredient-draft.d.ts +17 -0
- package/dist/ingredient-draft.js +94 -0
- package/dist/ingredient-workflow.d.ts +8 -0
- package/dist/ingredient-workflow.js +25 -0
- package/dist/init.d.ts +8 -0
- package/dist/init.js +66 -0
- package/dist/jev.d.ts +62 -0
- package/dist/jev.js +190 -0
- package/dist/link-audit.d.ts +12 -0
- package/dist/link-audit.js +146 -0
- package/dist/llms-discovery.d.ts +11 -0
- package/dist/llms-discovery.js +23 -0
- package/dist/markdown-sections.d.ts +15 -0
- package/dist/markdown-sections.js +60 -0
- package/dist/markdown-size.d.ts +7 -0
- package/dist/markdown-size.js +6 -0
- package/dist/mcp-analytics.d.ts +38 -0
- package/dist/mcp-analytics.js +35 -0
- package/dist/mcp-artifacts.d.ts +2 -0
- package/dist/mcp-artifacts.js +78 -0
- package/dist/mcp-client-metadata.d.ts +18 -0
- package/dist/mcp-client-metadata.js +69 -0
- package/dist/mcp-config.d.ts +23 -0
- package/dist/mcp-config.js +56 -0
- package/dist/mcp-http.d.ts +19 -0
- package/dist/mcp-http.js +157 -0
- package/dist/mcp-integrity.d.ts +3 -0
- package/dist/mcp-integrity.js +4 -0
- package/dist/mcp-node.d.ts +4 -0
- package/dist/mcp-node.js +68 -0
- package/dist/mcp-vercel-runtime.d.ts +3 -0
- package/dist/mcp-vercel-runtime.js +36 -0
- package/dist/mcp-vercel.d.ts +15 -0
- package/dist/mcp-vercel.js +65 -0
- package/dist/metadata-provider.d.ts +19 -0
- package/dist/metadata-provider.js +38 -0
- package/dist/negotiation.d.ts +10 -0
- package/dist/negotiation.js +35 -0
- package/dist/not-found.d.ts +16 -0
- package/dist/not-found.js +25 -0
- package/dist/output-commit.d.ts +1 -0
- package/dist/output-commit.js +133 -0
- package/dist/output-location.d.ts +3 -0
- package/dist/output-location.js +30 -0
- package/dist/page-materialization.d.ts +78 -0
- package/dist/page-materialization.js +132 -0
- package/dist/page-renderer.d.ts +71 -0
- package/dist/page-renderer.js +177 -0
- package/dist/palettes.d.ts +41 -0
- package/dist/palettes.js +160 -0
- package/dist/procedure-components.d.ts +2 -0
- package/dist/procedure-components.js +94 -0
- package/dist/project-navigation.d.ts +41 -0
- package/dist/project-navigation.js +190 -0
- package/dist/provider-http.d.ts +10 -0
- package/dist/provider-http.js +60 -0
- package/dist/publication-manifest.d.ts +229 -0
- package/dist/publication-manifest.js +53 -0
- package/dist/publication-plan.d.ts +34 -0
- package/dist/publication-plan.js +85 -0
- package/dist/publication-render.d.ts +71 -0
- package/dist/publication-render.js +92 -0
- package/dist/reader-filters.d.ts +30 -0
- package/dist/reader-filters.js +105 -0
- package/dist/recipe-draft.d.ts +17 -0
- package/dist/recipe-draft.js +147 -0
- package/dist/reference-audit.d.ts +18 -0
- package/dist/reference-audit.js +169 -0
- package/dist/remote-import.d.ts +62 -0
- package/dist/remote-import.js +292 -0
- package/dist/representation-tree.d.ts +3 -0
- package/dist/representation-tree.js +320 -0
- package/dist/retrieval-config.d.ts +30 -0
- package/dist/retrieval-config.js +83 -0
- package/dist/retrieval.d.ts +60 -0
- package/dist/retrieval.js +228 -0
- package/dist/scaffold.d.ts +39 -0
- package/dist/scaffold.js +167 -0
- package/dist/search-config.d.ts +8 -0
- package/dist/search-config.js +26 -0
- package/dist/search-handler.d.ts +16 -0
- package/dist/search-handler.js +111 -0
- package/dist/search-identifier.d.ts +3 -0
- package/dist/search-identifier.js +25 -0
- package/dist/search-literal.d.ts +1 -0
- package/dist/search-literal.js +28 -0
- package/dist/search-query.d.ts +54 -0
- package/dist/search-query.js +120 -0
- package/dist/search-results.d.ts +6 -0
- package/dist/search-results.js +45 -0
- package/dist/search-snippet.d.ts +11 -0
- package/dist/search-snippet.js +93 -0
- package/dist/search-synonyms.d.ts +8 -0
- package/dist/search-synonyms.js +46 -0
- package/dist/semantic-markdown.d.ts +10 -0
- package/dist/semantic-markdown.js +39 -0
- package/dist/server.d.ts +10 -0
- package/dist/server.js +223 -0
- package/dist/share-images.d.ts +24 -0
- package/dist/share-images.js +187 -0
- package/dist/site-path.d.ts +2 -0
- package/dist/site-path.js +15 -0
- package/dist/sitemap.d.ts +8 -0
- package/dist/sitemap.js +58 -0
- package/dist/snippets.d.ts +19 -0
- package/dist/snippets.js +84 -0
- package/dist/structured-model-output.d.ts +6 -0
- package/dist/structured-model-output.js +21 -0
- package/dist/subject-deprecation.d.ts +21 -0
- package/dist/subject-deprecation.js +57 -0
- package/dist/surface-text.d.ts +4 -0
- package/dist/surface-text.js +42 -0
- package/dist/taxonomy.d.ts +14 -0
- package/dist/taxonomy.js +88 -0
- package/dist/turnstile.d.ts +21 -0
- package/dist/turnstile.js +52 -0
- package/dist/vale.d.ts +28 -0
- package/dist/vale.js +103 -0
- package/dist/vercel-function.d.ts +21 -0
- package/dist/vercel-function.js +108 -0
- package/dist/vercel.d.ts +11 -0
- package/dist/vercel.js +103 -0
- package/dist/walkthrough.d.ts +25 -0
- package/dist/walkthrough.js +336 -0
- package/dist/yaml-value.d.ts +2 -0
- package/dist/yaml-value.js +36 -0
- package/example-configs/api-docs/README.md +59 -0
- package/example-configs/api-docs/apis/cedar-parcel.yaml +413 -0
- package/example-configs/api-docs/content/create-enrollment.mdx +11 -0
- package/example-configs/api-docs/content/overview.mdx +36 -0
- package/example-configs/api-docs/content/quickstart.mdx +52 -0
- package/example-configs/api-docs/docs.config.yaml +104 -0
- package/example-configs/faceted-sites/README.md +31 -0
- package/example-configs/faceted-sites/base.yaml +30 -0
- package/example-configs/faceted-sites/content/api.md +12 -0
- package/example-configs/faceted-sites/content/home.md +10 -0
- package/example-configs/faceted-sites/content/operations.md +12 -0
- package/example-configs/faceted-sites/developers.config.yaml +8 -0
- package/example-configs/faceted-sites/docs.config.yaml +7 -0
- package/example-configs/faceted-sites/europe.config.yaml +9 -0
- package/example-configs/minimal/content/install.mdx +12 -0
- package/example-configs/minimal/content/welcome.mdx +8 -0
- package/example-configs/minimal/docs.config.yaml +31 -0
- package/example-configs/multilingual/content/de/home.mdx +9 -0
- package/example-configs/multilingual/content/de/reset-password.mdx +9 -0
- package/example-configs/multilingual/content/home.mdx +10 -0
- package/example-configs/multilingual/content/reset-password.mdx +12 -0
- package/example-configs/multilingual/docs.config.yaml +61 -0
- package/example-configs/multilingual/snippets/contact.mdx +1 -0
- package/example-configs/notifications/apis/notifications.yaml +132 -0
- package/example-configs/notifications/content/cookbook.mdx +17 -0
- package/example-configs/notifications/content/get-message.mdx +14 -0
- package/example-configs/notifications/content/queue-email.mdx +42 -0
- package/example-configs/notifications/content/queue-push.mdx +33 -0
- package/example-configs/notifications/content/queue-sms.mdx +33 -0
- package/example-configs/notifications/content/send-email.mdx +14 -0
- package/example-configs/notifications/content/send-push.mdx +14 -0
- package/example-configs/notifications/content/send-sms.mdx +14 -0
- package/example-configs/notifications/content/start.mdx +13 -0
- package/example-configs/notifications/content/welcome-cookbook.mdx +21 -0
- package/example-configs/notifications/content/welcome-email.mdx +82 -0
- package/example-configs/notifications/demo.mjs +43 -0
- package/example-configs/notifications/docs.config.yaml +88 -0
- package/example-configs/notifications/ingredient-drafts/README.md +41 -0
- package/example-configs/notifications/ingredient-drafts/check-delivery.mdx +13 -0
- package/example-configs/notifications/ingredient-drafts/queue-welcome-email.mdx +48 -0
- package/example-configs/notifications/ingredient-specs/queue-welcome-email.yaml +7 -0
- package/example-configs/notifications/ingredients/check-delivery.mdx +42 -0
- package/example-configs/notifications/ingredients/queue-welcome-email.mdx +37 -0
- package/example-configs/notifications/recipe-drafts/send-welcome-email.mdx +91 -0
- package/example-configs/notifications/recipe-specs/send-welcome-email.yaml +11 -0
- package/example-configs/reference-stress/README.md +32 -0
- package/example-configs/reference-stress/apis/cedar-parcel.yaml +413 -0
- package/example-configs/reference-stress/content/enrollment-shapes.mdx +16 -0
- package/example-configs/reference-stress/content/overview.mdx +14 -0
- package/example-configs/reference-stress/docs.config.yaml +55 -0
- package/example-configs/shared-preset/shared/company-docs.yaml +46 -0
- package/example-configs/shared-preset/shared/runbook.mdx +7 -0
- package/example-configs/shared-preset/site/content/failed-invoices.mdx +15 -0
- package/example-configs/shared-preset/site/content/start.mdx +9 -0
- package/example-configs/shared-preset/site/docs.config.yaml +18 -0
- package/example-configs/showcase/README.md +20 -0
- package/example-configs/showcase/apis/cedar-parcel.yaml +413 -0
- package/example-configs/showcase/content/assets/collection.svg +1 -0
- package/example-configs/showcase/content/code.mdx +100 -0
- package/example-configs/showcase/content/create-enrollment.mdx +11 -0
- package/example-configs/showcase/content/features.mdx +39 -0
- package/example-configs/showcase/content/landing.mdx +36 -0
- package/example-configs/showcase/content/overview.mdx +42 -0
- package/example-configs/showcase/content/personalization.mdx +38 -0
- package/example-configs/showcase/content/preview.mdx +35 -0
- package/example-configs/showcase/content/procedures.mdx +88 -0
- package/example-configs/showcase/content/quickstart.mdx +64 -0
- package/example-configs/showcase/content/reading.mdx +99 -0
- package/example-configs/showcase/content/verify.mdx +27 -0
- package/example-configs/showcase/content/visuals.mdx +47 -0
- package/example-configs/showcase/content/workflows.mdx +12 -0
- package/example-configs/showcase/docs.config.yaml +149 -0
- package/example-configs/showcase/snippets/sandbox.mdx +1 -0
- package/examples/analytics/README.md +56 -0
- package/examples/analytics/inspector.js +25 -0
- package/examples/analytics/posthog.js +36 -0
- package/examples/components/comparison.mjs +8 -0
- package/examples/components/components.json +6 -0
- package/examples/components/copy-text/LICENSE.react-dom.txt +21 -0
- package/examples/components/copy-text/LICENSE.react.txt +21 -0
- package/examples/components/copy-text/LICENSE.scheduler.txt +21 -0
- package/examples/components/copy-text/browser.jsx +21 -0
- package/examples/components/copy-text/components.json +6 -0
- package/examples/components/copy-text/package-lock.json +41 -0
- package/examples/components/copy-text/package.json +9 -0
- package/examples/components/copy-text/plugin.mjs +5 -0
- package/examples/components/retry-budget/LICENSE.react-dom.txt +21 -0
- package/examples/components/retry-budget/LICENSE.react.txt +21 -0
- package/examples/components/retry-budget/LICENSE.scheduler.txt +21 -0
- package/examples/components/retry-budget/browser.jsx +50 -0
- package/examples/components/retry-budget/components.json +6 -0
- package/examples/components/retry-budget/model.js +22 -0
- package/examples/components/retry-budget/package-lock.json +41 -0
- package/examples/components/retry-budget/package.json +9 -0
- package/examples/components/retry-budget/plugin.mjs +31 -0
- package/examples/components/retry-budget/policy.json +9 -0
- package/examples/components/retry-budget/style.css +25 -0
- package/examples/diagrams/d2-gallery.json +138 -0
- package/examples/diagrams/gallery.json +236 -0
- package/examples/help-drawer/README.md +44 -0
- package/examples/help-drawer/app.js +53 -0
- package/examples/help-drawer/components/components.json +1 -0
- package/examples/help-drawer/components/support.mjs +10 -0
- package/examples/help-drawer/content/account.md +8 -0
- package/examples/help-drawer/content/billing.mdx +29 -0
- package/examples/help-drawer/content/keys.mdx +46 -0
- package/examples/help-drawer/content/settings.svg +1 -0
- package/examples/help-drawer/docs.config.yaml +30 -0
- package/examples/help-drawer/index.html +26 -0
- package/examples/help-drawer/preview.mjs +33 -0
- package/examples/mcp-analytics/README.md +59 -0
- package/examples/mcp-analytics/posthog.mjs +159 -0
- package/package.json +100 -4
- package/schemas/content-export.schema.json +55 -0
- package/skills/shoalrun-author/SKILL.md +52 -0
- package/skills/shoalrun-component-author/SKILL.md +24 -0
- package/skills/shoalrun-recipes/SKILL.md +25 -0
- package/skills/shoalrun-setup/SKILL.md +34 -0
- package/skills/shoalrun-walkthrough/SKILL.md +18 -0
- package/styles/fonts/figtree-LICENSE.txt +93 -0
- package/styles/fonts/figtree-italic.woff2 +0 -0
- package/styles/fonts/figtree.woff2 +0 -0
- package/styles/fonts/inter-LICENSE.txt +93 -0
- package/styles/fonts/inter-italic.woff2 +0 -0
- package/styles/fonts/inter.woff2 +0 -0
- package/styles/fonts/jetbrains-mono-LICENSE.txt +93 -0
- package/styles/fonts/jetbrains-mono.woff2 +0 -0
- package/styles/fonts/jost-LICENSE.txt +93 -0
- package/styles/fonts/jost-italic.woff2 +0 -0
- package/styles/fonts/jost.woff2 +0 -0
- package/styles/fonts/share/figtree-400.ttf +0 -0
- package/styles/fonts/share/figtree-700.ttf +0 -0
- package/styles/fonts/share/inter-400.ttf +0 -0
- package/styles/fonts/share/inter-700.ttf +0 -0
- package/styles/fonts/share/jetbrains-mono-700.ttf +0 -0
- package/styles/fonts/share/jost-italic-800.ttf +0 -0
- package/styles/fonts/share/metrics.json +1 -0
- package/styles/fonts/share/source-serif-4-400.ttf +0 -0
- package/styles/fonts/source-serif-4-LICENSE.txt +93 -0
- package/styles/fonts/source-serif-4-italic.woff2 +0 -0
- package/styles/fonts/source-serif-4.woff2 +0 -0
- package/styles/header.css +56 -0
- package/styles/site.css +825 -0
- package/styles/themes/ledger.css +93 -0
- package/styles/themes/palettes/amethyst.yaml +127 -0
- package/styles/themes/palettes/coral.yaml +127 -0
- package/styles/themes/palettes/harbor.yaml +127 -0
- package/styles/themes/palettes/ink.yaml +127 -0
- package/styles/themes/palettes/kelp.yaml +127 -0
- package/styles/themes/palettes/vice.yaml +127 -0
- package/styles/themes/reef.css +68 -0
- package/styles/themes/vice.css +56 -0
- package/styles/tokens.css +91 -0
- package/templates/api-reference.mdx +133 -0
- package/templates/cookbook.mdx +38 -0
- package/templates/explanation.mdx +76 -0
- package/templates/guide.mdx +175 -0
- package/templates/how-to.mdx +171 -0
- package/templates/ingredient.mdx +53 -0
- package/templates/recipe.mdx +76 -0
- package/templates/reference.mdx +171 -0
- package/templates/troubleshooting.mdx +159 -0
- package/templates/tutorial.mdx +165 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export type MarkdownSection = {
|
|
2
|
+
id: string;
|
|
3
|
+
title: string;
|
|
4
|
+
depth: 2;
|
|
5
|
+
standalone?: true;
|
|
6
|
+
markdownUrl: string;
|
|
7
|
+
parentMarkdownUrl: string;
|
|
8
|
+
parentDigest: string;
|
|
9
|
+
digest: string;
|
|
10
|
+
markdownBytes: number;
|
|
11
|
+
markdownTokens: number;
|
|
12
|
+
markdownTokenEncoding: string;
|
|
13
|
+
content: string;
|
|
14
|
+
};
|
|
15
|
+
export declare function markdownSections(tree: any, markdownUrl: string, parent: string, prefix: string, render: (tree: any) => string, standaloneTitles?: string[]): MarkdownSection[];
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { createHash } from 'node:crypto';
|
|
2
|
+
import { markdownSize } from './markdown-size.js';
|
|
3
|
+
import { link, list, paragraph, renderMarkdown, root, text } from './semantic-markdown.js';
|
|
4
|
+
const digest = (value) => createHash('sha256').update(value).digest('hex');
|
|
5
|
+
const pathKey = (item) => `${item.type}:${item.id}`;
|
|
6
|
+
// Only direct page children qualify: hoisting a view from a ReaderSection, tab,
|
|
7
|
+
// representation-only block, or another nested scope would change its meaning.
|
|
8
|
+
const readingPaths = (nodes) => nodes.flatMap(node => node.data?.sectionReadingPath ?? []);
|
|
9
|
+
function missingReadingPath(all, included) {
|
|
10
|
+
const seen = new Set(readingPaths(included).map(pathKey));
|
|
11
|
+
const missing = readingPaths(all).filter(item => {
|
|
12
|
+
const key = pathKey(item);
|
|
13
|
+
if (seen.has(key))
|
|
14
|
+
return false;
|
|
15
|
+
seen.add(key);
|
|
16
|
+
return true;
|
|
17
|
+
});
|
|
18
|
+
if (!missing.length)
|
|
19
|
+
return [];
|
|
20
|
+
return [paragraph({ type: 'strong', children: [text('Page reading path')] }, text(' — these links apply to the full page.')),
|
|
21
|
+
...['prerequisite', 'next-step'].flatMap(type => {
|
|
22
|
+
const entries = missing.filter(item => item.type === type);
|
|
23
|
+
return entries.length ? [paragraph({ type: 'strong', children: [text(type === 'prerequisite' ? 'Read first' : 'Next steps')] }),
|
|
24
|
+
list(entries.map(item => [paragraph(link(item.url, item.title), text(` — ${item.reason}`), ...(item.status ? [text(` (Status: ${item.status}.)`)] : []))]))] : [];
|
|
25
|
+
})];
|
|
26
|
+
}
|
|
27
|
+
const textOf = (node) => typeof node.value === 'string' ? node.value : (node.children ?? []).map(textOf).join('');
|
|
28
|
+
// Split the semantic root, never the flattened Markdown: a reader section or tab
|
|
29
|
+
// remains intact even when it contains headings. Nested headings are not resources.
|
|
30
|
+
export function markdownSections(tree, markdownUrl, parent, prefix, render, standaloneTitles = []) {
|
|
31
|
+
const parentSize = markdownSize(parent);
|
|
32
|
+
const children = tree.children ?? [];
|
|
33
|
+
const starts = children.flatMap((node, index) => node.type === 'heading' && node.depth === 2 ? [index] : []);
|
|
34
|
+
// Check declarations even on short pages: a renamed or ambiguous heading must
|
|
35
|
+
// never silently retain an author's approval. Titles refer to normalized text.
|
|
36
|
+
for (const title of standaloneTitles) {
|
|
37
|
+
if (starts.filter(start => textOf(children[start]).trim() === title).length !== 1) {
|
|
38
|
+
throw new Error(`${markdownUrl}: standaloneSections title "${title}" must match exactly one top-level level-two heading`);
|
|
39
|
+
}
|
|
40
|
+
}
|
|
41
|
+
if (parentSize.markdownTokens < 2000)
|
|
42
|
+
return [];
|
|
43
|
+
const preamble = children.slice(0, starts[0] ?? 0);
|
|
44
|
+
const used = new Set();
|
|
45
|
+
return starts.map(start => {
|
|
46
|
+
const title = textOf(children[start]).trim();
|
|
47
|
+
const stem = title.normalize('NFKD').toLowerCase().replace(/[\u0300-\u036f]/g, '').replace(/[^a-z0-9]+/g, '-').replace(/^-|-$/g, '').slice(0, 80).replace(/-$/, '') || 'section';
|
|
48
|
+
let id = stem;
|
|
49
|
+
for (let suffix = 2; used.has(id); suffix++)
|
|
50
|
+
id = `${stem}-${suffix}`;
|
|
51
|
+
used.add(id);
|
|
52
|
+
const end = children.findIndex((node, position) => position > start && node.type === 'heading' && node.depth <= 2);
|
|
53
|
+
const nodes = [...preamble, ...children.slice(start, end === -1 ? children.length : end)].filter(node => !['definition', 'footnoteDefinition'].includes(node.type));
|
|
54
|
+
const definitions = children.filter(node => ['definition', 'footnoteDefinition'].includes(node.type));
|
|
55
|
+
const content = prefix + renderMarkdown(root([paragraph(text('Parent page: '), link(markdownUrl, 'Full Markdown page'))])) + '\n'
|
|
56
|
+
+ render(root([...missingReadingPath(children, nodes), ...nodes, ...definitions]));
|
|
57
|
+
return { id, title, depth: 2, ...(standaloneTitles.includes(title) ? { standalone: true } : {}), markdownUrl: `${markdownUrl.slice(0, -3)}.sections/${id}.md`, parentMarkdownUrl: markdownUrl,
|
|
58
|
+
parentDigest: digest(parent), digest: digest(content), ...markdownSize(content), content };
|
|
59
|
+
}).filter(section => section.markdownTokens <= parentSize.markdownTokens / 2 && section.markdownBytes <= parentSize.markdownBytes / 2);
|
|
60
|
+
}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
export declare const markdownTokenEncoding = "cl100k_base";
|
|
2
|
+
export declare const markdownTokens: (value: string) => number;
|
|
3
|
+
export declare const markdownSize: (value: string) => {
|
|
4
|
+
markdownBytes: number;
|
|
5
|
+
markdownTokens: number;
|
|
6
|
+
markdownTokenEncoding: string;
|
|
7
|
+
};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import { getEncoding } from 'js-tiktoken';
|
|
2
|
+
export const markdownTokenEncoding = 'cl100k_base';
|
|
3
|
+
let encoding;
|
|
4
|
+
// Treat special-token spellings in documentation as ordinary text.
|
|
5
|
+
export const markdownTokens = (value) => (encoding ??= getEncoding(markdownTokenEncoding)).encode(value, [], []).length;
|
|
6
|
+
export const markdownSize = (value) => ({ markdownBytes: Buffer.byteLength(value, 'utf8'), markdownTokens: markdownTokens(value), markdownTokenEncoding });
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { McpServer, ServerContext } from '@modelcontextprotocol/server';
|
|
2
|
+
import type { McpClientMetadata } from './mcp-client-metadata.js';
|
|
3
|
+
export type McpAnalyticsEvent = McpClientMetadata & {
|
|
4
|
+
name: 'mcp_tool_call';
|
|
5
|
+
tool: string;
|
|
6
|
+
durationMs: number;
|
|
7
|
+
isError: boolean;
|
|
8
|
+
errorCode?: string;
|
|
9
|
+
pageId?: string;
|
|
10
|
+
sectionId?: string;
|
|
11
|
+
buildId: string;
|
|
12
|
+
publication: {
|
|
13
|
+
channel: string;
|
|
14
|
+
version: string;
|
|
15
|
+
language: string;
|
|
16
|
+
};
|
|
17
|
+
};
|
|
18
|
+
export type McpAnalyticsContext = {
|
|
19
|
+
buildId: string;
|
|
20
|
+
publication: McpAnalyticsEvent['publication'];
|
|
21
|
+
clientMetadata: boolean;
|
|
22
|
+
intent: boolean;
|
|
23
|
+
conversationIds: boolean;
|
|
24
|
+
metadata(context: ServerContext): McpClientMetadata;
|
|
25
|
+
client(name: unknown, version?: unknown): McpClientMetadata['client'];
|
|
26
|
+
resource(id: unknown, section: unknown): Promise<{
|
|
27
|
+
pageId?: string;
|
|
28
|
+
sectionId?: string;
|
|
29
|
+
}>;
|
|
30
|
+
modelName(value: unknown): string | undefined;
|
|
31
|
+
};
|
|
32
|
+
export type McpAnalyticsAdapter = {
|
|
33
|
+
capture(event: McpAnalyticsEvent): void | Promise<void>;
|
|
34
|
+
instrument?(server: McpServer, context: McpAnalyticsContext): boolean | Promise<boolean>;
|
|
35
|
+
flush?(): void | Promise<void>;
|
|
36
|
+
};
|
|
37
|
+
export declare function attemptAnalytics(operation: () => unknown, milliseconds?: number): Promise<void>;
|
|
38
|
+
export declare function mcpAnalyticsLoader(directory: string, module: string | undefined): () => Promise<McpAnalyticsAdapter | undefined>;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import path from 'node:path';
|
|
2
|
+
import { pathToFileURL } from 'node:url';
|
|
3
|
+
// Analytics has its own small deadline and cannot reject a documentation request.
|
|
4
|
+
export async function attemptAnalytics(operation, milliseconds = 1000) {
|
|
5
|
+
let timeout;
|
|
6
|
+
try {
|
|
7
|
+
await Promise.race([
|
|
8
|
+
Promise.resolve().then(operation),
|
|
9
|
+
new Promise((_, reject) => { timeout = setTimeout(() => reject(new Error('timeout')), milliseconds); }),
|
|
10
|
+
]);
|
|
11
|
+
}
|
|
12
|
+
catch {
|
|
13
|
+
process.stderr.write('MCP analytics delivery failed or timed out\n');
|
|
14
|
+
}
|
|
15
|
+
finally {
|
|
16
|
+
clearTimeout(timeout);
|
|
17
|
+
}
|
|
18
|
+
}
|
|
19
|
+
export function mcpAnalyticsLoader(directory, module) {
|
|
20
|
+
let pending;
|
|
21
|
+
return () => {
|
|
22
|
+
if (!module)
|
|
23
|
+
return Promise.resolve(undefined);
|
|
24
|
+
pending ??= (async () => {
|
|
25
|
+
const adapter = await import(pathToFileURL(path.join(directory, module)).href);
|
|
26
|
+
if (typeof adapter.capture !== 'function' || adapter.instrument !== undefined && typeof adapter.instrument !== 'function' || adapter.flush !== undefined && typeof adapter.flush !== 'function')
|
|
27
|
+
throw new Error('Invalid MCP analytics adapter');
|
|
28
|
+
return adapter;
|
|
29
|
+
})().catch(() => {
|
|
30
|
+
process.stderr.write('MCP analytics adapter could not load\n');
|
|
31
|
+
return undefined;
|
|
32
|
+
});
|
|
33
|
+
return pending;
|
|
34
|
+
};
|
|
35
|
+
}
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { mkdtemp, readFile, readdir, rm, writeFile } from 'node:fs/promises';
|
|
2
|
+
import os from 'node:os';
|
|
3
|
+
import path from 'node:path';
|
|
4
|
+
import { copyFunctionRuntime } from './function-package.js';
|
|
5
|
+
import { fingerprint, mcpRuntimePath, mcpDataPath } from './mcp-integrity.js';
|
|
6
|
+
import { searchIndex } from './content.js';
|
|
7
|
+
import { resolveMcp } from './mcp-config.js';
|
|
8
|
+
export async function addMcpArtifacts(artifacts, config, manifest, rendered, headers, analyticsModule) {
|
|
9
|
+
const mcp = resolveMcp(config.mcp);
|
|
10
|
+
if (!mcp)
|
|
11
|
+
return;
|
|
12
|
+
const endpoint = `${manifest.basePath}${mcp.path}`;
|
|
13
|
+
const variant = ['channel', 'version', 'language'].map(key => mcp.publication[key]).join('|');
|
|
14
|
+
const selected = rendered.filter(page => ['channel', 'version', 'language'].every(key => page.doc.variant[key] === mcp.publication[key]));
|
|
15
|
+
if (!selected.length || selected.some(page => page.doc.frontmatter.access?.policy !== 'public'))
|
|
16
|
+
throw new Error('mcp.publication must select nonempty, normally published public documentation');
|
|
17
|
+
for (const artifact of artifacts.keys()) {
|
|
18
|
+
const route = artifact.toLowerCase();
|
|
19
|
+
if ([endpoint, mcpRuntimePath, mcpDataPath].some(reserved => {
|
|
20
|
+
const value = reserved.toLowerCase();
|
|
21
|
+
return route === value || route.startsWith(`${value}/`) || value.startsWith(`${route}/`);
|
|
22
|
+
}))
|
|
23
|
+
throw new Error(`MCP output route collision: ${artifact}`);
|
|
24
|
+
}
|
|
25
|
+
if (manifest.redirects.some((r) => r.from === endpoint || r.markdownFrom === endpoint))
|
|
26
|
+
throw new Error('MCP endpoint conflicts with a redirect');
|
|
27
|
+
const docs = manifest.documents.filter((doc) => ['channel', 'version', 'language'].every(key => doc.variant[key] === mcp.publication[key]));
|
|
28
|
+
const inventory = {};
|
|
29
|
+
const put = (file, value) => {
|
|
30
|
+
artifacts.set(`${mcpDataPath}/${file}`, value);
|
|
31
|
+
inventory[file] = fingerprint(value);
|
|
32
|
+
};
|
|
33
|
+
const records = new Map(docs.map((doc) => [doc.markdownUrl, doc]));
|
|
34
|
+
const index = searchIndex(selected, config);
|
|
35
|
+
const search = { ...index, documents: index.documents.map(doc => {
|
|
36
|
+
const record = records.get(doc.markdownUrl);
|
|
37
|
+
return { ...doc, markdownBytes: record.markdownBytes, markdownTokens: record.markdownTokens, markdownTokenEncoding: record.markdownTokenEncoding, sections: record.sections };
|
|
38
|
+
}) };
|
|
39
|
+
if (search.documents.some(doc => doc.variant !== variant))
|
|
40
|
+
throw new Error('MCP search publication mismatch');
|
|
41
|
+
put('documents.json', JSON.stringify({ schemaVersion: 1, documents: docs }));
|
|
42
|
+
put('search-index.json', JSON.stringify(search));
|
|
43
|
+
for (const doc of docs)
|
|
44
|
+
for (const resource of [doc, ...doc.sections]) {
|
|
45
|
+
const content = artifacts.get(resource.markdownUrl);
|
|
46
|
+
if (content === undefined || fingerprint(content) !== resource.digest)
|
|
47
|
+
throw new Error(`Missing or inconsistent MCP resource: ${resource.markdownUrl}`);
|
|
48
|
+
put(resource.markdownUrl.slice(1), content);
|
|
49
|
+
}
|
|
50
|
+
if (mcp.analytics) {
|
|
51
|
+
if (!analyticsModule)
|
|
52
|
+
throw new Error('Missing MCP analytics module');
|
|
53
|
+
const temporary = await mkdtemp(path.join(os.tmpdir(), 'shoalrun-mcp-adapter-'));
|
|
54
|
+
try {
|
|
55
|
+
await copyFunctionRuntime(path.dirname(analyticsModule), path.basename(analyticsModule), temporary);
|
|
56
|
+
await writeFile(path.join(temporary, 'package.json'), JSON.stringify({ type: 'module' }));
|
|
57
|
+
const collect = async (folder) => {
|
|
58
|
+
for (const entry of await readdir(folder, { withFileTypes: true })) {
|
|
59
|
+
const file = path.join(folder, entry.name);
|
|
60
|
+
if (entry.isDirectory())
|
|
61
|
+
await collect(file);
|
|
62
|
+
else
|
|
63
|
+
put(`analytics/${path.relative(temporary, file).split(path.sep).join('/')}`, await readFile(file));
|
|
64
|
+
}
|
|
65
|
+
};
|
|
66
|
+
await collect(temporary);
|
|
67
|
+
mcp.analytics = { ...mcp.analytics, module: `analytics/lib/${path.basename(analyticsModule)}` };
|
|
68
|
+
}
|
|
69
|
+
finally {
|
|
70
|
+
await rm(temporary, { recursive: true, force: true });
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
const origin = config.site.origin ? new URL(config.site.origin).origin : undefined;
|
|
74
|
+
const runtime = { schemaVersion: 1, ...mcp, path: endpoint, dataDirectory: mcpDataPath.slice(1), allowedHosts: [...new Set([...mcp.allowedHosts, ...(origin ? [new URL(origin).hostname] : [])])], allowedOrigins: [...new Set([...mcp.allowedOrigins, ...(origin ? [origin] : [])])], inventory, corpusDigest: fingerprint(JSON.stringify(inventory)), buildId: '' };
|
|
75
|
+
artifacts.set(mcpRuntimePath, JSON.stringify(runtime));
|
|
76
|
+
// These are internal runtime files, not browser discovery artifacts.
|
|
77
|
+
headers[mcpRuntimePath] = { 'X-Robots-Tag': 'noindex' };
|
|
78
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { type ServerContext } from '@modelcontextprotocol/server';
|
|
2
|
+
export type McpClientMetadata = {
|
|
3
|
+
client?: {
|
|
4
|
+
name: string;
|
|
5
|
+
version?: string;
|
|
6
|
+
source: 'client_metadata' | 'user_agent' | 'vendor_header' | 'client_marker';
|
|
7
|
+
verified: false;
|
|
8
|
+
};
|
|
9
|
+
model?: {
|
|
10
|
+
name: string;
|
|
11
|
+
source: 'client_metadata';
|
|
12
|
+
verified: false;
|
|
13
|
+
};
|
|
14
|
+
};
|
|
15
|
+
export declare function normalizeMcpClient(name: unknown, clientVersion?: unknown): McpClientMetadata['client'];
|
|
16
|
+
export declare function safeMcpModelName(value: unknown): string | undefined;
|
|
17
|
+
/** Only bounded labels leave this function. No raw headers, full metadata, or session cache. */
|
|
18
|
+
export declare function mcpClientMetadata(context: ServerContext, legacyClient?: unknown): McpClientMetadata;
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
import { CLIENT_INFO_META_KEY } from '@modelcontextprotocol/server';
|
|
2
|
+
const record = (value) => value !== null && typeof value === 'object' && !Array.isArray(value) ? value : undefined;
|
|
3
|
+
const clientNames = [
|
|
4
|
+
[/^(?:codex|openai-codex|codex-cli|codex-mcp-client)$/i, 'codex'],
|
|
5
|
+
[/^(?:claude-code|claude_code|claude code)$/i, 'claude-code'],
|
|
6
|
+
[/^(?:claude-desktop|claude desktop)$/i, 'claude-desktop'],
|
|
7
|
+
[/^cursor$/i, 'cursor'], [/^(?:vscode|visual studio code)$/i, 'vscode'],
|
|
8
|
+
[/^windsurf$/i, 'windsurf'], [/^cline$/i, 'cline'], [/^roo-code$/i, 'roo-code'],
|
|
9
|
+
[/^gemini-cli$/i, 'gemini-cli'], [/^opencode$/i, 'opencode'],
|
|
10
|
+
];
|
|
11
|
+
const knownClient = (value) => typeof value === 'string' && value.length <= 64 ? clientNames.find(([pattern]) => pattern.test(value))?.[1] : undefined;
|
|
12
|
+
const version = (value) => typeof value === 'string' && /^\d{1,4}(?:\.\d{1,6}){0,3}(?:-(?:alpha|beta|rc|dev|canary)(?:[.-]?\d{1,6})?)?$/.test(value) && value.length <= 32 ? value : undefined;
|
|
13
|
+
export function normalizeMcpClient(name, clientVersion) {
|
|
14
|
+
const normalized = knownClient(name);
|
|
15
|
+
return normalized ? { name: normalized, ...(version(clientVersion) ? { version: version(clientVersion) } : {}), source: 'client_metadata', verified: false } : undefined;
|
|
16
|
+
}
|
|
17
|
+
// Deliberately finite: a family prefix is not enough to exclude private labels.
|
|
18
|
+
// Extend this registry when supporting additional public model labels.
|
|
19
|
+
const modelNames = new Set([
|
|
20
|
+
'gpt-4o', 'gpt-4o-mini', 'gpt-4.1', 'gpt-4.1-mini', 'gpt-4.1-nano',
|
|
21
|
+
'gpt-5', 'gpt-5-mini', 'gpt-5-nano', 'gpt-5-codex', 'gpt-5.1', 'gpt-5.1-codex',
|
|
22
|
+
'gpt-5.2', 'gpt-5.2-codex', 'gpt-5.3-codex', 'gpt-5.4', 'gpt-6', 'gpt-6.1',
|
|
23
|
+
'o1', 'o3', 'o3-mini', 'o4-mini',
|
|
24
|
+
'claude-sonnet-4', 'claude-sonnet-4-5', 'claude-sonnet-4-6',
|
|
25
|
+
'claude-opus-4', 'claude-opus-4-1', 'claude-opus-4-5', 'claude-opus-4-6', 'claude-haiku-4-5',
|
|
26
|
+
'gemini-2.0-flash', 'gemini-2.0-flash-lite', 'gemini-2.5-pro', 'gemini-2.5-flash', 'gemini-2.5-flash-lite',
|
|
27
|
+
'gemini-3-pro', 'gemini-3-flash', 'gemini-3-pro-preview', 'gemini-3-flash-preview',
|
|
28
|
+
'deepseek-chat', 'deepseek-reasoner', 'deepseek-v3', 'deepseek-v3.1', 'deepseek-v3.2',
|
|
29
|
+
'deepseek-r1', 'deepseek-v4-flash', 'deepseek-v4-pro', 'deepseek-v4.1-flash',
|
|
30
|
+
'mistral-large', 'mistral-small', 'codestral', 'grok-3', 'grok-3-mini', 'grok-4',
|
|
31
|
+
'command-r', 'command-r-plus', 'command-a',
|
|
32
|
+
]);
|
|
33
|
+
export function safeMcpModelName(value) {
|
|
34
|
+
if (typeof value !== 'string' || value.length > 96)
|
|
35
|
+
return;
|
|
36
|
+
const normalized = value.toLowerCase().replace(/^(?:openai|anthropic|google|meta|mistral|xai|cohere|deepseek)\//, '');
|
|
37
|
+
return modelNames.has(normalized) ? normalized : undefined;
|
|
38
|
+
}
|
|
39
|
+
/** Only bounded labels leave this function. No raw headers, full metadata, or session cache. */
|
|
40
|
+
export function mcpClientMetadata(context, legacyClient) {
|
|
41
|
+
const result = {};
|
|
42
|
+
const info = record(record(context.mcpReq.envelope)?.[CLIENT_INFO_META_KEY]) ?? record(legacyClient);
|
|
43
|
+
const name = knownClient(info?.name);
|
|
44
|
+
if (name)
|
|
45
|
+
result.client = { name, ...(version(info?.version) ? { version: version(info?.version) } : {}), source: 'client_metadata', verified: false };
|
|
46
|
+
const headers = context.http?.req?.headers;
|
|
47
|
+
if (!result.client && headers) {
|
|
48
|
+
const vendor = headers.get('x-anthropic-client');
|
|
49
|
+
if (vendor && vendor.length <= 128 && /^(?:claude-code|claude_code)(?:\/\d[\w.-]*)?$/i.test(vendor))
|
|
50
|
+
result.client = { name: 'claude-code', source: 'vendor_header', verified: false };
|
|
51
|
+
const agent = headers.get('user-agent');
|
|
52
|
+
if (!result.client && agent && agent.length <= 512) {
|
|
53
|
+
// Recognize product tokens; discard the original header, including any paths or device details.
|
|
54
|
+
const token = agent.match(/(?:^|[\s;(])((?:codex|codex-cli|claude-code|cursor|vscode|windsurf|cline|roo-code|gemini-cli|opencode))\/\d[\w.-]*(?=$|[\s;)])/i)?.[1];
|
|
55
|
+
const normalized = knownClient(token);
|
|
56
|
+
if (normalized)
|
|
57
|
+
result.client = { name: normalized, source: 'user_agent', verified: false };
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
// Presence identifies a claimed client only. Never retain or hash its session ID.
|
|
61
|
+
const openCodeSession = context.mcpReq._meta?.['ai.opencode/sessionID'];
|
|
62
|
+
if (!result.client && typeof openCodeSession === 'string' && /^ses_[a-zA-Z0-9]{1,128}$/.test(openCodeSession))
|
|
63
|
+
result.client = { name: 'opencode', source: 'client_marker', verified: false };
|
|
64
|
+
const turn = record(context.mcpReq._meta?.['x-codex-turn-metadata']);
|
|
65
|
+
const model = safeMcpModelName(turn?.model);
|
|
66
|
+
if (model)
|
|
67
|
+
result.model = { name: model, source: 'client_metadata', verified: false };
|
|
68
|
+
return result;
|
|
69
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
export type McpConfig = {
|
|
2
|
+
enabled: true;
|
|
3
|
+
access: 'public';
|
|
4
|
+
path: string;
|
|
5
|
+
publication: {
|
|
6
|
+
channel: string;
|
|
7
|
+
version: string;
|
|
8
|
+
language: string;
|
|
9
|
+
};
|
|
10
|
+
allowedHosts: string[];
|
|
11
|
+
allowedOrigins: string[];
|
|
12
|
+
analytics?: {
|
|
13
|
+
module: string;
|
|
14
|
+
clientMetadata?: boolean;
|
|
15
|
+
intent?: boolean;
|
|
16
|
+
conversationIds?: boolean;
|
|
17
|
+
consent?: {
|
|
18
|
+
header: string;
|
|
19
|
+
value: string;
|
|
20
|
+
};
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
|
+
export declare function resolveMcp(value: unknown): McpConfig | undefined;
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { configMappingAt } from './compiler-config.js';
|
|
2
|
+
export function resolveMcp(value) {
|
|
3
|
+
if (value === undefined || value === false)
|
|
4
|
+
return;
|
|
5
|
+
const config = configMappingAt(value, 'mcp');
|
|
6
|
+
if (Object.keys(config).some(key => !['enabled', 'access', 'path', 'publication', 'allowedHosts', 'allowedOrigins', 'analytics'].includes(key)))
|
|
7
|
+
throw new Error('Unknown mcp setting');
|
|
8
|
+
if (typeof config.enabled !== 'boolean')
|
|
9
|
+
throw new Error('mcp.enabled must be a boolean');
|
|
10
|
+
if (!config.enabled)
|
|
11
|
+
return;
|
|
12
|
+
if (config.access !== 'public')
|
|
13
|
+
throw new Error('mcp.access must explicitly be public');
|
|
14
|
+
const route = config.path ?? '/mcp';
|
|
15
|
+
if (typeof route !== 'string' || !/^\/[a-zA-Z0-9_-]+(?:\/[a-zA-Z0-9_-]+)*$/.test(route) || route.startsWith('/__shoalrun'))
|
|
16
|
+
throw new Error('mcp.path must be a non-reserved absolute path without a trailing slash');
|
|
17
|
+
const publication = configMappingAt(config.publication, 'mcp.publication');
|
|
18
|
+
if (Object.keys(publication).some(key => !['channel', 'version', 'language'].includes(key)) || ['channel', 'version', 'language'].some(key => typeof publication[key] !== 'string' || !/^[a-zA-Z0-9._-]{1,128}$/.test(publication[key])))
|
|
19
|
+
throw new Error('mcp.publication needs channel, version, and language');
|
|
20
|
+
const strings = (key) => {
|
|
21
|
+
const values = config[key] ?? [];
|
|
22
|
+
if (!Array.isArray(values) || values.length > 32 || values.some(v => typeof v !== 'string' || !v || v.length > 253))
|
|
23
|
+
throw new Error(`mcp.${key} must be an array of explicit hostnames or origins`);
|
|
24
|
+
return values;
|
|
25
|
+
};
|
|
26
|
+
const allowedHosts = strings('allowedHosts');
|
|
27
|
+
if (allowedHosts.some(host => !/^(?:[a-zA-Z0-9-]+\.)*[a-zA-Z0-9-]+$/.test(host)))
|
|
28
|
+
throw new Error('mcp.allowedHosts accepts hostnames without wildcards, schemes, or ports');
|
|
29
|
+
const allowedOrigins = strings('allowedOrigins');
|
|
30
|
+
if (allowedOrigins.some(origin => { try {
|
|
31
|
+
const url = new URL(origin);
|
|
32
|
+
return url.origin !== origin || !['https:', 'http:'].includes(url.protocol);
|
|
33
|
+
}
|
|
34
|
+
catch {
|
|
35
|
+
return true;
|
|
36
|
+
} }))
|
|
37
|
+
throw new Error('mcp.allowedOrigins accepts exact HTTP(S) origins');
|
|
38
|
+
let analytics;
|
|
39
|
+
if (config.analytics !== undefined && config.analytics !== false) {
|
|
40
|
+
const value = configMappingAt(config.analytics, 'mcp.analytics');
|
|
41
|
+
if (Object.keys(value).some(key => !['module', 'clientMetadata', 'intent', 'conversationIds', 'consent'].includes(key)) || typeof value.module !== 'string' || !value.module.trim() || !/\.m?js$/i.test(value.module) || /^[a-z][a-z0-9+.-]*:/i.test(value.module))
|
|
42
|
+
throw new Error('mcp.analytics.module must name a local .js or .mjs server module');
|
|
43
|
+
for (const key of ['clientMetadata', 'intent', 'conversationIds'])
|
|
44
|
+
if (value[key] !== undefined && typeof value[key] !== 'boolean')
|
|
45
|
+
throw new Error(`mcp.analytics.${key} must be a boolean`);
|
|
46
|
+
let consent;
|
|
47
|
+
if (value.consent !== undefined && value.consent !== false) {
|
|
48
|
+
const policy = configMappingAt(value.consent, 'mcp.analytics.consent');
|
|
49
|
+
if (Object.keys(policy).some(key => !['header', 'value'].includes(key)) || typeof policy.header !== 'string' || !/^x-[a-z0-9-]{1,60}$/.test(policy.header) || /^(x-forwarded-|x-vercel-|x-mcp-)/.test(policy.header) || typeof policy.value !== 'string' || !/^[a-zA-Z0-9._-]{1,64}$/.test(policy.value))
|
|
50
|
+
throw new Error('mcp.analytics.consent needs a custom lowercase x- header and a short policy value');
|
|
51
|
+
consent = { header: policy.header, value: policy.value };
|
|
52
|
+
}
|
|
53
|
+
analytics = { module: value.module, ...(consent ? { consent } : {}), ...(value.clientMetadata === true ? { clientMetadata: true } : {}), ...(value.intent === true ? { intent: true } : {}), ...(value.conversationIds === true ? { conversationIds: true } : {}) };
|
|
54
|
+
}
|
|
55
|
+
return { ...(analytics ? { analytics } : {}), enabled: true, access: 'public', path: route, publication: publication, allowedHosts: allowedHosts.map(host => host.toLowerCase()), allowedOrigins };
|
|
56
|
+
}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { type McpConfig } from './mcp-config.js';
|
|
2
|
+
export declare const mcpRequestLimit = 65536;
|
|
3
|
+
export type McpRuntime = McpConfig & {
|
|
4
|
+
schemaVersion: 1;
|
|
5
|
+
dataDirectory: string;
|
|
6
|
+
inventory: Record<string, string>;
|
|
7
|
+
corpusDigest: string;
|
|
8
|
+
buildId: string;
|
|
9
|
+
};
|
|
10
|
+
export declare function loadMcpRuntime(directory: string): Promise<{
|
|
11
|
+
runtime: McpRuntime;
|
|
12
|
+
directory: string;
|
|
13
|
+
} | undefined>;
|
|
14
|
+
export declare function createMcpHttpHandler(input: {
|
|
15
|
+
runtime: McpRuntime;
|
|
16
|
+
directory: string;
|
|
17
|
+
}): (request: Request, options?: {
|
|
18
|
+
local?: boolean;
|
|
19
|
+
}) => Promise<Response>;
|
package/dist/mcp-http.js
ADDED
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
import { mcpClientMetadata, safeMcpModelName, normalizeMcpClient } from './mcp-client-metadata.js';
|
|
2
|
+
import { attemptAnalytics, mcpAnalyticsLoader } from './mcp-analytics.js';
|
|
3
|
+
import { readFile, realpath } from 'node:fs/promises';
|
|
4
|
+
import path from 'node:path';
|
|
5
|
+
import { fingerprint, mcpDataPath, mcpRuntimePath } from './mcp-integrity.js';
|
|
6
|
+
import { resolveMcp } from './mcp-config.js';
|
|
7
|
+
export const mcpRequestLimit = 65_536;
|
|
8
|
+
const hex = (v) => typeof v === 'string' && /^[a-f0-9]{64}$/.test(v);
|
|
9
|
+
const fail = (status, message) => new Response(JSON.stringify({ error: message }), { status, headers: { 'Content-Type': 'application/json', 'Cache-Control': 'no-store', ...(status === 429 ? { 'Retry-After': '1' } : {}) } });
|
|
10
|
+
export async function loadMcpRuntime(directory) {
|
|
11
|
+
let raw;
|
|
12
|
+
try {
|
|
13
|
+
raw = await readFile(path.join(directory, mcpRuntimePath), 'utf8');
|
|
14
|
+
}
|
|
15
|
+
catch (error) {
|
|
16
|
+
if (error.code === 'ENOENT')
|
|
17
|
+
return;
|
|
18
|
+
throw error;
|
|
19
|
+
}
|
|
20
|
+
const runtime = JSON.parse(raw);
|
|
21
|
+
if (runtime.schemaVersion !== 1 || runtime.access !== 'public' || runtime.enabled !== true || runtime.dataDirectory !== mcpDataPath.slice(1) || !hex(runtime.buildId) || !hex(runtime.corpusDigest) || !runtime.inventory || Array.isArray(runtime.inventory) || fingerprint(JSON.stringify(runtime.inventory)) !== runtime.corpusDigest || !runtime.publication || ['channel', 'version', 'language'].some(key => typeof runtime.publication[key] !== 'string') || !Array.isArray(runtime.allowedHosts) || !Array.isArray(runtime.allowedOrigins) || typeof runtime.path !== 'string' || !/^\/[a-zA-Z0-9_/-]+$/.test(runtime.path))
|
|
22
|
+
throw new Error('Invalid MCP runtime metadata; rebuild the public site');
|
|
23
|
+
if (runtime.analytics?.consent)
|
|
24
|
+
resolveMcp({ enabled: true, access: 'public', publication: runtime.publication, analytics: { ...runtime.analytics, module: './adapter.mjs' } });
|
|
25
|
+
const build = JSON.parse(await readFile(path.join(directory, 'build-info.json'), 'utf8'));
|
|
26
|
+
if (build.buildId !== runtime.buildId)
|
|
27
|
+
throw new Error('MCP corpus and public site build identities differ');
|
|
28
|
+
const siteRoot = await realpath(directory);
|
|
29
|
+
const root = await realpath(path.join(directory, runtime.dataDirectory));
|
|
30
|
+
if (!root.startsWith(`${siteRoot}${path.sep}`))
|
|
31
|
+
throw new Error('MCP corpus escapes the built site');
|
|
32
|
+
for (const [file, digest] of Object.entries(runtime.inventory)) {
|
|
33
|
+
if (!file || file.startsWith('/') || file.includes('\\') || file.split('/').some(part => !part || part === '.' || part === '..') || !hex(digest))
|
|
34
|
+
throw new Error('Invalid MCP inventory path');
|
|
35
|
+
const resolved = await realpath(path.join(root, file));
|
|
36
|
+
if (!resolved.startsWith(`${root}${path.sep}`) || fingerprint(await readFile(resolved)) !== digest)
|
|
37
|
+
throw new Error(`MCP corpus resource mismatch: ${file}`);
|
|
38
|
+
}
|
|
39
|
+
if (runtime.analytics && (typeof runtime.analytics.module !== 'string' || !runtime.analytics.module.startsWith('analytics/lib/') || !runtime.inventory[runtime.analytics.module] || runtime.analytics.clientMetadata !== undefined && typeof runtime.analytics.clientMetadata !== 'boolean' || ['intent', 'conversationIds'].some(key => runtime.analytics[key] !== undefined && typeof runtime.analytics[key] !== 'boolean')))
|
|
40
|
+
throw new Error('Invalid MCP analytics module inventory');
|
|
41
|
+
if (!runtime.inventory['documents.json'] || !runtime.inventory['search-index.json'])
|
|
42
|
+
throw new Error('MCP corpus is missing its indexes');
|
|
43
|
+
return { runtime, directory: root };
|
|
44
|
+
}
|
|
45
|
+
export function createMcpHttpHandler(input) {
|
|
46
|
+
let active = 0;
|
|
47
|
+
let publicDocuments;
|
|
48
|
+
const resource = async (id, section) => {
|
|
49
|
+
if (typeof id !== 'string')
|
|
50
|
+
return {};
|
|
51
|
+
publicDocuments ??= readFile(path.join(input.directory, 'documents.json'), 'utf8').then(text => JSON.parse(text).documents);
|
|
52
|
+
const page = (await publicDocuments).find(page => page.id === id);
|
|
53
|
+
return page ? { pageId: page.id, ...(typeof section === 'string' && page.sections?.some(item => item.id === section) ? { sectionId: section } : {}) } : {};
|
|
54
|
+
};
|
|
55
|
+
const loadAnalytics = mcpAnalyticsLoader(input.directory, input.runtime.analytics?.module);
|
|
56
|
+
return async (request, options = {}) => {
|
|
57
|
+
const { runtime } = input;
|
|
58
|
+
const url = new URL(request.url);
|
|
59
|
+
const host = url.hostname.toLowerCase();
|
|
60
|
+
const loopback = options.local === true && ['localhost', '127.0.0.1', '[::1]'].includes(host);
|
|
61
|
+
if (!loopback && !runtime.allowedHosts.includes(host))
|
|
62
|
+
return fail(403, 'MCP Host is not allowed');
|
|
63
|
+
const origin = request.headers.get('origin');
|
|
64
|
+
if (origin && !(runtime.allowedOrigins.includes(origin) || loopback && origin === url.origin))
|
|
65
|
+
return fail(403, 'MCP Origin is not allowed');
|
|
66
|
+
const cors = origin ? { 'Access-Control-Allow-Origin': origin, Vary: 'Origin', 'Access-Control-Expose-Headers': 'MCP-Protocol-Version, Mcp-Session-Id' } : {};
|
|
67
|
+
if (url.pathname !== runtime.path)
|
|
68
|
+
return fail(404, 'Unknown MCP endpoint');
|
|
69
|
+
if (request.method === 'OPTIONS')
|
|
70
|
+
return new Response(null, { status: 204, headers: { ...cors, 'Access-Control-Allow-Methods': 'POST, OPTIONS', 'Access-Control-Allow-Headers': ['Content-Type', 'Accept', 'MCP-Protocol-Version', 'MCP-Session-Id', ...(runtime.analytics?.consent ? [runtime.analytics.consent.header] : [])].join(', ') } });
|
|
71
|
+
if (request.method !== 'POST')
|
|
72
|
+
return new Response(null, { status: 405, headers: { ...cors, Allow: 'POST, OPTIONS' } });
|
|
73
|
+
if (active >= 8)
|
|
74
|
+
return fail(429, 'MCP request capacity exceeded');
|
|
75
|
+
active++;
|
|
76
|
+
let analytics;
|
|
77
|
+
let nativeCapture = false;
|
|
78
|
+
let server;
|
|
79
|
+
const controller = new AbortController();
|
|
80
|
+
const abort = () => controller.abort(request.signal.reason);
|
|
81
|
+
request.signal.addEventListener('abort', abort, { once: true });
|
|
82
|
+
if (request.signal.aborted)
|
|
83
|
+
abort();
|
|
84
|
+
const timeout = setTimeout(() => controller.abort(new Error('MCP request deadline exceeded')), 15_000);
|
|
85
|
+
let cleaned = false;
|
|
86
|
+
const cleanup = async () => {
|
|
87
|
+
if (cleaned)
|
|
88
|
+
return;
|
|
89
|
+
cleaned = true;
|
|
90
|
+
clearTimeout(timeout);
|
|
91
|
+
request.signal.removeEventListener('abort', abort);
|
|
92
|
+
active--;
|
|
93
|
+
await server?.close().catch(() => { });
|
|
94
|
+
if (analytics?.flush)
|
|
95
|
+
await attemptAnalytics(() => analytics.flush());
|
|
96
|
+
};
|
|
97
|
+
controller.signal.addEventListener('abort', () => { void cleanup(); }, { once: true });
|
|
98
|
+
try {
|
|
99
|
+
const [{ WebStandardStreamableHTTPServerTransport }, { createDocsMcpServer }] = await Promise.all([import('@modelcontextprotocol/server'), import('./docs-mcp.js')]);
|
|
100
|
+
const consent = runtime.analytics?.consent;
|
|
101
|
+
const permitted = !consent || request.headers.get(consent.header) === consent.value;
|
|
102
|
+
if (permitted)
|
|
103
|
+
await attemptAnalytics(async () => { analytics = await loadAnalytics(); });
|
|
104
|
+
server = createDocsMcpServer(input.directory, runtime.publication, analytics ? { clientMetadata: runtime.analytics?.clientMetadata === true, buildId: runtime.buildId, capture: event => nativeCapture ? undefined : analytics.capture(event) } : undefined, !!consent && !permitted);
|
|
105
|
+
if (analytics?.instrument)
|
|
106
|
+
await attemptAnalytics(async () => {
|
|
107
|
+
nativeCapture = await analytics.instrument(server, {
|
|
108
|
+
buildId: runtime.buildId, publication: runtime.publication,
|
|
109
|
+
clientMetadata: runtime.analytics?.clientMetadata === true,
|
|
110
|
+
intent: runtime.analytics?.intent === true, conversationIds: runtime.analytics?.conversationIds === true,
|
|
111
|
+
client: normalizeMcpClient, resource, modelName: safeMcpModelName,
|
|
112
|
+
metadata: context => runtime.analytics?.clientMetadata ? mcpClientMetadata(context, server.server.getClientVersion()) : {},
|
|
113
|
+
}) === true;
|
|
114
|
+
});
|
|
115
|
+
const transport = new WebStandardStreamableHTTPServerTransport({ sessionIdGenerator: undefined, enableJsonResponse: true, maxRequestBodySize: mcpRequestLimit });
|
|
116
|
+
await server.connect(transport);
|
|
117
|
+
const work = transport.handleRequest(new Request(request, { signal: controller.signal }));
|
|
118
|
+
const aborted = new Promise((_, reject) => {
|
|
119
|
+
if (controller.signal.aborted)
|
|
120
|
+
reject(controller.signal.reason);
|
|
121
|
+
else
|
|
122
|
+
controller.signal.addEventListener('abort', () => reject(controller.signal.reason), { once: true });
|
|
123
|
+
});
|
|
124
|
+
const response = await Promise.race([work, aborted]);
|
|
125
|
+
const headers = new Headers(response.headers);
|
|
126
|
+
headers.set('Cache-Control', 'no-store');
|
|
127
|
+
for (const [name, value] of Object.entries(cors))
|
|
128
|
+
headers.set(name, value);
|
|
129
|
+
// JSON responses are finite; close the protocol only after the body has been consumed.
|
|
130
|
+
if (!response.body) {
|
|
131
|
+
await cleanup();
|
|
132
|
+
return new Response(null, { status: response.status, headers });
|
|
133
|
+
}
|
|
134
|
+
const reader = response.body.getReader();
|
|
135
|
+
return new Response(new ReadableStream({
|
|
136
|
+
async pull(stream) { try {
|
|
137
|
+
const next = await reader.read();
|
|
138
|
+
if (next.done) {
|
|
139
|
+
await cleanup();
|
|
140
|
+
stream.close();
|
|
141
|
+
}
|
|
142
|
+
else
|
|
143
|
+
stream.enqueue(next.value);
|
|
144
|
+
}
|
|
145
|
+
catch (error) {
|
|
146
|
+
stream.error(error);
|
|
147
|
+
await cleanup();
|
|
148
|
+
} },
|
|
149
|
+
async cancel(reason) { controller.abort(reason); await reader.cancel(reason).catch(() => { }); await cleanup(); },
|
|
150
|
+
}), { status: response.status, headers });
|
|
151
|
+
}
|
|
152
|
+
catch {
|
|
153
|
+
await cleanup();
|
|
154
|
+
return fail(controller.signal.aborted ? 503 : 400, controller.signal.aborted ? 'MCP request cancelled or timed out' : 'Invalid MCP request');
|
|
155
|
+
}
|
|
156
|
+
};
|
|
157
|
+
}
|