@copilotkit/runtime 1.8.8-next.1 → 1.8.9-next.0

package/dist/lib/integrations/node-http/index.mjs

@@ -1,6 +1,6 @@
 import {
   copilotRuntimeNodeHttpEndpoint
-} from "../../../chunk-HBCCZQBE.mjs";
+} from "../../../chunk-LFB4PE32.mjs";
 import "../../../chunk-EY6RUVB7.mjs";
 import "../../../chunk-5BIEM2UU.mjs";
 import "../../../chunk-SHBDMA63.mjs";

package/dist/{shared-32a46e93.d.ts → shared-df478d34.d.ts}

@@ -174,6 +174,11 @@ declare function extractParametersFromSchema(toolOrSchema?: MCPTool | MCPTool["s
  * @returns An array of Action<any> objects.
  */
 declare function convertMCPToolsToActions(mcpTools: Record<string, MCPTool>, mcpEndpoint: string): Action<any>[];
+/**
+ * Generate better instructions for using MCP tools
+ * This is used to enhance the system prompt with tool documentation
+ */
+declare function generateMcpToolInstructions(toolsMap: Record<string, MCPTool>): string;
 
 /**
  * <Callout type="info">
@@ -402,4 +407,4 @@ type CommonConfig = {
 };
 declare function getCommonConfig(options: CreateCopilotRuntimeServerOptions): CommonConfig;
 
-export { CopilotRequestContextProperties as C, GraphQLContext as G, LogLevel as L, MCPTool as M, addCustomHeaderPlugin as a, CreateCopilotRuntimeServerOptions as b, createContext as c, buildSchema as d, CommonConfig as e, CopilotRuntimeLogger as f, getCommonConfig as g, createLogger as h, CopilotRuntimeRequest as i, CopilotRuntimeConstructorParams as j, CopilotRuntime as k, flattenToolCallsNoDuplicates as l, copilotKitEndpoint as m, langGraphPlatformEndpoint as n, MCPClient as o, MCPEndpointConfig as p, extractParametersFromSchema as q, resolveEndpointType as r, convertMCPToolsToActions as s };
+export { CopilotRequestContextProperties as C, GraphQLContext as G, LogLevel as L, MCPTool as M, addCustomHeaderPlugin as a, CreateCopilotRuntimeServerOptions as b, createContext as c, buildSchema as d, CommonConfig as e, CopilotRuntimeLogger as f, getCommonConfig as g, createLogger as h, CopilotRuntimeRequest as i, CopilotRuntimeConstructorParams as j, CopilotRuntime as k, flattenToolCallsNoDuplicates as l, copilotKitEndpoint as m, langGraphPlatformEndpoint as n, MCPClient as o, MCPEndpointConfig as p, extractParametersFromSchema as q, resolveEndpointType as r, convertMCPToolsToActions as s, generateMcpToolInstructions as t };

package/package.json

@@ -9,7 +9,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.8.8-next.1",
+  "version": "1.8.9-next.0",
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -63,7 +63,7 @@
     "rxjs": "^7.8.1",
     "type-graphql": "2.0.0-rc.1",
     "zod": "^3.23.3",
-    "@copilotkit/shared": "1.8.8-next.1"
+    "@copilotkit/shared": "1.8.9-next.0"
   },
   "keywords": [
     "copilotkit",

package/src/lib/runtime/copilot-runtime.ts

@@ -71,7 +71,13 @@ import { AbstractAgent } from "@agentwire/client";
 import { MessageRole } from "../../graphql/types/enums";
 
 // +++ MCP Imports +++
-import { MCPClient, MCPEndpointConfig, convertMCPToolsToActions } from "./mcp-tools-utils";
+import {
+  MCPClient,
+  MCPEndpointConfig,
+  MCPTool,
+  convertMCPToolsToActions,
+  generateMcpToolInstructions,
+} from "./mcp-tools-utils";
 // Define the function type alias here or import if defined elsewhere
 type CreateMCPClientFunction = (config: MCPEndpointConfig) => Promise<MCPClient>;
 // --- MCP Imports ---
@@ -348,17 +354,31 @@ export class CopilotRuntime<const T extends Parameter[] | [] = []> {
     });
 
     // Format instructions from the unique tools map
-    const mcpToolInstructions = Array.from(uniqueMcpTools.values())
-      .map((action) => {
-        const paramsString =
-          action.parameters && action.parameters.length > 0
-            ? ` Parameters: ${action.parameters
-                .map((p) => `${p.name}${p.required ? "*" : ""}(${p.type})`)
-                .join(", ")}`
-            : "";
-        return `- ${action.name}:${paramsString} ${action.description || ""}`;
-      })
-      .join("\n");
+    // Convert Action objects to MCPTool format for the instruction generator
+    const toolsMap: Record<string, MCPTool> = {};
+    Array.from(uniqueMcpTools.values()).forEach((action) => {
+      toolsMap[action.name] = {
+        description: action.description || "",
+        schema: action.parameters
+          ? {
+              parameters: {
+                properties: action.parameters.reduce(
+                  (acc, p) => ({
+                    ...acc,
+                    [p.name]: { type: p.type, description: p.description },
+                  }),
+                  {},
+                ),
+                required: action.parameters.filter((p) => p.required).map((p) => p.name),
+              },
+            }
+          : {},
+        execute: async () => ({}), // Placeholder, not used for instructions
+      };
+    });
+
+    // Generate instructions using the exported helper
+    const mcpToolInstructions = generateMcpToolInstructions(toolsMap);
 
     if (!mcpToolInstructions) {
       return messages; // No MCP tools to describe

package/src/lib/runtime/mcp-tools-utils.ts

@@ -126,3 +126,63 @@ export function convertMCPToolsToActions(
 
   return actions;
 }
+
+/**
+ * Generate better instructions for using MCP tools
+ * This is used to enhance the system prompt with tool documentation
+ */
+export function generateMcpToolInstructions(toolsMap: Record<string, MCPTool>): string {
+  if (!toolsMap || Object.keys(toolsMap).length === 0) {
+    return "";
+  }
+
+  const toolEntries = Object.entries(toolsMap);
+
+  // Generate documentation for each tool
+  const toolsDoc = toolEntries
+    .map(([name, tool]) => {
+      // Extract schema information if available
+      let paramsDoc = "    No parameters required";
+
+      try {
+        if (tool.schema && typeof tool.schema === "object") {
+          const schema = tool.schema as any;
+
+          // Extract parameters from JSON Schema
+          if (schema.properties) {
+            const requiredParams = schema.required || [];
+
+            // Build parameter documentation from properties
+            const paramsList = Object.entries(schema.properties).map(([paramName, propSchema]) => {
+              const propDetails = propSchema as any;
+              const requiredMark = requiredParams.includes(paramName) ? "*" : "";
+              const typeInfo = propDetails.type || "any";
+              const description = propDetails.description ? ` - ${propDetails.description}` : "";
+
+              return `    - ${paramName}${requiredMark} (${typeInfo})${description}`;
+            });
+
+            if (paramsList.length > 0) {
+              paramsDoc = paramsList.join("\n");
+            }
+          }
+        }
+      } catch (e) {
+        console.error(`Error parsing schema for tool ${name}:`, e);
+      }
+
+      return `- ${name}: ${tool.description || ""}
+${paramsDoc}`;
+    })
+    .join("\n\n");
+
+  return `You have access to the following external tools provided by Model Context Protocol (MCP) servers:
+
+${toolsDoc}
+
+When using these tools:
+1. Only provide valid parameters according to their type requirements
+2. Required parameters are marked with *
+3. Format API calls correctly with the expected parameter structure
+4. Always check tool responses to determine your next action`;
+}