@copilotkitnext/agent 0.0.13-alpha.0

package/.turbo/turbo-build.log

@@ -0,0 +1,23 @@
+
+
+> @copilotkitnext/agent@0.0.13-alpha.0 build /Users/mme/Projects/CopilotKit2/main/packages/agent
+> tsup
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.0
+CLI Using tsup config: /Users/mme/Projects/CopilotKit2/main/packages/agent/tsup.config.ts
+CLI Target: es2022
+CLI Cleaning output folder
+CJS Build start
+ESM Build start
+CJS dist/index.js     21.08 KB
+CJS dist/index.js.map 40.66 KB
+CJS ⚡️ Build success in 13ms
+ESM dist/index.mjs     19.33 KB
+ESM dist/index.mjs.map 40.61 KB
+ESM ⚡️ Build success in 14ms
+DTS Build start
+DTS ⚡️ Build success in 1950ms
+DTS dist/index.d.ts  5.84 KB
+DTS dist/index.d.mts 5.84 KB

package/LICENSE

@@ -0,0 +1,11 @@
+Note: This license does not apply to the whole project. Individual packages may contain their own licenses.
+
+MIT License
+
+Copyright 2025 Tawkit Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/index.d.mts

@@ -0,0 +1,187 @@
+import { Message, RunAgentInput, AbstractAgent, BaseEvent } from '@ag-ui/client';
+import { LanguageModel, ModelMessage, ToolSet, ToolChoice } from 'ai';
+import { Observable } from 'rxjs';
+import { z } from 'zod';
+import { StreamableHTTPClientTransportOptions } from '@modelcontextprotocol/sdk/client/streamableHttp.js';
+
+/**
+ * Properties that can be overridden by forwardedProps
+ * These match the exact parameter names in streamText
+ */
+type OverridableProperty = "model" | "toolChoice" | "maxOutputTokens" | "temperature" | "topP" | "topK" | "presencePenalty" | "frequencyPenalty" | "stopSequences" | "seed" | "maxRetries" | "prompt";
+/**
+ * Supported model identifiers for BasicAgent
+ */
+type BasicAgentModel = "openai/gpt-5" | "openai/gpt-5-mini" | "openai/gpt-4.1" | "openai/gpt-4.1-mini" | "openai/gpt-4.1-nano" | "openai/gpt-4o" | "openai/gpt-4o-mini" | "openai/o3" | "openai/o3-mini" | "openai/o4-mini" | "anthropic/claude-sonnet-4.5" | "anthropic/claude-sonnet-4" | "anthropic/claude-3.7-sonnet" | "anthropic/claude-opus-4.1" | "anthropic/claude-opus-4" | "anthropic/claude-3.5-haiku" | "google/gemini-2.5-pro" | "google/gemini-2.5-flash" | "google/gemini-2.5-flash-lite" | (string & {});
+/**
+ * Model specifier - can be a string like "openai/gpt-4o" or a LanguageModel instance
+ */
+type ModelSpecifier = string | LanguageModel;
+/**
+ * MCP Client configuration for HTTP transport
+ */
+interface MCPClientConfigHTTP {
+    /**
+     * Type of MCP client
+     */
+    type: "http";
+    /**
+     * URL of the MCP server
+     */
+    url: string;
+    /**
+     * Optional transport options for HTTP client
+     */
+    options?: StreamableHTTPClientTransportOptions;
+}
+/**
+ * MCP Client configuration for SSE transport
+ */
+interface MCPClientConfigSSE {
+    /**
+     * Type of MCP client
+     */
+    type: "sse";
+    /**
+     * URL of the MCP server
+     */
+    url: string;
+    /**
+     * Optional HTTP headers (e.g., for authentication)
+     */
+    headers?: Record<string, string>;
+}
+/**
+ * MCP Client configuration
+ */
+type MCPClientConfig = MCPClientConfigHTTP | MCPClientConfigSSE;
+/**
+ * Resolves a model specifier to a LanguageModel instance
+ * @param spec - Model string (e.g., "openai/gpt-4o") or LanguageModel instance
+ * @returns LanguageModel instance
+ */
+declare function resolveModel(spec: ModelSpecifier): LanguageModel;
+/**
+ * Tool definition for BasicAgent
+ */
+interface ToolDefinition<TParameters extends z.ZodTypeAny = z.ZodTypeAny> {
+    name: string;
+    description: string;
+    parameters: TParameters;
+}
+/**
+ * Define a tool for use with BasicAgent
+ * @param name - The name of the tool
+ * @param description - Description of what the tool does
+ * @param parameters - Zod schema for the tool's input parameters
+ * @returns Tool definition
+ */
+declare function defineTool<TParameters extends z.ZodTypeAny>(config: {
+    name: string;
+    description: string;
+    parameters: TParameters;
+}): ToolDefinition<TParameters>;
+/**
+ * Converts AG-UI messages to Vercel AI SDK ModelMessage format
+ */
+declare function convertMessagesToVercelAISDKMessages(messages: Message[]): ModelMessage[];
+/**
+ * JSON Schema type definition
+ */
+interface JsonSchema {
+    type: "object" | "string" | "number" | "boolean" | "array";
+    description?: string;
+    properties?: Record<string, JsonSchema>;
+    required?: string[];
+    items?: JsonSchema;
+}
+/**
+ * Converts JSON Schema to Zod schema
+ */
+declare function convertJsonSchemaToZodSchema(jsonSchema: JsonSchema, required: boolean): z.ZodSchema;
+declare function convertToolsToVercelAITools(tools: RunAgentInput["tools"]): ToolSet;
+/**
+ * Converts ToolDefinition array to Vercel AI SDK ToolSet
+ */
+declare function convertToolDefinitionsToVercelAITools(tools: ToolDefinition[]): ToolSet;
+/**
+ * Configuration for BasicAgent
+ */
+interface BasicAgentConfiguration {
+    /**
+     * The model to use
+     */
+    model: BasicAgentModel | LanguageModel;
+    /**
+     * Maximum number of steps/iterations for tool calling (default: 1)
+     */
+    maxSteps?: number;
+    /**
+     * Tool choice setting - how tools are selected for execution (default: "auto")
+     */
+    toolChoice?: ToolChoice<Record<string, unknown>>;
+    /**
+     * Maximum number of tokens to generate
+     */
+    maxOutputTokens?: number;
+    /**
+     * Temperature setting (range depends on provider)
+     */
+    temperature?: number;
+    /**
+     * Nucleus sampling (topP)
+     */
+    topP?: number;
+    /**
+     * Top K sampling
+     */
+    topK?: number;
+    /**
+     * Presence penalty
+     */
+    presencePenalty?: number;
+    /**
+     * Frequency penalty
+     */
+    frequencyPenalty?: number;
+    /**
+     * Sequences that will stop the generation
+     */
+    stopSequences?: string[];
+    /**
+     * Seed for deterministic results
+     */
+    seed?: number;
+    /**
+     * Maximum number of retries
+     */
+    maxRetries?: number;
+    /**
+     * Prompt for the agent
+     */
+    prompt?: string;
+    /**
+     * List of properties that can be overridden by forwardedProps.
+     */
+    overridableProperties?: OverridableProperty[];
+    /**
+     * Optional list of MCP server configurations
+     */
+    mcpServers?: MCPClientConfig[];
+    /**
+     * Optional tools available to the agent
+     */
+    tools?: ToolDefinition[];
+}
+declare class BasicAgent extends AbstractAgent {
+    private config;
+    constructor(config: BasicAgentConfiguration);
+    /**
+     * Check if a property can be overridden by forwardedProps
+     */
+    canOverride(property: OverridableProperty): boolean;
+    protected run(input: RunAgentInput): Observable<BaseEvent>;
+    clone(): BasicAgent;
+}
+
+export { BasicAgent, type BasicAgentConfiguration, type BasicAgentModel, type MCPClientConfig, type MCPClientConfigHTTP, type MCPClientConfigSSE, type ModelSpecifier, type OverridableProperty, type ToolDefinition, convertJsonSchemaToZodSchema, convertMessagesToVercelAISDKMessages, convertToolDefinitionsToVercelAITools, convertToolsToVercelAITools, defineTool, resolveModel };

package/dist/index.d.ts

@@ -0,0 +1,187 @@
+import { Message, RunAgentInput, AbstractAgent, BaseEvent } from '@ag-ui/client';
+import { LanguageModel, ModelMessage, ToolSet, ToolChoice } from 'ai';
+import { Observable } from 'rxjs';
+import { z } from 'zod';
+import { StreamableHTTPClientTransportOptions } from '@modelcontextprotocol/sdk/client/streamableHttp.js';
+
+/**
+ * Properties that can be overridden by forwardedProps
+ * These match the exact parameter names in streamText
+ */
+type OverridableProperty = "model" | "toolChoice" | "maxOutputTokens" | "temperature" | "topP" | "topK" | "presencePenalty" | "frequencyPenalty" | "stopSequences" | "seed" | "maxRetries" | "prompt";
+/**
+ * Supported model identifiers for BasicAgent
+ */
+type BasicAgentModel = "openai/gpt-5" | "openai/gpt-5-mini" | "openai/gpt-4.1" | "openai/gpt-4.1-mini" | "openai/gpt-4.1-nano" | "openai/gpt-4o" | "openai/gpt-4o-mini" | "openai/o3" | "openai/o3-mini" | "openai/o4-mini" | "anthropic/claude-sonnet-4.5" | "anthropic/claude-sonnet-4" | "anthropic/claude-3.7-sonnet" | "anthropic/claude-opus-4.1" | "anthropic/claude-opus-4" | "anthropic/claude-3.5-haiku" | "google/gemini-2.5-pro" | "google/gemini-2.5-flash" | "google/gemini-2.5-flash-lite" | (string & {});
+/**
+ * Model specifier - can be a string like "openai/gpt-4o" or a LanguageModel instance
+ */
+type ModelSpecifier = string | LanguageModel;
+/**
+ * MCP Client configuration for HTTP transport
+ */
+interface MCPClientConfigHTTP {
+    /**
+     * Type of MCP client
+     */
+    type: "http";
+    /**
+     * URL of the MCP server
+     */
+    url: string;
+    /**
+     * Optional transport options for HTTP client
+     */
+    options?: StreamableHTTPClientTransportOptions;
+}
+/**
+ * MCP Client configuration for SSE transport
+ */
+interface MCPClientConfigSSE {
+    /**
+     * Type of MCP client
+     */
+    type: "sse";
+    /**
+     * URL of the MCP server
+     */
+    url: string;
+    /**
+     * Optional HTTP headers (e.g., for authentication)
+     */
+    headers?: Record<string, string>;
+}
+/**
+ * MCP Client configuration
+ */
+type MCPClientConfig = MCPClientConfigHTTP | MCPClientConfigSSE;
+/**
+ * Resolves a model specifier to a LanguageModel instance
+ * @param spec - Model string (e.g., "openai/gpt-4o") or LanguageModel instance
+ * @returns LanguageModel instance
+ */
+declare function resolveModel(spec: ModelSpecifier): LanguageModel;
+/**
+ * Tool definition for BasicAgent
+ */
+interface ToolDefinition<TParameters extends z.ZodTypeAny = z.ZodTypeAny> {
+    name: string;
+    description: string;
+    parameters: TParameters;
+}
+/**
+ * Define a tool for use with BasicAgent
+ * @param name - The name of the tool
+ * @param description - Description of what the tool does
+ * @param parameters - Zod schema for the tool's input parameters
+ * @returns Tool definition
+ */
+declare function defineTool<TParameters extends z.ZodTypeAny>(config: {
+    name: string;
+    description: string;
+    parameters: TParameters;
+}): ToolDefinition<TParameters>;
+/**
+ * Converts AG-UI messages to Vercel AI SDK ModelMessage format
+ */
+declare function convertMessagesToVercelAISDKMessages(messages: Message[]): ModelMessage[];
+/**
+ * JSON Schema type definition
+ */
+interface JsonSchema {
+    type: "object" | "string" | "number" | "boolean" | "array";
+    description?: string;
+    properties?: Record<string, JsonSchema>;
+    required?: string[];
+    items?: JsonSchema;
+}
+/**
+ * Converts JSON Schema to Zod schema
+ */
+declare function convertJsonSchemaToZodSchema(jsonSchema: JsonSchema, required: boolean): z.ZodSchema;
+declare function convertToolsToVercelAITools(tools: RunAgentInput["tools"]): ToolSet;
+/**
+ * Converts ToolDefinition array to Vercel AI SDK ToolSet
+ */
+declare function convertToolDefinitionsToVercelAITools(tools: ToolDefinition[]): ToolSet;
+/**
+ * Configuration for BasicAgent
+ */
+interface BasicAgentConfiguration {
+    /**
+     * The model to use
+     */
+    model: BasicAgentModel | LanguageModel;
+    /**
+     * Maximum number of steps/iterations for tool calling (default: 1)
+     */
+    maxSteps?: number;
+    /**
+     * Tool choice setting - how tools are selected for execution (default: "auto")
+     */
+    toolChoice?: ToolChoice<Record<string, unknown>>;
+    /**
+     * Maximum number of tokens to generate
+     */
+    maxOutputTokens?: number;
+    /**
+     * Temperature setting (range depends on provider)
+     */
+    temperature?: number;
+    /**
+     * Nucleus sampling (topP)
+     */
+    topP?: number;
+    /**
+     * Top K sampling
+     */
+    topK?: number;
+    /**
+     * Presence penalty
+     */
+    presencePenalty?: number;
+    /**
+     * Frequency penalty
+     */
+    frequencyPenalty?: number;
+    /**
+     * Sequences that will stop the generation
+     */
+    stopSequences?: string[];
+    /**
+     * Seed for deterministic results
+     */
+    seed?: number;
+    /**
+     * Maximum number of retries
+     */
+    maxRetries?: number;
+    /**
+     * Prompt for the agent
+     */
+    prompt?: string;
+    /**
+     * List of properties that can be overridden by forwardedProps.
+     */
+    overridableProperties?: OverridableProperty[];
+    /**
+     * Optional list of MCP server configurations
+     */
+    mcpServers?: MCPClientConfig[];
+    /**
+     * Optional tools available to the agent
+     */
+    tools?: ToolDefinition[];
+}
+declare class BasicAgent extends AbstractAgent {
+    private config;
+    constructor(config: BasicAgentConfiguration);
+    /**
+     * Check if a property can be overridden by forwardedProps
+     */
+    canOverride(property: OverridableProperty): boolean;
+    protected run(input: RunAgentInput): Observable<BaseEvent>;
+    clone(): BasicAgent;
+}
+
+export { BasicAgent, type BasicAgentConfiguration, type BasicAgentModel, type MCPClientConfig, type MCPClientConfigHTTP, type MCPClientConfigSSE, type ModelSpecifier, type OverridableProperty, type ToolDefinition, convertJsonSchemaToZodSchema, convertMessagesToVercelAISDKMessages, convertToolDefinitionsToVercelAITools, convertToolsToVercelAITools, defineTool, resolveModel };