@objectstack/service-ai 4.0.1 → 4.0.3

package/src/index.ts

@@ -10,26 +10,45 @@ export type { AIServicePluginOptions } from './plugin.js';
 
 // Adapters
 export { MemoryLLMAdapter } from './adapters/memory-adapter.js';
+export { VercelLLMAdapter } from './adapters/vercel-adapter.js';
+export type { VercelLLMAdapterConfig } from './adapters/vercel-adapter.js';
 export type { LLMAdapter } from '@objectstack/spec/contracts';
 
+// Vercel Data Stream encoder
+export { encodeStreamPart, encodeVercelDataStream } from './stream/vercel-stream-encoder.js';
+
 // Conversation
 export { InMemoryConversationService } from './conversation/in-memory-conversation-service.js';
 export { ObjectQLConversationService } from './conversation/objectql-conversation-service.js';
 
 // Tool registry
 export { ToolRegistry } from './tools/tool-registry.js';
-export type { ToolHandler } from './tools/tool-registry.js';
+export type { ToolHandler, ToolExecutionResult } from './tools/tool-registry.js';
 
 // Data tools
 export { registerDataTools, DATA_TOOL_DEFINITIONS } from './tools/data-tools.js';
 export type { DataToolContext } from './tools/data-tools.js';
 
+// Metadata tools
+export { registerMetadataTools, METADATA_TOOL_DEFINITIONS } from './tools/metadata-tools.js';
+export type { MetadataToolContext } from './tools/metadata-tools.js';
+
+// Individual tool metadata (first-class Tool definitions via defineTool)
+export {
+  createObjectTool,
+  addFieldTool,
+  modifyFieldTool,
+  deleteFieldTool,
+  listObjectsTool,
+  describeObjectTool,
+} from './tools/metadata-tools.js';
+
 // Agent runtime
 export { AgentRuntime } from './agent-runtime.js';
 export type { AgentChatContext } from './agent-runtime.js';
 
 // Built-in agents
-export { DATA_CHAT_AGENT } from './agents/index.js';
+export { DATA_CHAT_AGENT, METADATA_ASSISTANT_AGENT } from './agents/index.js';
 
 // Object definitions
 export { AiConversationObject, AiMessageObject } from './objects/index.js';
@@ -37,4 +56,5 @@ export { AiConversationObject, AiMessageObject } from './objects/index.js';
 // Routes
 export { buildAIRoutes } from './routes/ai-routes.js';
 export { buildAgentRoutes } from './routes/agent-routes.js';
+export { buildToolRoutes } from './routes/tool-routes.js';
 export type { RouteDefinition, RouteRequest, RouteResponse, RouteUserContext } from './routes/ai-routes.js';

package/src/plugin.ts

@@ -6,11 +6,15 @@ import { AIService } from './ai-service.js';
 import type { AIServiceConfig } from './ai-service.js';
 import { buildAIRoutes } from './routes/ai-routes.js';
 import { buildAgentRoutes } from './routes/agent-routes.js';
+import { buildToolRoutes } from './routes/tool-routes.js';
 import { ObjectQLConversationService } from './conversation/objectql-conversation-service.js';
 import { AiConversationObject, AiMessageObject } from './objects/index.js';
 import { registerDataTools } from './tools/data-tools.js';
+import { registerMetadataTools } from './tools/metadata-tools.js';
 import { AgentRuntime } from './agent-runtime.js';
-import { DATA_CHAT_AGENT } from './agents/index.js';
+import { DATA_CHAT_AGENT, METADATA_ASSISTANT_AGENT } from './agents/index.js';
+import { VercelLLMAdapter } from './adapters/vercel-adapter.js';
+import { MemoryLLMAdapter } from './adapters/memory-adapter.js';
 
 /**
  * Configuration options for the AIServicePlugin.
@@ -51,7 +55,7 @@ export class AIServicePlugin implements Plugin {
   name = 'com.objectstack.service-ai';
   version = '1.0.0';
   type = 'standard' as const;
-  dependencies: string[] = [];
+  dependencies: string[] = ['com.objectstack.engine.objectql']; // manifest service required
 
   private service?: AIService;
   private readonly options: AIServicePluginOptions;
@@ -60,6 +64,90 @@ export class AIServicePlugin implements Plugin {
     this.options = options;
   }
 
+  /**
+   * Auto-detect LLM provider from environment variables.
+   *
+   * Priority order:
+   * 1. AI_GATEWAY_MODEL → Vercel AI Gateway
+   * 2. OPENAI_API_KEY → OpenAI
+   * 3. ANTHROPIC_API_KEY → Anthropic
+   * 4. GOOGLE_GENERATIVE_AI_API_KEY → Google
+   * 5. Fallback → MemoryLLMAdapter
+   *
+   * Returns the adapter and a description for logging.
+   */
+  private async detectAdapter(ctx: PluginContext): Promise<{ adapter: LLMAdapter; description: string }> {
+    // 1. Vercel AI Gateway — works with any provider via gateway('provider/model')
+    const gatewayModel = process.env.AI_GATEWAY_MODEL;
+    if (gatewayModel) {
+      try {
+        const gatewayPkg = '@ai-sdk/gateway';
+        const { gateway } = await import(/* webpackIgnore: true */ gatewayPkg);
+        const adapter = new VercelLLMAdapter({ model: gateway(gatewayModel) });
+        return { adapter, description: `Vercel AI Gateway (model: ${gatewayModel})` };
+      } catch (err) {
+        ctx.logger.warn(
+          `[AI] Failed to load @ai-sdk/gateway for AI_GATEWAY_MODEL=${gatewayModel}, trying next provider`,
+          err instanceof Error ? { error: err.message } : undefined
+        );
+      }
+    }
+
+    // 2. Direct provider SDKs
+    const providerConfigs: Array<{
+      envKey: string;
+      pkg: string;
+      factory: string;
+      defaultModel: string;
+      displayName: string;
+    }> = [
+      {
+        envKey: 'OPENAI_API_KEY',
+        pkg: '@ai-sdk/openai',
+        factory: 'openai',
+        defaultModel: 'gpt-4o',
+        displayName: 'OpenAI'
+      },
+      {
+        envKey: 'ANTHROPIC_API_KEY',
+        pkg: '@ai-sdk/anthropic',
+        factory: 'anthropic',
+        defaultModel: 'claude-sonnet-4-20250514',
+        displayName: 'Anthropic'
+      },
+      {
+        envKey: 'GOOGLE_GENERATIVE_AI_API_KEY',
+        pkg: '@ai-sdk/google',
+        factory: 'google',
+        defaultModel: 'gemini-2.0-flash',
+        displayName: 'Google'
+      },
+    ];
+
+    for (const { envKey, pkg, factory, defaultModel, displayName } of providerConfigs) {
+      if (process.env[envKey]) {
+        try {
+          const mod = await import(/* webpackIgnore: true */ pkg);
+          const createModel = mod[factory] ?? mod.default;
+          if (typeof createModel === 'function') {
+            const modelId = process.env.AI_MODEL ?? defaultModel;
+            const adapter = new VercelLLMAdapter({ model: createModel(modelId) });
+            return { adapter, description: `${displayName} (model: ${modelId})` };
+          }
+        } catch (err) {
+          ctx.logger.warn(
+            `[AI] Failed to load ${pkg} for ${envKey}, trying next provider`,
+            err instanceof Error ? { error: err.message } : undefined
+          );
+        }
+      }
+    }
+
+    // 3. Fallback to MemoryLLMAdapter
+    ctx.logger.warn('[AI] No LLM provider configured via environment variables. Falling back to MemoryLLMAdapter (echo mode). Set AI_GATEWAY_MODEL, OPENAI_API_KEY, ANTHROPIC_API_KEY, or GOOGLE_GENERATIVE_AI_API_KEY to use a real LLM.');
+    return { adapter: new MemoryLLMAdapter(), description: 'MemoryLLMAdapter (echo mode - for testing only)' };
+  }
+
   async init(ctx: PluginContext): Promise<void> {
     // Check if there is an existing AI service (e.g. from dev-plugin)
     let hasExisting = false;
@@ -87,8 +175,26 @@ export class AIServicePlugin implements Plugin {
       }
     }
 
+    // Determine LLM adapter: explicit > auto-detect from env > MemoryLLMAdapter fallback
+    let adapter: LLMAdapter;
+    let adapterDescription: string;
+
+    if (this.options.adapter) {
+      // User provided an explicit adapter
+      adapter = this.options.adapter;
+      adapterDescription = `${adapter.name} (explicitly configured)`;
+    } else {
+      // Auto-detect from environment variables
+      const detected = await this.detectAdapter(ctx);
+      adapter = detected.adapter;
+      adapterDescription = detected.description;
+    }
+
+    // Log the selected adapter
+    ctx.logger.info(`[AI] Using LLM adapter: ${adapterDescription}`);
+
     const config: AIServiceConfig = {
-      adapter: this.options.adapter,
+      adapter,
       logger: ctx.logger,
       conversationService,
     };
@@ -102,8 +208,8 @@ export class AIServicePlugin implements Plugin {
       ctx.registerService('ai', this.service);
     }
 
-    // Register AI system objects so ObjectQLPlugin auto-discovers them
-    ctx.registerService('app.com.objectstack.service-ai', {
+    // Register AI system objects via the manifest service.
+    ctx.getService<{ register(m: any): void }>('manifest').register({
       id: 'com.objectstack.service-ai',
       name: 'AI Service',
       version: '1.0.0',
@@ -118,36 +224,128 @@ export class AIServicePlugin implements Plugin {
       });
     }
 
+    // Contribute navigation items to the Setup App (if SetupPlugin is loaded).
+    try {
+      const setupNav = ctx.getService<{ contribute(c: any): void }>('setupNav');
+      if (setupNav) {
+        setupNav.contribute({
+          areaId: 'area_ai',
+          items: [
+            { id: 'nav_ai_conversations', type: 'object', label: { key: 'setup.nav.ai_conversations', defaultValue: 'Conversations' }, objectName: 'conversations', icon: 'message-square', order: 10 },
+            { id: 'nav_ai_messages', type: 'object', label: { key: 'setup.nav.ai_messages', defaultValue: 'Messages' }, objectName: 'messages', icon: 'messages-square', order: 20 },
+          ],
+        });
+        ctx.logger.info('[AI] Navigation items contributed to Setup App');
+      }
+    } catch {
+      // SetupPlugin not loaded — skip silently
+    }
+
     ctx.logger.info('[AI] Service initialized');
   }
 
   async start(ctx: PluginContext): Promise<void> {
     if (!this.service) return;
 
-    // ── Auto-register built-in data tools if data engine + metadata are available ──
+    // ── Auto-register built-in tools & agents when services are available ──
+    let metadataService: IMetadataService | undefined;
+    try {
+      metadataService = ctx.getService<IMetadataService>('metadata');
+      console.log('[AI Plugin] Retrieved metadata service:', !!metadataService, 'has getRegisteredTypes:', typeof (metadataService as any)?.getRegisteredTypes);
+    } catch (e: any) {
+      console.log('[AI] Metadata service not available:', e.message);
+      ctx.logger.debug('[AI] Metadata service not available');
+    }
+
+    // Data tools require only the data engine
     try {
       const dataEngine = ctx.getService<IDataEngine>('data');
-      const metadataService = ctx.getService<IMetadataService>('metadata');
-      if (dataEngine && metadataService) {
-        registerDataTools(this.service.toolRegistry, { dataEngine, metadataService });
+      if (dataEngine) {
+        registerDataTools(this.service.toolRegistry, { dataEngine });
         ctx.logger.info('[AI] Built-in data tools registered');
 
-        // Register the built-in data_chat agent only if it does not already exist
-        const agentExists =
-          typeof metadataService.exists === 'function'
-            ? await metadataService.exists('agent', DATA_CHAT_AGENT.name)
-            : false;
-
-        if (!agentExists) {
-          await metadataService.register('agent', DATA_CHAT_AGENT.name, DATA_CHAT_AGENT);
-          ctx.logger.info('[AI] data_chat agent registered');
-        } else {
-          ctx.logger.debug('[AI] data_chat agent already exists, skipping auto-registration');
+        // Register data tools as metadata (for Studio visibility)
+        if (metadataService) {
+          const { DATA_TOOL_DEFINITIONS } = await import('./tools/data-tools.js');
+          for (const toolDef of DATA_TOOL_DEFINITIONS) {
+            const toolExists =
+              typeof metadataService.exists === 'function'
+                ? await metadataService.exists('tool', toolDef.name)
+                : false;
+
+            if (!toolExists) {
+              await metadataService.register('tool', toolDef.name, toolDef);
+            }
+          }
+          ctx.logger.info(`[AI] ${DATA_TOOL_DEFINITIONS.length} data tools registered as metadata`);
+        }
+
+        // Register the built-in data_chat agent (requires metadata service)
+        if (metadataService) {
+          try {
+            const agentExists =
+              typeof metadataService.exists === 'function'
+                ? await metadataService.exists('agent', DATA_CHAT_AGENT.name)
+                : false;
+
+            if (!agentExists) {
+              await metadataService.register('agent', DATA_CHAT_AGENT.name, DATA_CHAT_AGENT);
+              console.log('[AI] Registered data_chat agent to metadataService');
+              ctx.logger.info('[AI] data_chat agent registered');
+            } else {
+              console.log('[AI] data_chat agent already exists, skipping');
+              ctx.logger.debug('[AI] data_chat agent already exists, skipping auto-registration');
+            }
+          } catch (err) {
+            ctx.logger.warn('[AI] Failed to register data_chat agent', err instanceof Error ? { error: err.message, stack: err.stack } : { error: String(err) });
+          }
         }
       }
     } catch {
-      // Data engine or metadata service not available — skip data tools
-      ctx.logger.debug('[AI] Data engine or metadata service not available, skipping data tools');
+      ctx.logger.debug('[AI] Data engine not available, skipping data tools');
+    }
+
+    // Metadata tools require only the metadata service
+    if (metadataService) {
+      try {
+        registerMetadataTools(this.service.toolRegistry, { metadataService });
+        ctx.logger.info('[AI] Built-in metadata tools registered');
+
+        // Register metadata tools as metadata (for Studio visibility)
+        const { METADATA_TOOL_DEFINITIONS } = await import('./tools/metadata-tools.js');
+        for (const toolDef of METADATA_TOOL_DEFINITIONS) {
+          const toolExists =
+            typeof metadataService.exists === 'function'
+              ? await metadataService.exists('tool', toolDef.name)
+              : false;
+
+          if (!toolExists) {
+            await metadataService.register('tool', toolDef.name, toolDef);
+          }
+        }
+        ctx.logger.info(`[AI] ${METADATA_TOOL_DEFINITIONS.length} metadata tools registered as metadata`);
+
+        // Register the built-in metadata_assistant agent
+        try {
+          const agentExists =
+            typeof metadataService.exists === 'function'
+              ? await metadataService.exists('agent', METADATA_ASSISTANT_AGENT.name)
+              : false;
+
+          if (!agentExists) {
+            await metadataService.register('agent', METADATA_ASSISTANT_AGENT.name, METADATA_ASSISTANT_AGENT);
+            console.log('[AI] Registered metadata_assistant agent to metadataService');
+            ctx.logger.info('[AI] metadata_assistant agent registered');
+          } else {
+            console.log('[AI] metadata_assistant agent already exists, skipping');
+            ctx.logger.debug('[AI] metadata_assistant agent already exists, skipping auto-registration');
+          }
+        } catch (err) {
+          ctx.logger.warn('[AI] Failed to register metadata_assistant agent', err instanceof Error ? { error: err.message, stack: err.stack } : { error: String(err) });
+        }
+      } catch (err) {
+        ctx.logger.debug('[AI] Failed to register metadata tools', err instanceof Error ? err : undefined);
+      }
     }
 
     // Trigger hook to notify AI service is ready — other plugins can register tools
@@ -156,21 +354,30 @@ export class AIServicePlugin implements Plugin {
     // Build and expose route definitions
     const routes = buildAIRoutes(this.service, this.service.conversationService, ctx.logger);
 
+    // Build tool routes
+    const toolRoutes = buildToolRoutes(this.service, ctx.logger);
+    routes.push(...toolRoutes);
+    ctx.logger.info(`[AI] Tool routes registered (${toolRoutes.length} routes)`);
+
     // Build agent routes if metadata service is available
-    try {
-      const metadataService = ctx.getService<IMetadataService>('metadata');
-      if (metadataService) {
-        const agentRuntime = new AgentRuntime(metadataService);
-        const agentRoutes = buildAgentRoutes(this.service, agentRuntime, ctx.logger);
-        routes.push(...agentRoutes);
-      }
-    } catch {
+    if (metadataService) {
+      const agentRuntime = new AgentRuntime(metadataService);
+      const agentRoutes = buildAgentRoutes(this.service, agentRuntime, ctx.logger);
+      routes.push(...agentRoutes);
+      ctx.logger.info(`[AI] Agent routes registered (${agentRoutes.length} routes)`);
+    } else {
       ctx.logger.debug('[AI] Metadata service not available, skipping agent routes');
     }
 
     // Trigger hook so HTTP server plugins can mount these routes
     await ctx.trigger('ai:routes', routes);
 
+    // Cache routes on the kernel so HttpDispatcher can find them
+    const kernel = ctx.getKernel();
+    if (kernel) {
+      (kernel as any).__aiRoutes = routes;
+    }
+
     ctx.logger.info(
       `[AI] Service started — adapter="${this.service.adapterName}", ` +
       `tools=${this.service.toolRegistry.size}, ` +

package/src/routes/agent-routes.ts

@@ -1,10 +1,12 @@
 // Copyright (c) 2025 ObjectStack. Licensed under the Apache-2.0 license.
 
-import type { AIMessage } from '@objectstack/spec/contracts';
+import type { ModelMessage } from '@objectstack/spec/contracts';
 import type { Logger } from '@objectstack/spec/contracts';
 import type { AIService } from '../ai-service.js';
 import type { AgentRuntime, AgentChatContext } from '../agent-runtime.js';
 import type { RouteDefinition } from './ai-routes.js';
+import { normalizeMessage, validateMessageContent } from './message-utils.js';
+import { encodeVercelDataStream } from '../stream/vercel-stream-encoder.js';
 
 /**
  * Allowed message roles for the agent chat endpoint.
@@ -25,10 +27,10 @@ function validateAgentMessage(raw: unknown): string | null {
   if (typeof msg.role !== 'string' || !ALLOWED_AGENT_ROLES.has(msg.role)) {
     return `message.role must be one of ${[...ALLOWED_AGENT_ROLES].map(r => `"${r}"`).join(', ')} for agent chat`;
   }
-  if (typeof msg.content !== 'string') {
-    return 'message.content must be a string';
-  }
-  return null;
+
+  // Assistant messages may legitimately have empty content (e.g. tool-call-only)
+  const allowEmpty = msg.role === 'assistant';
+  return validateMessageContent(msg, { allowEmptyContent: allowEmpty });
 }
 
 /**
@@ -36,6 +38,7 @@ function validateAgentMessage(raw: unknown): string | null {
  *
  * | Method | Path | Description |
  * |:---|:---|:---|
+ * | GET  | /api/v1/ai/agents | List all active agents |
  * | POST | /api/v1/ai/agents/:agentName/chat | Chat with a specific agent |
  */
 export function buildAgentRoutes(
@@ -44,10 +47,37 @@ export function buildAgentRoutes(
   logger: Logger,
 ): RouteDefinition[] {
   return [
+    // ── List active agents ──────────────────────────────────────
+    {
+      method: 'GET',
+      path: '/api/v1/ai/agents',
+      description: 'List all active AI agents',
+      auth: true,
+      permissions: ['ai:chat'],
+      handler: async () => {
+        try {
+          const agents = await agentRuntime.listAgents();
+          return { status: 200, body: { agents } };
+        } catch (err) {
+          logger.error(
+            '[AI Route] /agents list error',
+            err instanceof Error ? err : undefined,
+          );
+          return { status: 500, body: { error: 'Internal AI service error' } };
+        }
+      },
+    },
+
+    // ── Chat with a specific agent ──────────────────────────────
+    //
+    // Dual-mode endpoint matching the general chat route behaviour:
+    //   • `stream !== false` → Vercel Data Stream Protocol (SSE)
+    //   • `stream === false`  → JSON response (legacy)
+    //
     {
       method: 'POST',
       path: '/api/v1/ai/agents/:agentName/chat',
-      description: 'Chat with a specific AI agent',
+      description: 'Chat with a specific AI agent (supports Vercel AI Data Stream Protocol)',
       auth: true,
       permissions: ['ai:chat', 'ai:agents'],
       handler: async (req) => {
@@ -57,11 +87,12 @@ export function buildAgentRoutes(
         }
 
         // Parse request body
+        const body = (req.body ?? {}) as Record<string, unknown>;
         const {
           messages: rawMessages,
           context: chatContext,
           options: extraOptions,
-        } = (req.body ?? {}) as {
+        } = body as {
           messages?: unknown[];
           context?: AgentChatContext;
           options?: Record<string, unknown>;
@@ -109,17 +140,42 @@ export function buildAgentRoutes(
           const mergedOptions = { ...agentOptions, ...safeOverrides };
 
           // Prepend system messages then user conversation
-          const fullMessages: AIMessage[] = [
+          const fullMessages: ModelMessage[] = [
             ...systemMessages,
-            ...(rawMessages as AIMessage[]),
+            ...rawMessages.map(m => normalizeMessage(m as Record<string, unknown>)),
           ];
 
-          // Use chatWithTools for automatic tool resolution
-          const result = await aiService.chatWithTools(fullMessages, {
+          const chatWithToolsOptions = {
             ...mergedOptions,
             maxIterations: agent.planning?.maxIterations,
-          });
+          };
+
+          // ── Choose response mode ─────────────────────────────
+          const wantStream = body.stream !== false;
+
+          if (wantStream) {
+            // Vercel Data Stream Protocol (SSE) — matches general chat behaviour
+            if (!aiService.streamChatWithTools) {
+              return { status: 501, body: { error: 'Streaming is not supported by the configured AI service' } };
+            }
+            const events = aiService.streamChatWithTools(fullMessages, chatWithToolsOptions);
+            return {
+              status: 200,
+              stream: true,
+              vercelDataStream: true,
+              contentType: 'text/event-stream',
+              headers: {
+                'Content-Type': 'text/event-stream',
+                'Cache-Control': 'no-cache',
+                'Connection': 'keep-alive',
+                'x-vercel-ai-ui-message-stream': 'v1',
+              },
+              events: encodeVercelDataStream(events),
+            };
+          }
 
+          // JSON response (non-streaming / legacy)
+          const result = await aiService.chatWithTools(fullMessages, chatWithToolsOptions);
           return { status: 200, body: result };
         } catch (err) {
           logger.error(