@assistant-ui/mcp-docs-server 0.1.2 → 0.1.3

package/.docs/raw/docs/copilots/make-assistant-tool-ui.mdx

@@ -4,14 +4,12 @@ title: makeAssistantToolUI
 
 import { ParametersTable } from "@/components/docs";
 
-# `makeAssistantToolUI`
-
 The `makeAssistantToolUI` utility is used to register a tool UI component with the Assistant.
 
 ## Usage
 
 ```tsx
-import { makeAssistantToolUI } from "assistant-ui/react";
+import { makeAssistantToolUI } from "@assistant-ui/react";
 
 const MyToolUI = makeAssistantToolUI({
   toolName: "myTool",
@@ -23,9 +21,7 @@ const MyToolUI = makeAssistantToolUI({
 
 ## API
 
-### `makeAssistantToolUI(tool)`
-
-#### Parameters
+### Parameters
 
 <ParametersTable
   type="AssistantToolUIProps<TArgs, TResult>"
@@ -37,29 +33,87 @@ const MyToolUI = makeAssistantToolUI({
     },
     {
       name: "render",
-      type: "function",
-      description: "A function that renders the tool UI. It receives an object with the following properties: `args` (any): The arguments passed to the tool. `result` (any): The result of the tool execution. `status` (\"requires_action\" | \"in_progress\" | \"complete\" | \"error\"): The status of the tool execution.",
+      type: "ComponentType<ToolCallContentPartProps<TArgs, TResult>>",
+      description: "A React component that renders the tool UI. Receives the following props:",
+      required: true,
+      children: [
+        {
+          type: "ToolCallContentPartProps<TArgs, TResult>",
+          parameters: [
+            {
+              name: "type",
+              type: "\"tool-call\"",
+              description: "The content part type",
+            },
+            {
+              name: "toolCallId",
+              type: "string",
+              description: "Unique identifier for this tool call",
+            },
+            {
+              name: "toolName",
+              type: "string",
+              description: "The name of the tool being called",
+            },
+            {
+              name: "args",
+              type: "TArgs",
+              description: "The arguments passed to the tool",
+            },
+            {
+              name: "argsText",
+              type: "string",
+              description: "String representation of the arguments",
+            },
+            {
+              name: "result",
+              type: "TResult | undefined",
+              description: "The result of the tool execution (if complete)",
+            },
+            {
+              name: "isError",
+              type: "boolean | undefined",
+              description: "Whether the result is an error",
+            },
+            {
+              name: "status",
+              type: "ToolCallContentPartStatus",
+              description: "The execution status object with a type property: \"running\", \"complete\", \"incomplete\", or \"requires_action\"",
+            },
+            {
+              name: "addResult",
+              type: "(result: TResult | ToolResponse<TResult>) => void",
+              description: "Function to add a result (useful for human-in-the-loop tools)",
+            },
+            {
+              name: "artifact",
+              type: "unknown",
+              description: "Optional artifact data associated with the tool call",
+            },
+          ],
+        },
+      ],
     },
   ]}
 />
 
-#### Returns
+### Returns
 
 A React functional component that should be included in your component tree. This component doesn't render anything itself, but it registers the tool UI with the Assistant.
 
 ## Example
 
 ```tsx
-import { makeAssistantToolUI } from "assistant-ui/react";
-import { AssistantRuntimeProvider } from "assistant-ui/react";
+import { makeAssistantToolUI } from "@assistant-ui/react";
+import { AssistantRuntimeProvider } from "@assistant-ui/react";
 
 const GetWeatherUI = makeAssistantToolUI({
   toolName: "get_weather",
   render: ({ args, result, status }) => {
-    if (status === "requires_action") return <p>Getting weather for {args.location}...</p>;
-    if (status === "in_progress") return <p>Loading...</p>;
-    if (status === "error") return <p>Error getting weather.</p>;
-    if (status === "complete") return <p>The weather is {result.weather}.</p>;
+    if (status.type === "requires_action") return <p>Getting weather for {args.location}...</p>;
+    if (status.type === "running") return <p>Loading...</p>;
+    if (status.type === "incomplete" && status.reason === "error") return <p>Error getting weather.</p>;
+    if (status.type === "complete") return <p>The weather is {result.weather}.</p>;
     return null;
   },
 });

package/.docs/raw/docs/copilots/make-assistant-tool.mdx

@@ -2,6 +2,8 @@
 title: makeAssistantTool
 ---
 
+import { ParametersTable } from "@/components/docs";
+
 `makeAssistantTool` creates a React component that provides a tool to the assistant. This is useful for defining reusable tools that can be composed into your application.
 
 ## Usage
@@ -23,7 +25,10 @@ const submitForm = tool({
 });
 
 // Create a tool component
-const SubmitFormTool = makeAssistantTool(submitForm);
+const SubmitFormTool = makeAssistantTool({
+  ...submitForm,
+  toolName: "submitForm"
+});
 
 // Use in your component
 function Form() {
@@ -40,9 +45,96 @@ function Form() {
 
 ### Parameters
 
-- `tool`: A tool definition created using the `tool()` helper function
-  - `parameters`: Zod schema defining the tool's parameters
-  - `execute`: Function that implements the tool's behavior
+<ParametersTable
+  type="AssistantToolProps<TArgs, TResult>"
+  parameters={[
+    {
+      name: "toolName",
+      type: "string",
+      description: "The unique identifier for the tool",
+      required: true,
+    },
+    {
+      name: "parameters",
+      type: "StandardSchemaV1<TArgs> | JSONSchema7",
+      description: "Schema defining the tool's parameters (typically a Zod schema)",
+      required: true,
+    },
+    {
+      name: "execute",
+      type: "(args: TArgs, context: ToolExecutionContext) => TResult | Promise<TResult>",
+      description: "Function that implements the tool's behavior (required for frontend tools)",
+      required: true,
+    },
+    {
+      name: "description",
+      type: "string",
+      description: "Optional description of the tool's purpose",
+    },
+    {
+      name: "render",
+      type: "ComponentType<ToolCallContentPartProps<TArgs, TResult>>",
+      description: "Optional custom UI component for rendering the tool execution. Receives the following props:",
+      children: [
+        {
+          type: "ToolCallContentPartProps<TArgs, TResult>",
+          parameters: [
+            {
+              name: "type",
+              type: "\"tool-call\"",
+              description: "The content part type",
+            },
+            {
+              name: "toolCallId",
+              type: "string",
+              description: "Unique identifier for this tool call",
+            },
+            {
+              name: "toolName",
+              type: "string",
+              description: "The name of the tool being called",
+            },
+            {
+              name: "args",
+              type: "TArgs",
+              description: "The arguments passed to the tool",
+            },
+            {
+              name: "argsText",
+              type: "string",
+              description: "String representation of the arguments",
+            },
+            {
+              name: "result",
+              type: "TResult | undefined",
+              description: "The result of the tool execution (if complete)",
+            },
+            {
+              name: "isError",
+              type: "boolean | undefined",
+              description: "Whether the result is an error",
+            },
+            {
+              name: "status",
+              type: "ToolCallContentPartStatus",
+              description: "The execution status object with a type property: \"running\", \"complete\", \"incomplete\", or \"requires_action\"",
+            },
+            {
+              name: "addResult",
+              type: "(result: TResult | ToolResponse<TResult>) => void",
+              description: "Function to add a result (useful for human-in-the-loop tools)",
+            },
+            {
+              name: "artifact",
+              type: "unknown",
+              description: "Optional artifact data associated with the tool call",
+            },
+          ],
+        },
+      ],
+    },
+  ]}
+/>
 
 ### Returns
 
@@ -76,14 +168,20 @@ const sendEmail = tool({
     body: z.string(),
   }),
   execute: async (params) => {
-    // Implementation
+    // Tool logic
     return { sent: true };
   },
 });
 
 // Create tool components
-const EmailValidator = makeAssistantTool(validateEmail);
-const EmailSender = makeAssistantTool(sendEmail);
+const EmailValidator = makeAssistantTool({
+  ...validateEmail,
+  toolName: "validateEmail"
+});
+const EmailSender = makeAssistantTool({
+  ...sendEmail,
+  toolName: "sendEmail"
+});
 
 // Use together
 function EmailForm() {

package/.docs/raw/docs/copilots/model-context.mdx

@@ -54,7 +54,10 @@ const submitForm = tool({
   },
 });
 
-const SubmitFormTool = makeAssistantTool(submitForm);
+const SubmitFormTool = makeAssistantTool({
+  ...submitForm,
+  toolName: "submitForm"
+});
 
 // Use in your component
 function Form() {

package/.docs/raw/docs/copilots/motivation.mdx

@@ -122,7 +122,10 @@ const analyzeTransaction = tool({
 });
 
 // Create a tool component
-const TransactionAnalyzer = makeAssistantTool(analyzeTransaction);
+const TransactionAnalyzer = makeAssistantTool({
+  ...analyzeTransaction,
+  toolName: "analyzeTransaction",
+});
 
 function SmartTransactionHistory() {
   // Previous instructions...

package/.docs/raw/docs/guides/ToolUI.mdx

@@ -47,7 +47,10 @@ const weatherTool = tool({
 });
 
 // Register the tool
-const WeatherTool = makeAssistantTool(weatherTool);
+const WeatherTool = makeAssistantTool({
+  ...weatherTool,
+  toolName: "getWeather"
+});
 
 // Create the UI
 const WeatherToolUI = makeAssistantToolUI<

package/.docs/raw/docs/guides/Tools.mdx

@@ -52,7 +52,10 @@ const weatherTool = tool({
 });
 
 // Create the component
-const WeatherTool = makeAssistantTool(weatherTool);
+const WeatherTool = makeAssistantTool({
+  ...weatherTool,
+  toolName: "getWeather"
+});
 
 // Place the tool component inside AssistantRuntimeProvider
 function App() {
@@ -214,7 +217,10 @@ const screenshotTool = tool({
   }
 });
 
-const ScreenshotTool = makeAssistantTool(screenshotTool);
+const ScreenshotTool = makeAssistantTool({
+  ...screenshotTool,
+  toolName: "screenshot"
+});
 ```
 
 ### Backend Tools
@@ -267,7 +273,10 @@ const calculateTool = tool({
   }
 });
 
-const CalculateTool = makeAssistantTool(calculateTool);
+const CalculateTool = makeAssistantTool({
+  ...calculateTool,
+  toolName: "calculate"
+});
 
 // Backend: Use frontendTools to receive client tools
 import { frontendTools } from "@assistant-ui/react-ai-sdk";
@@ -329,7 +338,10 @@ const refundTool = tool({
   }
 });
 
-const RefundTool = makeAssistantTool(refundTool);
+const RefundTool = makeAssistantTool({
+  ...refundTool,
+  toolName: "requestRefund"
+});
 ```
 
 ### MCP (Model Context Protocol) Tools
@@ -393,7 +405,10 @@ const travelPlannerTool = tool({
   }
 });
 
-const TravelPlannerTool = makeAssistantTool(travelPlannerTool);
+const TravelPlannerTool = makeAssistantTool({
+  ...travelPlannerTool,
+  toolName: "planTrip"
+});
 ```
 
 ### Conditional Tool Availability
@@ -461,7 +476,10 @@ const resilientTool = tool({
   }
 });
 
-const ResilientTool = makeAssistantTool(resilientTool);
+const ResilientTool = makeAssistantTool({
+  ...resilientTool,
+  toolName: "fetchWithRetries"
+});
 ```
 
 ## Best Practices

package/.docs/raw/docs/mcp-docs-server.mdx

@@ -7,9 +7,7 @@ import { Tabs, Tab } from "fumadocs-ui/components/tabs";
 
 `@assistant-ui/mcp-docs-server` provides direct access to assistant-ui's documentation and examples in Cursor, Windsurf, VSCode, Zed, Claude Code, or any other IDE or tool that supports MCP.
 
-It has access to comprehensive documentation and complete code examples which your IDE can read to help you build conversational UI components with assistant-ui.
-
-The MCP server tools have been designed to allow an agent to query the specific information it needs to complete an assistant-ui related task - for example: implementing chat components, integrating with different runtimes, or understanding component architecture.
+The MCP server tools have been designed to allow an agent to query the specific information it needs to complete an assistant-ui related task - for example: implementing chat components, integrating with different runtimes, understanding component architecture, and troubleshooting issues.
 
 ## How it works
 

package/.docs/raw/docs/runtimes/custom/local.mdx

@@ -841,9 +841,9 @@ function MyCustomRuntimeProvider({ children }) {
 </Callout>
 
 <Callout type="warning">
-  **`useThreadRuntime` vs `useLocalThreadRuntime`:** - `useThreadRuntime` -
-  Access the current thread's runtime from within components -
-  `useLocalThreadRuntime` - Create a new single-thread runtime instance
+  **`useThreadRuntime` vs `useLocalThreadRuntime`:** 
+  - `useThreadRuntime` - Access the current thread's runtime from within components 
+  - `useLocalThreadRuntime` - Create a new single-thread runtime instance
 </Callout>
 
 ## Integration Examples

package/dist/{chunk-CZCDQ3YH.js → chunk-JS4PWCVA.js}

@@ -1,4 +1,4 @@
-import { logger, IS_PREPARE_MODE, MDX_EXTENSION, DOCS_PATH, MAX_FILE_SIZE, CODE_EXAMPLES_PATH, MD_EXTENSION } from './chunk-C7O7EFKU.js';
+import { logger, IS_PREPARE_MODE, MDX_EXTENSION, DOCS_PATH, MAX_FILE_SIZE, CODE_EXAMPLES_PATH, MD_EXTENSION } from './chunk-M2RKUM66.js';
 import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
 import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
 import { z } from 'zod';

package/dist/{chunk-C7O7EFKU.js → chunk-M2RKUM66.js}

@@ -31,7 +31,7 @@ var logger = {
     console.error(`[ERROR] ${message}`, ...args);
   },
   warn: (message, ...args) => {
-    console.error(`[WARN] ${message}`, ...args);
+    console.warn(`[WARN] ${message}`, ...args);
   }
 };
 

package/dist/index.js

@@ -1 +1 @@
-export { runServer, server } from './chunk-CZCDQ3YH.js';
+export { runServer, server } from './chunk-JS4PWCVA.js';

package/dist/prepare-docs/prepare.js

@@ -1,4 +1,4 @@
-import { ROOT_DIR, logger, EXAMPLES_PATH } from '../chunk-C7O7EFKU.js';
+import { ROOT_DIR, logger, EXAMPLES_PATH } from '../chunk-M2RKUM66.js';
 import { rm, mkdir, readdir, readFile, writeFile, copyFile } from 'fs/promises';
 import { join, extname, relative } from 'path';
 

package/dist/stdio.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { runServer } from './chunk-CZCDQ3YH.js';
+import { runServer } from './chunk-JS4PWCVA.js';
 
 // src/stdio.ts
 void runServer().catch((error) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@assistant-ui/mcp-docs-server",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "MCP server for assistant-ui documentation and examples",
   "type": "module",
   "main": "dist/index.js",