@assistant-ui/mcp-docs-server 0.1.30 → 0.1.32
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/.docs/organized/code-examples/waterfall.md +8 -8
- package/.docs/organized/code-examples/with-a2a.md +10 -10
- package/.docs/organized/code-examples/with-ag-ui.md +12 -12
- package/.docs/organized/code-examples/with-ai-sdk-v6.md +14 -14
- package/.docs/organized/code-examples/with-artifacts.md +14 -14
- package/.docs/organized/code-examples/with-assistant-transport.md +11 -11
- package/.docs/organized/code-examples/with-browser-extension.md +345 -0
- package/.docs/organized/code-examples/with-chain-of-thought.md +129 -63
- package/.docs/organized/code-examples/with-cloud-standalone.md +13 -13
- package/.docs/organized/code-examples/with-cloud.md +13 -13
- package/.docs/organized/code-examples/with-custom-thread-list.md +65 -20
- package/.docs/organized/code-examples/with-elevenlabs-conversational.md +18 -17
- package/.docs/organized/code-examples/with-elevenlabs-scribe.md +18 -17
- package/.docs/organized/code-examples/with-expo.md +25 -25
- package/.docs/organized/code-examples/with-external-store.md +10 -10
- package/.docs/organized/code-examples/with-ffmpeg.md +14 -14
- package/.docs/organized/code-examples/with-generative-ui.md +211 -14
- package/.docs/organized/code-examples/with-google-adk.md +12 -12
- package/.docs/organized/code-examples/with-heat-graph.md +8 -8
- package/.docs/organized/code-examples/with-image-generation.md +454 -0
- package/.docs/organized/code-examples/with-interactables.md +14 -14
- package/.docs/organized/code-examples/with-langchain.md +12 -12
- package/.docs/organized/code-examples/with-langgraph.md +15 -12
- package/.docs/organized/code-examples/with-livekit.md +19 -18
- package/.docs/organized/code-examples/with-mcp.md +748 -0
- package/.docs/organized/code-examples/with-opencode.md +107 -62
- package/.docs/organized/code-examples/with-parent-id-grouping.md +12 -12
- package/.docs/organized/code-examples/with-react-hook-form.md +14 -14
- package/.docs/organized/code-examples/with-react-ink.md +4 -4
- package/.docs/organized/code-examples/with-react-router.md +16 -16
- package/.docs/organized/code-examples/with-resumable-stream.md +660 -0
- package/.docs/organized/code-examples/with-store.md +8 -8
- package/.docs/organized/code-examples/with-tanstack.md +14 -14
- package/.docs/organized/code-examples/with-tap-runtime.md +11 -10
- package/.docs/raw/docs/(docs)/cli.mdx +3 -1
- package/.docs/raw/docs/(docs)/copilots/assistant-frame.mdx +1 -0
- package/.docs/raw/docs/(docs)/copilots/make-assistant-tool-ui.mdx +10 -3
- package/.docs/raw/docs/(docs)/copilots/make-assistant-tool.mdx +8 -3
- package/.docs/raw/docs/(docs)/copilots/make-assistant-visible.mdx +1 -0
- package/.docs/raw/docs/(docs)/copilots/model-context.mdx +1 -0
- package/.docs/raw/docs/(docs)/copilots/motivation.mdx +1 -0
- package/.docs/raw/docs/(docs)/copilots/use-assistant-instructions.mdx +1 -0
- package/.docs/raw/docs/(docs)/devtools.mdx +1 -0
- package/.docs/raw/docs/(docs)/index.mdx +3 -2
- package/.docs/raw/docs/(docs)/installation.mdx +2 -1
- package/.docs/raw/docs/(docs)/rtl.mdx +1 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/attachments.mdx +36 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/feedback.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/index.mdx +34 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/model.mdx +44 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/persistence.mdx +55 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/runtime.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/adapters/suggestions.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/context-providers/assistant-runtime-provider.mdx +37 -8
- package/.docs/raw/docs/(reference)/api-reference/context-providers/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/context-providers/scoped-providers.mdx +64 -0
- package/.docs/raw/docs/(reference)/api-reference/external-store/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/external-store/message-conversion.mdx +52 -0
- package/.docs/raw/docs/(reference)/api-reference/external-store/runtime.mdx +36 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/composer-triggers.mdx +98 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/index.mdx +31 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/model-context.mdx +33 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/primitives.mdx +640 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/runtimes.mdx +28 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/state.mdx +94 -0
- package/.docs/raw/docs/(reference)/api-reference/hooks/utilities.mdx +464 -0
- package/.docs/raw/docs/(reference)/api-reference/integrations/cloud-ai-sdk.mdx +24 -0
- package/.docs/raw/docs/(reference)/api-reference/integrations/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-ai-sdk.mdx +79 -0
- package/.docs/raw/docs/(reference)/api-reference/model-context/context.mdx +52 -0
- package/.docs/raw/docs/(reference)/api-reference/model-context/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/model-context/registry.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/overview.mdx +125 -125
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar-more.mdx +78 -221
- package/.docs/raw/docs/(reference)/api-reference/primitives/action-bar.mdx +127 -242
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-if.mdx +46 -20
- package/.docs/raw/docs/(reference)/api-reference/primitives/assistant-modal.mdx +66 -87
- package/.docs/raw/docs/(reference)/api-reference/primitives/attachment.mdx +50 -58
- package/.docs/raw/docs/(reference)/api-reference/primitives/branch-picker.mdx +80 -48
- package/.docs/raw/docs/(reference)/api-reference/primitives/chain-of-thought.mdx +67 -0
- package/.docs/raw/docs/(reference)/api-reference/primitives/composer.mdx +323 -461
- package/.docs/raw/docs/(reference)/api-reference/primitives/error.mdx +36 -43
- package/.docs/raw/docs/(reference)/api-reference/primitives/index.mdx +70 -0
- package/.docs/raw/docs/(reference)/api-reference/primitives/message-part.mdx +63 -245
- package/.docs/raw/docs/(reference)/api-reference/primitives/message.mdx +182 -554
- package/.docs/raw/docs/(reference)/api-reference/primitives/queue-item.mdx +65 -0
- package/.docs/raw/docs/(reference)/api-reference/primitives/selection-toolbar.mdx +35 -22
- package/.docs/raw/docs/(reference)/api-reference/primitives/suggestion.mdx +57 -140
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item-more.mdx +70 -161
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list-item.mdx +84 -108
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread-list.mdx +82 -86
- package/.docs/raw/docs/(reference)/api-reference/primitives/thread.mdx +173 -314
- package/.docs/raw/docs/(reference)/api-reference/runtimes/assistant-runtime.mdx +9 -21
- package/.docs/raw/docs/(reference)/api-reference/runtimes/attachment-runtime.mdx +10 -21
- package/.docs/raw/docs/(reference)/api-reference/runtimes/composer-runtime.mdx +15 -70
- package/.docs/raw/docs/(reference)/api-reference/runtimes/index.mdx +43 -0
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-part-runtime.mdx +25 -28
- package/.docs/raw/docs/(reference)/api-reference/runtimes/message-runtime.mdx +11 -63
- package/.docs/raw/docs/(reference)/api-reference/runtimes/queue-state.mdx +20 -0
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-item-runtime.mdx +11 -48
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-list-runtime.mdx +10 -42
- package/.docs/raw/docs/(reference)/api-reference/runtimes/thread-runtime.mdx +18 -30
- package/.docs/raw/docs/(reference)/api-reference/tools/component-tools.mdx +68 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/index.mdx +39 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/rendering.mdx +79 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/status.mdx +42 -0
- package/.docs/raw/docs/(reference)/api-reference/tools/toolkits.mdx +92 -0
- package/.docs/raw/docs/(reference)/api-reference/transport/assistant-transport.mdx +48 -0
- package/.docs/raw/docs/(reference)/api-reference/transport/frame.mdx +62 -0
- package/.docs/raw/docs/(reference)/api-reference/transport/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/utilities/index.mdx +19 -0
- package/.docs/raw/docs/(reference)/api-reference/utilities/miscellaneous.mdx +131 -0
- package/.docs/raw/docs/(reference)/api-reference/voice/index.mdx +22 -0
- package/.docs/raw/docs/(reference)/api-reference/voice/session.mdx +54 -0
- package/.docs/raw/docs/(reference)/api-reference/voice/speech-dictation.mdx +36 -0
- package/.docs/raw/docs/cloud/ai-sdk-assistant-ui.mdx +230 -2
- package/.docs/raw/docs/cloud/ai-sdk.mdx +222 -4
- package/.docs/raw/docs/cloud/index.mdx +2 -2
- package/.docs/raw/docs/cloud/langgraph.mdx +274 -2
- package/.docs/raw/docs/{(docs)/guides → guides}/attachments.mdx +45 -40
- package/.docs/raw/docs/guides/branching.mdx +76 -0
- package/.docs/raw/docs/guides/chain-of-thought.mdx +166 -0
- package/.docs/raw/docs/{(docs)/guides → guides}/context-api.mdx +54 -26
- package/.docs/raw/docs/{(docs)/guides → guides}/dictation.mdx +3 -1
- package/.docs/raw/docs/guides/editing.mdx +102 -0
- package/.docs/raw/docs/guides/generative-ui.mdx +142 -0
- package/.docs/raw/docs/guides/image-generation.mdx +74 -0
- package/.docs/raw/docs/guides/index.mdx +103 -0
- package/.docs/raw/docs/{(docs)/guides → guides}/interactables.mdx +51 -2
- package/.docs/raw/docs/{(docs)/guides → guides}/latex.mdx +53 -10
- package/.docs/raw/docs/guides/mcp-apps.mdx +231 -0
- package/.docs/raw/docs/{(docs)/guides → guides}/mentions.mdx +63 -88
- package/.docs/raw/docs/{(docs)/guides → guides}/message-timing.mdx +45 -6
- package/.docs/raw/docs/{(docs)/guides → guides}/multi-agent.mdx +66 -6
- package/.docs/raw/docs/{(docs)/guides → guides}/quoting.mdx +11 -18
- package/.docs/raw/docs/guides/resumable-stream-deployment.mdx +212 -0
- package/.docs/raw/docs/guides/resumable-stream-stores.mdx +152 -0
- package/.docs/raw/docs/guides/resumable-streams.mdx +210 -0
- package/.docs/raw/docs/{(docs)/guides → guides}/slash-commands.mdx +104 -38
- package/.docs/raw/docs/guides/speech.mdx +156 -0
- package/.docs/raw/docs/{(docs)/guides → guides}/suggestions.mdx +91 -69
- package/.docs/raw/docs/{(docs)/guides → guides}/tool-ui.mdx +110 -38
- package/.docs/raw/docs/{(docs)/guides → guides}/tools.mdx +197 -40
- package/.docs/raw/docs/{(docs)/guides → guides}/voice.mdx +41 -2
- package/.docs/raw/docs/ink/adapters.mdx +37 -1
- package/.docs/raw/docs/ink/custom-backend.mdx +59 -8
- package/.docs/raw/docs/ink/index.mdx +11 -14
- package/.docs/raw/docs/ink/migration.mdx +1 -3
- package/.docs/raw/docs/ink/primitives.mdx +386 -9
- package/.docs/raw/docs/integrations/attachments/custom-adapter.mdx +520 -0
- package/.docs/raw/docs/integrations/auth/better-auth.mdx +191 -0
- package/.docs/raw/docs/integrations/auth/clerk.mdx +172 -0
- package/.docs/raw/docs/integrations/auth/next-auth.mdx +196 -0
- package/.docs/raw/docs/integrations/frameworks/ai-sdk.mdx +79 -0
- package/.docs/raw/docs/integrations/frameworks/cloudflare-agents/overview.mdx +282 -0
- package/.docs/raw/docs/integrations/frameworks/mastra/full-stack.mdx +188 -0
- package/.docs/raw/docs/integrations/frameworks/mastra/overview.mdx +57 -0
- package/.docs/raw/docs/integrations/frameworks/mastra/separate-server.mdx +201 -0
- package/.docs/raw/docs/integrations/gateways/index.mdx +162 -0
- package/.docs/raw/docs/integrations/index.mdx +185 -0
- package/.docs/raw/docs/integrations/observability/helicone.mdx +130 -0
- package/.docs/raw/docs/integrations/observability/langfuse.mdx +163 -0
- package/.docs/raw/docs/integrations/observability/langsmith.mdx +150 -0
- package/.docs/raw/docs/integrations/persistence/custom-adapter.mdx +712 -0
- package/.docs/raw/docs/integrations/tools/mcp.mdx +267 -0
- package/.docs/raw/docs/integrations/tools/react-mcp.mdx +337 -0
- package/.docs/raw/docs/migrations/v0-14.mdx +297 -0
- package/.docs/raw/docs/primitives/action-bar.mdx +1 -0
- package/.docs/raw/docs/primitives/assistant-modal.mdx +1 -0
- package/.docs/raw/docs/primitives/attachment.mdx +1 -0
- package/.docs/raw/docs/primitives/branch-picker.mdx +1 -0
- package/.docs/raw/docs/primitives/chain-of-thought.mdx +90 -85
- package/.docs/raw/docs/primitives/composer.mdx +55 -1
- package/.docs/raw/docs/primitives/error.mdx +1 -0
- package/.docs/raw/docs/primitives/index.mdx +4 -3
- package/.docs/raw/docs/primitives/message.mdx +68 -5
- package/.docs/raw/docs/primitives/selection-toolbar.mdx +1 -0
- package/.docs/raw/docs/primitives/suggestion.mdx +10 -0
- package/.docs/raw/docs/primitives/thread-list.mdx +39 -0
- package/.docs/raw/docs/primitives/thread.mdx +16 -13
- package/.docs/raw/docs/react-native/hooks.mdx +2 -2
- package/.docs/raw/docs/react-native/index.mdx +5 -7
- package/.docs/raw/docs/react-native/migration.mdx +1 -3
- package/.docs/raw/docs/runtimes/a2a/client-and-hooks.mdx +396 -0
- package/.docs/raw/docs/runtimes/a2a/overview.mdx +60 -0
- package/.docs/raw/docs/runtimes/a2a/quickstart.mdx +216 -0
- package/.docs/raw/docs/runtimes/ag-ui/overview.mdx +70 -0
- package/.docs/raw/docs/runtimes/ag-ui/quickstart.mdx +243 -0
- package/.docs/raw/docs/runtimes/ag-ui/runtime-options.mdx +154 -0
- package/.docs/raw/docs/runtimes/ai-sdk/overview.mdx +52 -0
- package/.docs/raw/docs/runtimes/ai-sdk/v4-legacy.mdx +73 -128
- package/.docs/raw/docs/runtimes/ai-sdk/v5-legacy.mdx +70 -64
- package/.docs/raw/docs/runtimes/ai-sdk/v6.mdx +337 -123
- package/.docs/raw/docs/runtimes/concepts/adapters.mdx +265 -0
- package/.docs/raw/docs/runtimes/concepts/architecture.mdx +125 -0
- package/.docs/raw/docs/runtimes/concepts/stability.mdx +67 -0
- package/.docs/raw/docs/runtimes/concepts/threads.mdx +428 -0
- package/.docs/raw/docs/runtimes/custom/assistant-transport.mdx +703 -0
- package/.docs/raw/docs/runtimes/custom/data-stream.mdx +348 -0
- package/.docs/raw/docs/runtimes/custom/external-store.mdx +261 -1236
- package/.docs/raw/docs/runtimes/custom/local-runtime.mdx +746 -0
- package/.docs/raw/docs/runtimes/custom/overview.mdx +71 -0
- package/.docs/raw/docs/runtimes/google-adk/api.mdx +256 -0
- package/.docs/raw/docs/runtimes/google-adk/hooks.mdx +717 -0
- package/.docs/raw/docs/runtimes/google-adk/overview.mdx +69 -0
- package/.docs/raw/docs/runtimes/google-adk/quickstart.mdx +229 -0
- package/.docs/raw/docs/runtimes/langchain.mdx +533 -0
- package/.docs/raw/docs/runtimes/langgraph/generative-ui.mdx +305 -0
- package/.docs/raw/docs/runtimes/langgraph/interrupts.mdx +104 -0
- package/.docs/raw/docs/runtimes/langgraph/overview.mdx +84 -0
- package/.docs/raw/docs/runtimes/langgraph/quickstart.mdx +496 -0
- package/.docs/raw/docs/runtimes/langgraph/streaming.mdx +127 -0
- package/.docs/raw/docs/runtimes/langgraph/threads.mdx +113 -0
- package/.docs/raw/docs/runtimes/langgraph/tutorial/introduction.mdx +3 -3
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-1.mdx +0 -23
- package/.docs/raw/docs/runtimes/langgraph/tutorial/part-2.mdx +1 -1
- package/.docs/raw/docs/runtimes/opencode/hooks.mdx +191 -0
- package/.docs/raw/docs/runtimes/opencode/overview.mdx +48 -0
- package/.docs/raw/docs/runtimes/opencode/quickstart.mdx +119 -0
- package/.docs/raw/docs/runtimes/pick-a-runtime.mdx +78 -203
- package/.docs/raw/docs/ui/accordion.mdx +1 -0
- package/.docs/raw/docs/ui/assistant-modal.mdx +1 -0
- package/.docs/raw/docs/ui/assistant-sidebar.mdx +1 -0
- package/.docs/raw/docs/ui/attachment.mdx +1 -0
- package/.docs/raw/docs/ui/badge.mdx +1 -0
- package/.docs/raw/docs/ui/composer-trigger-popover.mdx +12 -1
- package/.docs/raw/docs/ui/context-display.mdx +1 -0
- package/.docs/raw/docs/ui/diff-viewer.mdx +1 -0
- package/.docs/raw/docs/ui/directive-text.mdx +1 -0
- package/.docs/raw/docs/ui/file.mdx +1 -0
- package/.docs/raw/docs/ui/image.mdx +1 -0
- package/.docs/raw/docs/ui/markdown.mdx +2 -14
- package/.docs/raw/docs/ui/mcp-config.mdx +102 -0
- package/.docs/raw/docs/ui/mermaid.mdx +1 -0
- package/.docs/raw/docs/ui/message-timing.mdx +3 -2
- package/.docs/raw/docs/ui/model-selector.mdx +9 -8
- package/.docs/raw/docs/ui/part-grouping.mdx +325 -313
- package/.docs/raw/docs/ui/quote.mdx +1 -0
- package/.docs/raw/docs/ui/reasoning.mdx +66 -33
- package/.docs/raw/docs/ui/scrollbar.mdx +1 -0
- package/.docs/raw/docs/ui/select.mdx +1 -0
- package/.docs/raw/docs/ui/sources.mdx +18 -0
- package/.docs/raw/docs/ui/streamdown.mdx +35 -2
- package/.docs/raw/docs/ui/syntax-highlighting.mdx +1 -0
- package/.docs/raw/docs/ui/tabs.mdx +1 -0
- package/.docs/raw/docs/ui/thread-list.mdx +19 -2
- package/.docs/raw/docs/ui/thread.mdx +58 -3
- package/.docs/raw/docs/ui/tool-fallback.mdx +1 -0
- package/.docs/raw/docs/ui/tool-group.mdx +39 -11
- package/.docs/raw/docs/ui/voice.mdx +1 -0
- package/.docs/raw/docs/utilities/heat-graph.mdx +1 -0
- package/.docs/raw/docs/utilities/react-o11y.mdx +278 -0
- package/.docs/raw/docs/utilities/tw-shimmer.mdx +1 -0
- package/README.md +14 -72
- package/dist/constants.d.ts +12 -9
- package/dist/constants.d.ts.map +1 -1
- package/dist/constants.js +13 -9
- package/dist/constants.js.map +1 -1
- package/dist/index.d.ts +7 -3
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +25 -24
- package/dist/index.js.map +1 -1
- package/dist/prepare-docs/code-examples.d.ts +4 -1
- package/dist/prepare-docs/code-examples.d.ts.map +1 -1
- package/dist/prepare-docs/code-examples.js +109 -121
- package/dist/prepare-docs/code-examples.js.map +1 -1
- package/dist/prepare-docs/copy-raw.d.ts +4 -1
- package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
- package/dist/prepare-docs/copy-raw.js +45 -42
- package/dist/prepare-docs/copy-raw.js.map +1 -1
- package/dist/prepare-docs/prepare.d.ts +1 -2
- package/dist/prepare-docs/prepare.js +17 -17
- package/dist/prepare-docs/prepare.js.map +1 -1
- package/dist/stdio.d.ts +1 -3
- package/dist/stdio.js +6 -3
- package/dist/stdio.js.map +1 -1
- package/dist/tools/docs.d.ts +20 -15
- package/dist/tools/docs.d.ts.map +1 -1
- package/dist/tools/docs.js +140 -161
- package/dist/tools/docs.js.map +1 -1
- package/dist/tools/examples.d.ts +20 -15
- package/dist/tools/examples.d.ts.map +1 -1
- package/dist/tools/examples.js +74 -86
- package/dist/tools/examples.js.map +1 -1
- package/dist/tools/tests/test-setup.d.ts +5 -2
- package/dist/tools/tests/test-setup.d.ts.map +1 -1
- package/dist/tools/tests/test-setup.js +21 -28
- package/dist/tools/tests/test-setup.js.map +1 -1
- package/dist/utils/logger.d.ts +8 -5
- package/dist/utils/logger.d.ts.map +1 -1
- package/dist/utils/logger.js +17 -17
- package/dist/utils/logger.js.map +1 -1
- package/dist/utils/mcp-format.d.ts +8 -5
- package/dist/utils/mcp-format.d.ts.map +1 -1
- package/dist/utils/mcp-format.js +9 -9
- package/dist/utils/mcp-format.js.map +1 -1
- package/dist/utils/mdx.d.ts +8 -6
- package/dist/utils/mdx.d.ts.map +1 -1
- package/dist/utils/mdx.js +22 -22
- package/dist/utils/mdx.js.map +1 -1
- package/dist/utils/paths.d.ts +9 -6
- package/dist/utils/paths.d.ts.map +1 -1
- package/dist/utils/paths.js +66 -76
- package/dist/utils/paths.js.map +1 -1
- package/dist/utils/security.d.ts +4 -1
- package/dist/utils/security.d.ts.map +1 -1
- package/dist/utils/security.js +19 -40
- package/dist/utils/security.js.map +1 -1
- package/package.json +6 -6
- package/src/tools/tests/path-traversal.test.ts +1 -1
- package/.docs/raw/docs/(docs)/guides/branching.mdx +0 -65
- package/.docs/raw/docs/(docs)/guides/chain-of-thought.mdx +0 -164
- package/.docs/raw/docs/(docs)/guides/editing.mdx +0 -66
- package/.docs/raw/docs/(docs)/guides/speech.mdx +0 -38
- package/.docs/raw/docs/(reference)/api-reference/context-providers/text-message-part-provider.mdx +0 -40
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-data-stream.mdx +0 -260
- package/.docs/raw/docs/(reference)/api-reference/integrations/react-hook-form.mdx +0 -103
- package/.docs/raw/docs/(reference)/api-reference/integrations/vercel-ai-sdk.mdx +0 -254
- package/.docs/raw/docs/(reference)/migrations/v0-14.mdx +0 -159
- package/.docs/raw/docs/runtimes/a2a/index.mdx +0 -298
- package/.docs/raw/docs/runtimes/assistant-transport.mdx +0 -1033
- package/.docs/raw/docs/runtimes/custom/custom-thread-list.mdx +0 -314
- package/.docs/raw/docs/runtimes/custom/local.mdx +0 -1464
- package/.docs/raw/docs/runtimes/data-stream.mdx +0 -422
- package/.docs/raw/docs/runtimes/google-adk/index.mdx +0 -686
- package/.docs/raw/docs/runtimes/helicone.mdx +0 -61
- package/.docs/raw/docs/runtimes/langchain/comparison.mdx +0 -60
- package/.docs/raw/docs/runtimes/langchain/index.mdx +0 -210
- package/.docs/raw/docs/runtimes/langgraph/index.mdx +0 -699
- package/.docs/raw/docs/runtimes/langgraph/tutorial/index.mdx +0 -12
- package/.docs/raw/docs/runtimes/langserve.mdx +0 -116
- package/.docs/raw/docs/runtimes/mastra/full-stack-integration.mdx +0 -218
- package/.docs/raw/docs/runtimes/mastra/overview.mdx +0 -18
- package/.docs/raw/docs/runtimes/mastra/separate-server-integration.mdx +0 -217
- package/dist/prepare-docs/prepare.d.ts.map +0 -1
- package/dist/stdio.d.ts.map +0 -1
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/deprecation-policy.mdx +0 -0
- /package/.docs/raw/docs/{(reference) → migrations}/react-compatibility.mdx +0 -0
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/react-langgraph-v0-7.mdx +0 -0
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-11.mdx +0 -0
- /package/.docs/raw/docs/{(reference)/migrations → migrations}/v0-12.mdx +0 -0
|
@@ -0,0 +1,278 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: react-o11y
|
|
3
|
+
description: Headless primitives for visualizing observability spans (traces, waterfalls).
|
|
4
|
+
platforms: ["react"]
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
<Callout type="warn">
|
|
8
|
+
`@assistant-ui/react-o11y` is currently v0.0.11 and experimental. The API may change without notice.
|
|
9
|
+
</Callout>
|
|
10
|
+
|
|
11
|
+
`@assistant-ui/react-o11y` provides headless, Radix-style primitives for rendering observability spans as collapsible, indented hierarchical UIs. Use it to build trace inspectors, waterfall debug panels, or LLM call timelines on top of your own span data source.
|
|
12
|
+
|
|
13
|
+
- **Headless** — Zero styling opinions, bring your own CSS / Tailwind.
|
|
14
|
+
- **Composable** — Radix-style primitive parts you fully control.
|
|
15
|
+
- **Tree-aware** — Automatic depth, parent / child collapse, time range computation.
|
|
16
|
+
- **Tap-powered** — Built on the same `@assistant-ui/tap` reactive primitives as the runtimes.
|
|
17
|
+
|
|
18
|
+
## Installation
|
|
19
|
+
|
|
20
|
+
<InstallCommand npm={["@assistant-ui/react-o11y"]} />
|
|
21
|
+
|
|
22
|
+
## Quick start
|
|
23
|
+
|
|
24
|
+
Mount `SpanResource` with your span data, then render primitives that read from the resource's state:
|
|
25
|
+
|
|
26
|
+
```tsx title="components/trace-view.tsx"
|
|
27
|
+
"use client";
|
|
28
|
+
|
|
29
|
+
import {
|
|
30
|
+
SpanPrimitive,
|
|
31
|
+
SpanResource,
|
|
32
|
+
type SpanData,
|
|
33
|
+
} from "@assistant-ui/react-o11y";
|
|
34
|
+
import { useAui, AuiProvider } from "@assistant-ui/store";
|
|
35
|
+
|
|
36
|
+
function SpanRow() {
|
|
37
|
+
return (
|
|
38
|
+
<SpanPrimitive.Root className="flex items-center gap-2 py-1">
|
|
39
|
+
<SpanPrimitive.Indent />
|
|
40
|
+
<SpanPrimitive.CollapseToggle className="size-4 cursor-pointer">
|
|
41
|
+
▸
|
|
42
|
+
</SpanPrimitive.CollapseToggle>
|
|
43
|
+
<SpanPrimitive.StatusIndicator className="size-2 rounded-full data-[span-status=running]:bg-yellow-500 data-[span-status=completed]:bg-green-500 data-[span-status=failed]:bg-red-500" />
|
|
44
|
+
<SpanPrimitive.TypeBadge className="rounded bg-muted px-1.5 text-xs" />
|
|
45
|
+
<SpanPrimitive.Name className="text-sm" />
|
|
46
|
+
<SpanPrimitive.Children components={{ Span: SpanRow }} />
|
|
47
|
+
</SpanPrimitive.Root>
|
|
48
|
+
);
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
export function TraceView({ spans }: { spans: SpanData[] }) {
|
|
52
|
+
const aui = useAui({ resource: SpanResource({ spans }) });
|
|
53
|
+
|
|
54
|
+
return (
|
|
55
|
+
<AuiProvider value={aui}>
|
|
56
|
+
<SpanPrimitive.Children components={{ Span: SpanRow }} />
|
|
57
|
+
</AuiProvider>
|
|
58
|
+
);
|
|
59
|
+
}
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
`SpanData` is the input shape your code produces (see [SpanData](#spandata)). `SpanResource` enriches it with depth, child counts, time range, and collapse state.
|
|
63
|
+
|
|
64
|
+
## Anatomy
|
|
65
|
+
|
|
66
|
+
```tsx
|
|
67
|
+
import {
|
|
68
|
+
SpanPrimitive,
|
|
69
|
+
SpanResource,
|
|
70
|
+
SpanByIndexProvider,
|
|
71
|
+
} from "@assistant-ui/react-o11y";
|
|
72
|
+
|
|
73
|
+
// Top-level: mount SpanResource via useAui
|
|
74
|
+
const aui = useAui({ resource: SpanResource({ spans }) });
|
|
75
|
+
|
|
76
|
+
<AuiProvider value={aui}>
|
|
77
|
+
{/* Render visible spans (flat-list output respecting collapsed state) */}
|
|
78
|
+
<SpanPrimitive.Children components={{ Span: SpanRow }} />
|
|
79
|
+
</AuiProvider>;
|
|
80
|
+
|
|
81
|
+
// Each <SpanRow /> sits inside its own SpanByIndexProvider context and reads via primitives
|
|
82
|
+
function SpanRow() {
|
|
83
|
+
return (
|
|
84
|
+
<SpanPrimitive.Root>
|
|
85
|
+
<SpanPrimitive.Indent />
|
|
86
|
+
<SpanPrimitive.CollapseToggle />
|
|
87
|
+
<SpanPrimitive.StatusIndicator />
|
|
88
|
+
<SpanPrimitive.TypeBadge />
|
|
89
|
+
<SpanPrimitive.Name />
|
|
90
|
+
</SpanPrimitive.Root>
|
|
91
|
+
);
|
|
92
|
+
}
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
`SpanPrimitive.Children` produces a flat list of visible spans (collapsed subtrees are excluded). Each rendered child is wrapped in a `SpanByIndexProvider` so its primitives resolve to that specific span's state.
|
|
96
|
+
|
|
97
|
+
## API reference
|
|
98
|
+
|
|
99
|
+
### SpanResource
|
|
100
|
+
|
|
101
|
+
Tap resource that ingests raw span data and exposes a tree-aware reactive state to primitives.
|
|
102
|
+
|
|
103
|
+
```ts
|
|
104
|
+
SpanResource({ spans }: { spans: SpanData[] }): ClientOutput<"span">;
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
Mount through `useAui({ resource: SpanResource({ spans }) })`.
|
|
108
|
+
|
|
109
|
+
The resource computes:
|
|
110
|
+
|
|
111
|
+
- **depth** of each span based on parent chain.
|
|
112
|
+
- **hasChildren** flag.
|
|
113
|
+
- **timeRange** (`min` / `max` across all spans).
|
|
114
|
+
- **collapse state** managed internally; toggles through primitives.
|
|
115
|
+
|
|
116
|
+
### SpanData
|
|
117
|
+
|
|
118
|
+
Input shape you provide to `SpanResource`:
|
|
119
|
+
|
|
120
|
+
| Field | Type | Description |
|
|
121
|
+
| --- | --- | --- |
|
|
122
|
+
| `id` | `string` | Unique span identifier. |
|
|
123
|
+
| `parentSpanId` | `string \| null` | Parent span id, or `null` for root spans. |
|
|
124
|
+
| `name` | `string` | Display name. |
|
|
125
|
+
| `type` | `string` | Span category (e.g. `llm`, `tool`, `http`). Used by `TypeBadge`. |
|
|
126
|
+
| `status` | `"running" \| "completed" \| "failed" \| "skipped"` | Lifecycle state. Used by `StatusIndicator`. |
|
|
127
|
+
| `startedAt` | `number` | Start timestamp (ms). |
|
|
128
|
+
| `endedAt` | `number \| null` | End timestamp (ms), or `null` if still running. |
|
|
129
|
+
| `latencyMs` | `number \| null` | Pre-computed latency, or `null` if running. |
|
|
130
|
+
|
|
131
|
+
### SpanState
|
|
132
|
+
|
|
133
|
+
Returned by `useAuiState((s) => s.span)` inside any span-scoped subtree:
|
|
134
|
+
|
|
135
|
+
```ts
|
|
136
|
+
type SpanState = {
|
|
137
|
+
id: string;
|
|
138
|
+
parentSpanId: string | null;
|
|
139
|
+
name: string;
|
|
140
|
+
type: string;
|
|
141
|
+
status: "running" | "completed" | "failed" | "skipped";
|
|
142
|
+
startedAt: number;
|
|
143
|
+
endedAt: number | null;
|
|
144
|
+
latencyMs: number | null;
|
|
145
|
+
depth: number;
|
|
146
|
+
hasChildren: boolean;
|
|
147
|
+
isCollapsed: boolean;
|
|
148
|
+
children: SpanItemState[];
|
|
149
|
+
timeRange: { min: number; max: number };
|
|
150
|
+
};
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### SpanPrimitive.Root
|
|
154
|
+
|
|
155
|
+
Container `<div>` exposing span state via data attributes for styling:
|
|
156
|
+
|
|
157
|
+
| Attribute | Source |
|
|
158
|
+
| --- | --- |
|
|
159
|
+
| `data-span-id` | `span.id` |
|
|
160
|
+
| `data-span-status` | `span.status` |
|
|
161
|
+
| `data-span-type` | `span.type` |
|
|
162
|
+
| `data-span-depth` | `span.depth` |
|
|
163
|
+
| `data-collapsed` | `span.isCollapsed` |
|
|
164
|
+
|
|
165
|
+
Accepts all standard `<div>` props.
|
|
166
|
+
|
|
167
|
+
### SpanPrimitive.Indent
|
|
168
|
+
|
|
169
|
+
A `<div>` that adds horizontal padding proportional to span depth.
|
|
170
|
+
|
|
171
|
+
| Prop | Type | Default | Description |
|
|
172
|
+
| --- | --- | --- | --- |
|
|
173
|
+
| `baseIndent` | `number` | `8` | Base padding in pixels. |
|
|
174
|
+
| `indentPerLevel` | `number` | `12` | Additional padding per depth level. |
|
|
175
|
+
|
|
176
|
+
Final `paddingLeft = baseIndent + depth * indentPerLevel`.
|
|
177
|
+
|
|
178
|
+
### SpanPrimitive.CollapseToggle
|
|
179
|
+
|
|
180
|
+
A `<button>` that toggles the current span's collapsed state. Renders only when the span has children. Stops click propagation so it can be nested inside a clickable row.
|
|
181
|
+
|
|
182
|
+
Exposes `data-collapsed` for styling. Accepts all standard `<button>` props.
|
|
183
|
+
|
|
184
|
+
### SpanPrimitive.StatusIndicator
|
|
185
|
+
|
|
186
|
+
A `<span>` that exposes `data-span-status` for status-based styling (color, icon swap, etc.). Renders no built-in glyph; you provide the visual.
|
|
187
|
+
|
|
188
|
+
```tsx
|
|
189
|
+
<SpanPrimitive.StatusIndicator className="size-2 rounded-full data-[span-status=running]:bg-yellow-500 data-[span-status=completed]:bg-green-500 data-[span-status=failed]:bg-red-500 data-[span-status=skipped]:bg-gray-400" />
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
### SpanPrimitive.TypeBadge
|
|
193
|
+
|
|
194
|
+
A `<span>` that defaults its children to `span.type` (override by passing custom children). Exposes `data-span-type`.
|
|
195
|
+
|
|
196
|
+
### SpanPrimitive.Name
|
|
197
|
+
|
|
198
|
+
A `<span>` that defaults its children to `span.name`. Override by passing custom children.
|
|
199
|
+
|
|
200
|
+
### SpanPrimitive.Children
|
|
201
|
+
|
|
202
|
+
Iterates over visible child spans and renders each.
|
|
203
|
+
|
|
204
|
+
Two usage modes:
|
|
205
|
+
|
|
206
|
+
**Render-prop:**
|
|
207
|
+
|
|
208
|
+
```tsx
|
|
209
|
+
<SpanPrimitive.Children>
|
|
210
|
+
{({ span }) => <CustomRow span={span} />}
|
|
211
|
+
</SpanPrimitive.Children>
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
**Component prop (recommended for performance):**
|
|
215
|
+
|
|
216
|
+
```tsx
|
|
217
|
+
<SpanPrimitive.Children components={{ Span: SpanRow }} />
|
|
218
|
+
```
|
|
219
|
+
|
|
220
|
+
The `components.Span` form is memoized; pass a stable component reference to avoid re-renders on unrelated state changes.
|
|
221
|
+
|
|
222
|
+
Each child is wrapped in `SpanByIndexProvider` automatically, so primitives inside `SpanRow` read that child's state.
|
|
223
|
+
|
|
224
|
+
### SpanByIndexProvider
|
|
225
|
+
|
|
226
|
+
Lower-level escape hatch. Selects one span by index and provides its scope to descendants:
|
|
227
|
+
|
|
228
|
+
```tsx
|
|
229
|
+
<SpanByIndexProvider index={0}>
|
|
230
|
+
<SpanPrimitive.Root>{/* reads span at index 0 */}</SpanPrimitive.Root>
|
|
231
|
+
</SpanByIndexProvider>
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
Most users do not need to use this directly; `SpanPrimitive.Children` wires it up automatically.
|
|
235
|
+
|
|
236
|
+
### SpanPrimitive.ChildByIndex
|
|
237
|
+
|
|
238
|
+
Convenience component that pairs `SpanByIndexProvider` with a render component:
|
|
239
|
+
|
|
240
|
+
```tsx
|
|
241
|
+
<SpanPrimitive.ChildByIndex index={0} components={{ Span: SpanRow }} />
|
|
242
|
+
```
|
|
243
|
+
|
|
244
|
+
Useful when you want explicit control over which child indices to render (e.g. for virtualization).
|
|
245
|
+
|
|
246
|
+
## Styling
|
|
247
|
+
|
|
248
|
+
All primitives forward refs and accept standard DOM props (`className`, `style`, etc.). Use the data attributes for state-based styling:
|
|
249
|
+
|
|
250
|
+
```css
|
|
251
|
+
[data-span-status="running"] {
|
|
252
|
+
/* yellow indicator */
|
|
253
|
+
}
|
|
254
|
+
[data-span-status="failed"] {
|
|
255
|
+
/* red indicator */
|
|
256
|
+
}
|
|
257
|
+
[data-collapsed="true"] svg {
|
|
258
|
+
transform: rotate(0deg);
|
|
259
|
+
}
|
|
260
|
+
[data-collapsed="false"] svg {
|
|
261
|
+
transform: rotate(90deg);
|
|
262
|
+
}
|
|
263
|
+
```
|
|
264
|
+
|
|
265
|
+
## Related
|
|
266
|
+
|
|
267
|
+
<Cards>
|
|
268
|
+
<Card
|
|
269
|
+
title="heat-graph"
|
|
270
|
+
description="Activity heatmap primitives in the same Radix-style headless pattern."
|
|
271
|
+
href="/docs/utilities/heat-graph"
|
|
272
|
+
/>
|
|
273
|
+
<Card
|
|
274
|
+
title="Primitives overview"
|
|
275
|
+
description="The broader assistant-ui primitive system."
|
|
276
|
+
href="/docs/primitives"
|
|
277
|
+
/>
|
|
278
|
+
</Cards>
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: tw-shimmer
|
|
3
3
|
description: Tailwind CSS v4 plugin for shimmer effects.
|
|
4
|
+
platforms: ["react"]
|
|
4
5
|
---
|
|
5
6
|
|
|
6
7
|
`tw-shimmer` is a zero-dependency Tailwind CSS v4 plugin that provides polished shimmer animations for both text and skeleton loaders. It uses sine-eased gradients with 17 carefully calculated stops and OKLCH color mixing for smooth, banding-free effects.
|
package/README.md
CHANGED
|
@@ -1,28 +1,23 @@
|
|
|
1
|
-
#
|
|
1
|
+
# `@assistant-ui/mcp-docs-server`
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Model Context Protocol (MCP) server that gives AI assistants direct access to assistant-ui's documentation and example projects. Exposes `assistantUIDocs` (retrieve documentation by path) and `assistantUIExamples` (access complete example projects).
|
|
4
4
|
|
|
5
|
-
>
|
|
6
|
-
>
|
|
5
|
+
> [!NOTE]
|
|
6
|
+
> Detailed installation, troubleshooting, and advanced usage at [assistant-ui.com/docs/llm#mcp](https://www.assistant-ui.com/docs/llm#mcp).
|
|
7
7
|
|
|
8
8
|
## Installation
|
|
9
9
|
|
|
10
10
|
### Claude Code
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
# Add to current project
|
|
14
13
|
claude mcp add assistant-ui -- npx -y @assistant-ui/mcp-docs-server
|
|
15
|
-
|
|
16
|
-
# Or add globally for all projects
|
|
14
|
+
# or globally for all projects
|
|
17
15
|
claude mcp add --scope user assistant-ui -- npx -y @assistant-ui/mcp-docs-server
|
|
18
16
|
```
|
|
19
17
|
|
|
20
18
|
### Claude Desktop
|
|
21
19
|
|
|
22
|
-
Add to
|
|
23
|
-
|
|
24
|
-
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
25
|
-
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
|
|
20
|
+
Add to `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS) or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):
|
|
26
21
|
|
|
27
22
|
```json
|
|
28
23
|
{
|
|
@@ -35,39 +30,13 @@ Add to your Claude Desktop configuration:
|
|
|
35
30
|
}
|
|
36
31
|
```
|
|
37
32
|
|
|
38
|
-
### Cursor
|
|
39
|
-
|
|
40
|
-
Add to `.cursor/mcp.json` (project) or `~/.cursor/mcp.json` (global):
|
|
33
|
+
### Cursor / Windsurf
|
|
41
34
|
|
|
42
|
-
|
|
43
|
-
{
|
|
44
|
-
"mcpServers": {
|
|
45
|
-
"assistant-ui": {
|
|
46
|
-
"command": "npx",
|
|
47
|
-
"args": ["-y", "@assistant-ui/mcp-docs-server"]
|
|
48
|
-
}
|
|
49
|
-
}
|
|
50
|
-
}
|
|
51
|
-
```
|
|
52
|
-
|
|
53
|
-
### Windsurf
|
|
54
|
-
|
|
55
|
-
Add to `~/.codeium/windsurf/mcp_config.json`:
|
|
56
|
-
|
|
57
|
-
```json
|
|
58
|
-
{
|
|
59
|
-
"mcpServers": {
|
|
60
|
-
"assistant-ui": {
|
|
61
|
-
"command": "npx",
|
|
62
|
-
"args": ["-y", "@assistant-ui/mcp-docs-server"]
|
|
63
|
-
}
|
|
64
|
-
}
|
|
65
|
-
}
|
|
66
|
-
```
|
|
35
|
+
Add to `.cursor/mcp.json` (or `~/.cursor/mcp.json`) for Cursor, or `~/.codeium/windsurf/mcp_config.json` for Windsurf, using the same `mcpServers` block as above.
|
|
67
36
|
|
|
68
|
-
###
|
|
37
|
+
### VS Code
|
|
69
38
|
|
|
70
|
-
Add to `.vscode/mcp.json
|
|
39
|
+
Add to `.vscode/mcp.json`:
|
|
71
40
|
|
|
72
41
|
```json
|
|
73
42
|
{
|
|
@@ -83,7 +52,7 @@ Add to `.vscode/mcp.json` in your project:
|
|
|
83
52
|
|
|
84
53
|
### Zed
|
|
85
54
|
|
|
86
|
-
Add to `settings.json
|
|
55
|
+
Add to `settings.json`:
|
|
87
56
|
|
|
88
57
|
```json
|
|
89
58
|
{
|
|
@@ -91,38 +60,11 @@ Add to `settings.json` (open via `cmd+,` or `zed: open settings`):
|
|
|
91
60
|
"assistant-ui": {
|
|
92
61
|
"command": {
|
|
93
62
|
"path": "npx",
|
|
94
|
-
"args": ["-y", "@assistant-ui/mcp-docs-server"]
|
|
95
|
-
|
|
96
|
-
},
|
|
97
|
-
"settings": {}
|
|
63
|
+
"args": ["-y", "@assistant-ui/mcp-docs-server"]
|
|
64
|
+
}
|
|
98
65
|
}
|
|
99
66
|
}
|
|
100
67
|
}
|
|
101
68
|
```
|
|
102
69
|
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
- **assistantUIDocs** - Retrieve documentation by path
|
|
106
|
-
- **assistantUIExamples** - Access complete example projects
|
|
107
|
-
|
|
108
|
-
## Managing the Server
|
|
109
|
-
|
|
110
|
-
### Claude Code
|
|
111
|
-
|
|
112
|
-
```bash
|
|
113
|
-
# View configured servers
|
|
114
|
-
claude mcp list
|
|
115
|
-
|
|
116
|
-
# Get server details
|
|
117
|
-
claude mcp get assistant-ui
|
|
118
|
-
|
|
119
|
-
# Remove the server
|
|
120
|
-
claude mcp remove assistant-ui
|
|
121
|
-
|
|
122
|
-
# Restart the server
|
|
123
|
-
claude mcp restart assistant-ui
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
## License
|
|
127
|
-
|
|
128
|
-
MIT
|
|
70
|
+
To list, get, or remove the server, use your editor's MCP management commands.
|
package/dist/constants.d.ts
CHANGED
|
@@ -1,10 +1,13 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
1
|
+
//#region src/constants.d.ts
|
|
2
|
+
declare const ROOT_DIR: string;
|
|
3
|
+
declare const PACKAGE_DIR: string;
|
|
4
|
+
declare const EXAMPLES_PATH: string;
|
|
5
|
+
declare const DOCS_PATH: string;
|
|
6
|
+
declare const CODE_EXAMPLES_PATH: string;
|
|
7
|
+
declare const MDX_EXTENSION = ".mdx";
|
|
8
|
+
declare const MD_EXTENSION = ".md";
|
|
9
|
+
declare const MAX_FILE_SIZE: number;
|
|
10
|
+
declare const IS_PREPARE_MODE: boolean | undefined;
|
|
11
|
+
//#endregion
|
|
12
|
+
export { CODE_EXAMPLES_PATH, DOCS_PATH, EXAMPLES_PATH, IS_PREPARE_MODE, MAX_FILE_SIZE, MDX_EXTENSION, MD_EXTENSION, PACKAGE_DIR, ROOT_DIR };
|
|
10
13
|
//# sourceMappingURL=constants.d.ts.map
|
package/dist/constants.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.d.ts","
|
|
1
|
+
{"version":3,"file":"constants.d.ts","names":[],"sources":["../src/constants.ts"],"mappings":";cAKa,QAAA;AAAA,cACA,WAAA;AAAA,cAEA,aAAA;AAAA,cAGA,SAAA;AAAA,cACA,kBAAA;AAAA,cAEA,aAAA;AAAA,cACA,YAAA;AAAA,cAEA,aAAA;AAAA,cAEA,eAAA"}
|
package/dist/constants.js
CHANGED
|
@@ -1,14 +1,18 @@
|
|
|
1
1
|
import { fileURLToPath } from "node:url";
|
|
2
2
|
import { dirname, join } from "node:path";
|
|
3
|
+
//#region src/constants.ts
|
|
3
4
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
5
|
+
const ROOT_DIR = join(__dirname, "../../../");
|
|
6
|
+
const PACKAGE_DIR = join(__dirname, "../");
|
|
7
|
+
const EXAMPLES_PATH = join(ROOT_DIR, "examples");
|
|
7
8
|
const DOCS_BASE = join(PACKAGE_DIR, ".docs");
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
9
|
+
const DOCS_PATH = join(DOCS_BASE, "raw/docs");
|
|
10
|
+
const CODE_EXAMPLES_PATH = join(DOCS_BASE, "organized/code-examples");
|
|
11
|
+
const MDX_EXTENSION = ".mdx";
|
|
12
|
+
const MD_EXTENSION = ".md";
|
|
13
|
+
const MAX_FILE_SIZE = 10 * 1024 * 1024;
|
|
14
|
+
const IS_PREPARE_MODE = process.argv[1]?.includes("prepare-docs/prepare");
|
|
15
|
+
//#endregion
|
|
16
|
+
export { CODE_EXAMPLES_PATH, DOCS_PATH, EXAMPLES_PATH, IS_PREPARE_MODE, MAX_FILE_SIZE, MDX_EXTENSION, MD_EXTENSION, PACKAGE_DIR, ROOT_DIR };
|
|
17
|
+
|
|
14
18
|
//# sourceMappingURL=constants.js.map
|
package/dist/constants.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.js","
|
|
1
|
+
{"version":3,"file":"constants.js","names":[],"sources":["../src/constants.ts"],"sourcesContent":["import { fileURLToPath } from \"node:url\";\nimport { dirname, join } from \"node:path\";\n\nconst __dirname = dirname(fileURLToPath(import.meta.url));\n\nexport const ROOT_DIR = join(__dirname, \"../../../\");\nexport const PACKAGE_DIR = join(__dirname, \"../\");\n\nexport const EXAMPLES_PATH = join(ROOT_DIR, \"examples\");\n\nconst DOCS_BASE = join(PACKAGE_DIR, \".docs\");\nexport const DOCS_PATH = join(DOCS_BASE, \"raw/docs\");\nexport const CODE_EXAMPLES_PATH = join(DOCS_BASE, \"organized/code-examples\");\n\nexport const MDX_EXTENSION = \".mdx\";\nexport const MD_EXTENSION = \".md\";\n\nexport const MAX_FILE_SIZE = 10 * 1024 * 1024;\n\nexport const IS_PREPARE_MODE = process.argv[1]?.includes(\n \"prepare-docs/prepare\",\n);\n"],"mappings":";;;AAGA,MAAM,YAAY,QAAQ,cAAc,OAAO,KAAK,GAAG,CAAC;AAExD,MAAa,WAAW,KAAK,WAAW,WAAW;AACnD,MAAa,cAAc,KAAK,WAAW,KAAK;AAEhD,MAAa,gBAAgB,KAAK,UAAU,UAAU;AAEtD,MAAM,YAAY,KAAK,aAAa,OAAO;AAC3C,MAAa,YAAY,KAAK,WAAW,UAAU;AACnD,MAAa,qBAAqB,KAAK,WAAW,yBAAyB;AAE3E,MAAa,gBAAgB;AAC7B,MAAa,eAAe;AAE5B,MAAa,gBAAgB,KAAK,OAAO;AAEzC,MAAa,kBAAkB,QAAQ,KAAK,IAAI,SAC9C,sBACF"}
|
package/dist/index.d.ts
CHANGED
|
@@ -1,4 +1,8 @@
|
|
|
1
|
-
import { McpServer } from "@modelcontextprotocol/sdk";
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
2
|
+
|
|
3
|
+
//#region src/index.d.ts
|
|
4
|
+
declare const server: McpServer;
|
|
5
|
+
declare function runServer(): Promise<void>;
|
|
6
|
+
//#endregion
|
|
7
|
+
export { runServer, server };
|
|
4
8
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;;cAca,MAAA,EAAM,SAGjB;AAAA,iBAeoB,SAAA,CAAA,GAAS,OAAA"}
|
package/dist/index.js
CHANGED
|
@@ -1,33 +1,34 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { PACKAGE_DIR } from "./constants.js";
|
|
2
|
+
import { logger } from "./utils/logger.js";
|
|
3
3
|
import { docsTools } from "./tools/docs.js";
|
|
4
4
|
import { examplesTools } from "./tools/examples.js";
|
|
5
|
-
import { logger } from "./utils/logger.js";
|
|
6
|
-
import { PACKAGE_DIR } from "./constants.js";
|
|
7
|
-
import { readFileSync } from "node:fs";
|
|
8
5
|
import { join } from "node:path";
|
|
6
|
+
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
7
|
+
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
8
|
+
import { readFileSync } from "node:fs";
|
|
9
|
+
//#region src/index.ts
|
|
9
10
|
const packageJson = JSON.parse(readFileSync(join(PACKAGE_DIR, "package.json"), "utf-8"));
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
11
|
+
const server = new McpServer({
|
|
12
|
+
name: "assistant-ui-docs",
|
|
13
|
+
version: packageJson.version
|
|
13
14
|
});
|
|
14
15
|
server.tool(docsTools.name, docsTools.description, docsTools.parameters, docsTools.execute);
|
|
15
16
|
server.tool(examplesTools.name, examplesTools.description, examplesTools.parameters, examplesTools.execute);
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
}
|
|
26
|
-
}
|
|
27
|
-
if (import.meta.url === `file://${process.argv[1]}`) {
|
|
28
|
-
void runServer().catch((error) => {
|
|
29
|
-
console.error("Failed to start server:", error);
|
|
30
|
-
process.exit(1);
|
|
31
|
-
});
|
|
17
|
+
async function runServer() {
|
|
18
|
+
try {
|
|
19
|
+
logger.info(`Starting assistant-ui MCP docs server v${packageJson.version}`);
|
|
20
|
+
const transport = new StdioServerTransport();
|
|
21
|
+
await server.connect(transport);
|
|
22
|
+
} catch (error) {
|
|
23
|
+
logger.error("Failed to start MCP server", error);
|
|
24
|
+
process.exit(1);
|
|
25
|
+
}
|
|
32
26
|
}
|
|
27
|
+
if (import.meta.url === `file://${process.argv[1]}`) runServer().catch((error) => {
|
|
28
|
+
console.error("Failed to start server:", error);
|
|
29
|
+
process.exit(1);
|
|
30
|
+
});
|
|
31
|
+
//#endregion
|
|
32
|
+
export { runServer, server };
|
|
33
|
+
|
|
33
34
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","
|
|
1
|
+
{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["import { McpServer } from \"@modelcontextprotocol/sdk/server/mcp.js\";\nimport { StdioServerTransport } from \"@modelcontextprotocol/sdk/server/stdio.js\";\nimport { docsTools } from \"./tools/docs.js\";\nimport { examplesTools } from \"./tools/examples.js\";\nimport { logger } from \"./utils/logger.js\";\nimport { PACKAGE_DIR } from \"./constants.js\";\n\nimport { readFileSync } from \"node:fs\";\nimport { join } from \"node:path\";\n\nconst packageJson = JSON.parse(\n readFileSync(join(PACKAGE_DIR, \"package.json\"), \"utf-8\"),\n);\n\nexport const server = new McpServer({\n name: \"assistant-ui-docs\",\n version: packageJson.version,\n});\n\nserver.tool(\n docsTools.name,\n docsTools.description,\n docsTools.parameters,\n docsTools.execute,\n);\nserver.tool(\n examplesTools.name,\n examplesTools.description,\n examplesTools.parameters,\n examplesTools.execute,\n);\n\nexport async function runServer() {\n try {\n logger.info(\n `Starting assistant-ui MCP docs server v${packageJson.version}`,\n );\n const transport = new StdioServerTransport();\n await server.connect(transport);\n } catch (error) {\n logger.error(\"Failed to start MCP server\", error);\n process.exit(1);\n }\n}\n\nif (import.meta.url === `file://${process.argv[1]}`) {\n void runServer().catch((error) => {\n console.error(\"Failed to start server:\", error);\n process.exit(1);\n });\n}\n"],"mappings":";;;;;;;;;AAUA,MAAM,cAAc,KAAK,MACvB,aAAa,KAAK,aAAa,cAAc,GAAG,OAAO,CACzD;AAEA,MAAa,SAAS,IAAI,UAAU;CAClC,MAAM;CACN,SAAS,YAAY;AACvB,CAAC;AAED,OAAO,KACL,UAAU,MACV,UAAU,aACV,UAAU,YACV,UAAU,OACZ;AACA,OAAO,KACL,cAAc,MACd,cAAc,aACd,cAAc,YACd,cAAc,OAChB;AAEA,eAAsB,YAAY;CAChC,IAAI;EACF,OAAO,KACL,0CAA0C,YAAY,SACxD;EACA,MAAM,YAAY,IAAI,qBAAqB;EAC3C,MAAM,OAAO,QAAQ,SAAS;CAChC,SAAS,OAAO;EACd,OAAO,MAAM,8BAA8B,KAAK;EAChD,QAAQ,KAAK,CAAC;CAChB;AACF;AAEA,IAAI,OAAO,KAAK,QAAQ,UAAU,QAAQ,KAAK,MAC7C,UAAe,EAAE,OAAO,UAAU;CAChC,QAAQ,MAAM,2BAA2B,KAAK;CAC9C,QAAQ,KAAK,CAAC;AAChB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"code-examples.d.ts","
|
|
1
|
+
{"version":3,"file":"code-examples.d.ts","names":[],"sources":["../../src/prepare-docs/code-examples.ts"],"mappings":";iBA2FsB,mBAAA,CAAA,GAAuB,OAAO"}
|