@nocobase/ai 2.1.0-beta.2 → 2.1.0-beta.20

package/src/__tests__/mcp.test.ts

@@ -0,0 +1,105 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { createMockServer, MockServer } from '@nocobase/test';
+import path from 'path';
+import { AIManager } from '../ai-manager';
+import { MCPLoader } from '../loader';
+import { MCPManager } from '../mcp-manager';
+
+describe('MCP loader test cases', () => {
+  const basePath = path.resolve(__dirname, 'resource', 'ai');
+  let app: MockServer;
+  let aiManager: AIManager;
+  let mcpManager: MCPManager;
+  let loader: MCPLoader;
+
+  beforeEach(async () => {
+    app = await createMockServer({
+      plugins: ['nocobase'],
+    });
+    await app.pm.enable('ai');
+    aiManager = app.aiManager;
+    mcpManager = aiManager.mcpManager;
+    loader = new MCPLoader(aiManager, {
+      scan: {
+        basePath,
+        pattern: ['**/mcp/*.ts', '!**/mcp/*.d.ts'],
+      },
+    });
+  });
+
+  afterEach(async () => {
+    await app.destroy();
+  });
+
+  it('should load mcp definitions in mcp root directory', async () => {
+    await loader.load();
+
+    const entry = await mcpManager.getMCP('weather');
+    expect(entry).toBeDefined();
+    expect(entry.name).toBe('weather');
+    expect(entry.enabled).toBe(true);
+    expect(entry.transport).toBe('http');
+    expect(entry.url).toBe('http://localhost:8123/mcp');
+    expect(entry.headers).toEqual({
+      Authorization: 'Bearer test-token',
+    });
+    expect(entry.env).toEqual({
+      MCP_ENV: 'test',
+    });
+    expect(entry.args).toEqual(['--foo']);
+    expect(entry.restart).toEqual({
+      enabled: true,
+    });
+
+    const enabledEntries = await mcpManager.listMCP({ enabled: true, transport: 'http', name: 'weath' });
+    expect(enabledEntries.map((item) => item.name)).toEqual(['weather']);
+  });
+
+  it('should expose cached mcp tools and allow updating permissions', async () => {
+    const manager = mcpManager as any;
+    manager.toolsMap = {
+      weather: [
+        {
+          name: 'getForecast',
+          description: 'Get weather forecast',
+        },
+        {
+          name: 'setDefaultCity',
+          description: 'Set default city',
+        },
+      ],
+    };
+
+    const tools = await mcpManager.listMCPTools();
+    expect(tools.weather).toEqual([
+      {
+        name: 'mcp-weather-getForecast',
+        title: 'getForecast',
+        description: 'Get weather forecast',
+        serverName: 'weather',
+        permission: 'ASK',
+      },
+      {
+        name: 'mcp-weather-setDefaultCity',
+        title: 'setDefaultCity',
+        description: 'Set default city',
+        serverName: 'weather',
+        permission: 'ASK',
+      },
+    ]);
+
+    await mcpManager.updateMCPToolPermission('mcp-weather-getForecast', 'ALLOW');
+
+    const updatedTools = await mcpManager.listMCPTools();
+    expect(updatedTools.weather[0].permission).toBe('ALLOW');
+    expect(updatedTools.weather[1].permission).toBe('ASK');
+  });
+});

package/src/__tests__/resource/ai/ai-employees/index-employee/index.ts

@@ -0,0 +1,16 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { defineAIEmployee } from '@nocobase/ai';
+
+export default defineAIEmployee({
+  username: 'index-employee',
+  nickname: 'Index Employee',
+  tools: [],
+});

package/src/__tests__/resource/ai/ai-employees/index-employee/prompt.md

@@ -0,0 +1 @@
+Prompt from markdown file.

package/src/__tests__/resource/ai/ai-employees/named-file-employee.ts

@@ -0,0 +1,16 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { defineAIEmployee } from '@nocobase/ai';
+
+export default defineAIEmployee({
+  username: 'named-file-employee',
+  nickname: 'Named File Employee',
+  tools: [],
+});

package/src/__tests__/resource/ai/ai-employees/with-skills/index.ts

@@ -0,0 +1,16 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { defineAIEmployee } from '@nocobase/ai';
+
+export default defineAIEmployee({
+  username: 'with-skills',
+  nickname: 'With Skills',
+  tools: [],
+});

package/src/__tests__/resource/ai/ai-employees/with-skills/skills/analysis/SKILLS.md

@@ -0,0 +1,6 @@
+---
+name: analysis
+description: analysis skill
+---
+
+Analysis skill content.

package/src/__tests__/resource/ai/ai-employees/with-skills-merge/index.ts

@@ -0,0 +1,17 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { defineAIEmployee } from '@nocobase/ai';
+
+export default defineAIEmployee({
+  username: 'with-skills-merge',
+  nickname: 'With Skills Merge',
+  tools: [],
+  skills: ['configured-skill'],
+});

package/src/__tests__/resource/ai/ai-employees/with-skills-merge/skills/discovered-skill/SKILLS.md

@@ -0,0 +1,6 @@
+---
+name: discovered-skill
+description: discovered skill
+---
+
+Discovered skill content.

package/src/__tests__/resource/ai/ai-employees/with-tools/index.ts

@@ -0,0 +1,16 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { defineAIEmployee } from '@nocobase/ai';
+
+export default defineAIEmployee({
+  username: 'with-tools',
+  nickname: 'With Tools',
+  tools: [],
+});

package/src/__tests__/resource/ai/ai-employees/with-tools/tools/discoveredTool.ts

@@ -0,0 +1,23 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { Context } from '@nocobase/actions';
+import { defineTools } from '@nocobase/ai';
+
+export default defineTools({
+  scope: 'SPECIFIED',
+  definition: {
+    name: 'discoveredTool',
+    description: 'discovered tool',
+    schema: null,
+  },
+  invoke: async (ctx: Context, args: any) => {
+    return { status: 'success' };
+  },
+});

package/src/__tests__/resource/ai/ai-employees/with-tools-merge/index.ts

@@ -0,0 +1,16 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { defineAIEmployee } from '@nocobase/ai';
+
+export default defineAIEmployee({
+  username: 'with-tools-merge',
+  nickname: 'With Tools Merge',
+  tools: [{ name: 'configuredTool', autoCall: true }],
+});

package/src/__tests__/resource/ai/ai-employees/with-tools-merge/tools/discoveredTool.ts

@@ -0,0 +1,23 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { Context } from '@nocobase/actions';
+import { defineTools } from '@nocobase/ai';
+
+export default defineTools({
+  scope: 'SPECIFIED',
+  definition: {
+    name: 'discoveredTool',
+    description: 'discovered tool in merge employee',
+    schema: null,
+  },
+  invoke: async (ctx: Context, args: any) => {
+    return { status: 'success' };
+  },
+});

package/src/__tests__/resource/ai/mcp/weather.ts

@@ -0,0 +1,25 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { defineMCP } from '../../../../index';
+
+export default defineMCP({
+  transport: 'http',
+  url: 'http://localhost:8123/mcp',
+  headers: {
+    Authorization: 'Bearer test-token',
+  },
+  env: {
+    MCP_ENV: 'test',
+  },
+  args: ['--foo'],
+  restart: {
+    enabled: true,
+  },
+});

package/src/__tests__/resource/ai/skills/data-modeling/SKILLS.md

@@ -0,0 +1,24 @@
+---
+name: data-modeling
+description: helps translate business scenarios into normalized database schemas with table declarations and relationship diagrams.
+---
+
+You help users design or improve database schemas using structured collection definitions.
+
+When user decisions are required, always invoke the \`dataModeling-suggestions\` tool to provide selectable options, enabling users to reply quickly and continue the conversation.
+
+# Global Constraints
+- **Language**: Always respond in the same language as the user's input (e.g., if the user asks in Chinese, reply in Chinese).
+- **Tone**: Professional, precise, and helpful.
+- **Interactivity**: Before proceeding to the next step, always ask for the user’s suggestions before taking any action.
+- **Tool usage**:
+  1. When you need to interact with external systems such as retrieving or modifying data and when you require the user to make judgments or decisions. You MUST respond with a tool call.
+  2. When using a tool, if the execution result is a failure or an exception occurs during execution, explain the issue to the user in clear and concise language, combining the tool’s feedback with your own description of the problem.
+- **Data standards**: When defining options or enums, the value part must consist only of letters, underscores, and numbers.
+
+# Available Tools
+- \`dataModeling-getCollectionNames\`: Lists all tables with their internal name and display title. Use this to disambiguate user references.
+- \`dataModeling-getCollectionMetadata\`: Returns detailed field definitions and relationships for specified tables.
+- \`dataModeling-defineCollections\`: Submits new or updated schema definitions to the system. Do not assume success until a tool response is received.
+- \`dataModeling-intentRouter\`: Route intents to appropriate workflow
+- \`dataModeling-suggestions\`: Provide a list of suggested prompts for the user to choose from.

package/src/__tests__/resource/ai/skills/data-modeling/tools/read.ts

@@ -0,0 +1,23 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { Context } from '@nocobase/actions';
+import { defineTools } from '@nocobase/ai';
+
+export default defineTools({
+  scope: 'SPECIFIED',
+  definition: {
+    name: 'read',
+    description: 'read document',
+    schema: null,
+  },
+  invoke: async (ctx: Context, args: any) => {
+    return { status: 'success' };
+  },
+});

package/src/__tests__/resource/ai/skills/data-modeling/tools/search/description.md

@@ -0,0 +1 @@
+# SEARCH

package/src/__tests__/resource/ai/skills/data-modeling/tools/search/index.ts

@@ -0,0 +1,23 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { Context } from '@nocobase/actions';
+import { defineTools } from '@nocobase/ai';
+
+export default defineTools({
+  scope: 'SPECIFIED',
+  definition: {
+    name: 'search',
+    description: 'search document',
+    schema: null,
+  },
+  invoke: async (ctx: Context, args: any) => {
+    return { status: 'success' };
+  },
+});

package/src/__tests__/resource/ai/skills/document/tools/read.ts

@@ -17,7 +17,7 @@ export default defineTools({
     description: 'read document',
     schema: null,
   },
-  invoke: async (ctx: Context, args: any, id: string) => {
+  invoke: async (ctx: Context, args: any) => {
     return { status: 'success' };
   },
 });

package/src/__tests__/resource/ai/skills/document/tools/search/index.ts

@@ -17,7 +17,7 @@ export default defineTools({
     description: 'search document',
     schema: null,
   },
-  invoke: async (ctx: Context, args: any, id: string) => {
+  invoke: async (ctx: Context, args: any) => {
     return { status: 'success' };
   },
 });

package/src/__tests__/resource/ai/tools/desc/index.ts

@@ -17,7 +17,7 @@ export default defineTools({
     description: 'tools with description.md',
     schema: null,
   },
-  invoke: async (ctx: Context, args: any, id: string) => {
+  invoke: async (ctx: Context, args: any) => {
     return { status: 'success' };
   },
 });

package/src/__tests__/resource/ai/tools/group/group1.ts

@@ -17,7 +17,7 @@ export default defineTools({
     description: 'hallow group1',
     schema: null,
   },
-  invoke: async (ctx: Context, args: any, id: string) => {
+  invoke: async (ctx: Context, args: any) => {
     return { status: 'success' };
   },
 });

package/src/__tests__/resource/ai/tools/group/group2.ts

@@ -17,7 +17,7 @@ export default defineTools({
     description: 'hallow group2',
     schema: null,
   },
-  invoke: async (ctx: Context, args: any, id: string) => {
+  invoke: async (ctx: Context, args: any) => {
     return { status: 'success' };
   },
 });

package/src/__tests__/resource/ai/tools/group/group3/index.ts

@@ -17,7 +17,7 @@ export default defineTools({
     description: 'hallow group3',
     schema: null,
   },
-  invoke: async (ctx: Context, args: any, id: string) => {
+  invoke: async (ctx: Context, args: any) => {
     return { status: 'success' };
   },
 });

package/src/__tests__/resource/ai/tools/hallow/index.ts

@@ -17,7 +17,7 @@ export default defineTools({
     description: 'hallow tools',
     schema: null,
   },
-  invoke: async (ctx: Context, args: any, id: string) => {
+  invoke: async (ctx: Context, args: any) => {
     return { status: 'success' };
   },
 });

package/src/__tests__/resource/ai/tools/print.ts

@@ -17,7 +17,7 @@ export default defineTools({
     description: 'print tools',
     schema: null,
   },
-  invoke: async (ctx: Context, args: any, id: string) => {
+  invoke: async (ctx: Context, args: any) => {
     return { status: 'success' };
   },
 });

package/src/__tests__/skills.test.ts

@@ -0,0 +1,55 @@
+/**
+ * This file is part of the NocoBase (R) project.
+ * Copyright (c) 2020-2024 NocoBase Co., Ltd.
+ * Authors: NocoBase Team.
+ *
+ * This project is dual-licensed under AGPL-3.0 and NocoBase Commercial License.
+ * For more information, please refer to: https://www.nocobase.com/agreement.
+ */
+
+import { createMockServer, MockServer } from '@nocobase/test';
+import { SkillsLoader } from '../loader';
+import path from 'path';
+import { AIManager } from '../ai-manager';
+import { SkillsManager } from '../skills-manager';
+import { readFile } from 'fs/promises';
+import matter from 'gray-matter';
+
+describe('Skills loader test cases', () => {
+  const basePath = path.resolve(__dirname, 'resource', 'ai');
+  let app: MockServer;
+  let aiManager: AIManager;
+  let skillsManager: SkillsManager;
+  let loader: SkillsLoader;
+
+  beforeEach(async () => {
+    app = await createMockServer({
+      plugins: ['nocobase'],
+    });
+    // with mysql add ai plugin in createMockServer will occur error with create usersAiEmployees collection at app startup
+    await app.pm.enable('ai');
+    aiManager = app.aiManager;
+    skillsManager = aiManager.skillsManager;
+    loader = new SkillsLoader(aiManager, {
+      scan: { basePath, pattern: ['**/skills/**/SKILLS.md'] },
+    });
+  });
+
+  afterEach(async () => {
+    await app.destroy();
+  });
+
+  it('should load skills in skills root directory ', async () => {
+    await loader.load();
+    const skillsMarkdown = await readFile(path.resolve(basePath, 'skills', 'data-modeling', 'SKILLS.md'), 'utf-8');
+    const { content } = matter(skillsMarkdown);
+    const skills = await skillsManager.getSkills('data-modeling');
+    expect(skills).toBeDefined();
+    expect(skills.name).eq('data-modeling');
+    expect(skills.description).eq(
+      'helps translate business scenarios into normalized database schemas with table declarations and relationship diagrams.',
+    );
+    expect(skills.content).eq(content);
+    expect(skills.tools.sort()).toEqual(['search', 'read'].sort());
+  });
+});

package/src/__tests__/tools.test.ts

@@ -13,6 +13,8 @@ import path from 'path';
 import { AIManager } from '../ai-manager';
 import { ToolsManager } from '../tools-manager';
 
+const normalizeEOL = (value: string) => value.replace(/\r\n?/g, '\n');
+
 describe('Tools loader test cases', () => {
   const basePath = path.join(process.cwd(), 'packages/core/ai/src/__tests__/resource/ai');
   let app: MockServer;
@@ -59,7 +61,7 @@ describe('Tools loader test cases', () => {
     const tools = await toolsManager.getTools('desc');
     expect(tools).toBeDefined();
     expect(tools.definition.name).eq('desc');
-    expect(tools.definition.description).eq('# DESC\n');
+    expect(normalizeEOL(tools.definition.description)).eq('# DESC\n');
     expect(await tools.invoke(null, null, null)).toEqual({ status: 'success' });
     expect(await tools.invoke(null, null, null)).toEqual({ status: 'success' });
   });
@@ -78,7 +80,7 @@ describe('Tools loader test cases', () => {
     const tools = await toolsManager.getTools('search');
     expect(tools).toBeDefined();
     expect(tools.definition.name).eq('search');
-    expect(tools.definition.description).eq('# SEARCH\n');
+    expect(normalizeEOL(tools.definition.description)).eq('# SEARCH\n');
     expect(await tools.invoke(null, null, null)).toEqual({ status: 'success' });
   });
 
@@ -99,7 +101,7 @@ describe('Tools loader test cases', () => {
     const group3 = await toolsManager.getTools('group3');
     expect(group3).toBeDefined();
     expect(group3.definition.name).eq('group3');
-    expect(group3.definition.description).eq('# GROUP3\n');
+    expect(normalizeEOL(group3.definition.description)).eq('# GROUP3\n');
     expect(await group3.invoke(null, null, null)).toEqual({ status: 'success' });
   });