Merge data navigator and manipulator agents (#15761)

Merge data manipulator and navigator agents
This commit is contained in:
Félix Malfait
2025-11-13 15:25:52 +01:00
committed by GitHub
parent 9bbe0e7f8e
commit f6ed1e8295
14 changed files with 161 additions and 104 deletions
@@ -13,7 +13,7 @@ import { BulkDeleteToolInputSchema } from 'src/engine/core-modules/record-crud/z
import { FindOneToolInputSchema } from 'src/engine/core-modules/record-crud/zod-schemas/find-one-tool.zod-schema';
import { generateFindToolInputSchema } from 'src/engine/core-modules/record-crud/zod-schemas/find-tool.zod-schema';
import { SoftDeleteToolInputSchema } from 'src/engine/core-modules/record-crud/zod-schemas/soft-delete-tool.zod-schema';
import { isWorkflowRunObject } from 'src/engine/metadata-modules/agent/utils/is-workflow-run-object.util';
import { isWorkflowRelatedObject } from 'src/engine/metadata-modules/agent/utils/is-workflow-related-object.util';
import { ObjectMetadataService } from 'src/engine/metadata-modules/object-metadata/object-metadata.service';
import { WorkspacePermissionsCacheService } from 'src/engine/metadata-modules/workspace-permissions-cache/workspace-permissions-cache.service';
import { TwentyORMGlobalManager } from 'src/engine/twenty-orm/twenty-orm-global.manager';
@@ -79,7 +79,7 @@ export class ToolService {
});
const filteredObjectMetadata = allObjectMetadata.filter(
(objectMetadata) => !isWorkflowRunObject(objectMetadata),
(objectMetadata) => !isWorkflowRelatedObject(objectMetadata),
);
filteredObjectMetadata.forEach((objectMetadata) => {
@@ -169,7 +169,7 @@ export class AgentExecutionService implements AgentExecutionContext {
}
}
private async getContextForSystemPrompt(
async getContextForSystemPrompt(
workspace: WorkspaceEntity,
recordIdsByObjectMetadataNameSingular: RecordIdsByObjectMetadataNameSingularType,
userWorkspaceId: string,
@@ -164,6 +164,7 @@ export class AgentStreamingService {
state: 'routed',
debug: {
routingTimeMs: routingTime,
contextBuildTimeMs: timings.contextBuildTimeMs,
agentExecutionStartTimeMs: Date.now() - startTime,
selectedAgentId: agent.id,
selectedAgentLabel: agent.label,
@@ -0,0 +1,39 @@
import { isWorkflowRelatedObject } from 'src/engine/metadata-modules/agent/utils/is-workflow-related-object.util';
import { type ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
describe('isWorkflowRelatedObject', () => {
it('should return true for workflow-related objects', () => {
expect(
isWorkflowRelatedObject({
standardId: STANDARD_OBJECT_IDS.workflow,
} as ObjectMetadataEntity),
).toBe(true);
expect(
isWorkflowRelatedObject({
standardId: STANDARD_OBJECT_IDS.workflowRun,
} as ObjectMetadataEntity),
).toBe(true);
expect(
isWorkflowRelatedObject({
standardId: STANDARD_OBJECT_IDS.workflowVersion,
} as ObjectMetadataEntity),
).toBe(true);
});
it('should return false for non-workflow objects', () => {
expect(
isWorkflowRelatedObject({
standardId: STANDARD_OBJECT_IDS.person,
} as ObjectMetadataEntity),
).toBe(false);
expect(
isWorkflowRelatedObject({
standardId: null,
} as ObjectMetadataEntity),
).toBe(false);
});
});
@@ -0,0 +1,21 @@
import { type ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
// All workflow-related standard object IDs that should be filtered out from agent access
const WORKFLOW_STANDARD_OBJECT_IDS = [
STANDARD_OBJECT_IDS.workflow,
STANDARD_OBJECT_IDS.workflowRun,
STANDARD_OBJECT_IDS.workflowVersion,
STANDARD_OBJECT_IDS.workflowAutomatedTrigger,
] as const;
export const isWorkflowRelatedObject = (
objectMetadata: ObjectMetadataEntity,
): boolean => {
return (
objectMetadata.standardId !== null &&
WORKFLOW_STANDARD_OBJECT_IDS.includes(
objectMetadata.standardId as (typeof WORKFLOW_STANDARD_OBJECT_IDS)[number],
)
);
};
@@ -1,14 +1,21 @@
import { type ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { STANDARD_OBJECT_IDS } from 'src/engine/workspace-manager/workspace-sync-metadata/constants/standard-object-ids';
const WORKFLOW_OBJECT_NAMES = ['workflowVersion', 'workflowRun'];
// All workflow-related standard object IDs that should be filtered out from agent access
const WORKFLOW_STANDARD_OBJECT_IDS = [
STANDARD_OBJECT_IDS.workflow,
STANDARD_OBJECT_IDS.workflowRun,
STANDARD_OBJECT_IDS.workflowVersion,
STANDARD_OBJECT_IDS.workflowAutomatedTrigger,
] as const;
export const isWorkflowRunObject = (
export const isWorkflowRelatedObject = (
objectMetadata: ObjectMetadataEntity,
): boolean => {
if (objectMetadata.standardId) {
return objectMetadata.standardId === STANDARD_OBJECT_IDS.workflowRun;
}
return WORKFLOW_OBJECT_NAMES.includes(objectMetadata.nameSingular);
return (
objectMetadata.standardId !== null &&
WORKFLOW_STANDARD_OBJECT_IDS.includes(
objectMetadata.standardId as (typeof WORKFLOW_STANDARD_OBJECT_IDS)[number],
)
);
};
@@ -4,11 +4,16 @@ import { TypeOrmModule } from '@nestjs/typeorm';
import { AiModule } from 'src/engine/core-modules/ai/ai.module';
import { WorkspaceEntity } from 'src/engine/core-modules/workspace/workspace.entity';
import { AgentEntity } from 'src/engine/metadata-modules/agent/agent.entity';
import { ObjectMetadataModule } from 'src/engine/metadata-modules/object-metadata/object-metadata.module';
import { AiRouterService } from './ai-router.service';
@Module({
imports: [TypeOrmModule.forFeature([AgentEntity, WorkspaceEntity]), AiModule],
imports: [
TypeOrmModule.forFeature([AgentEntity, WorkspaceEntity]),
AiModule,
ObjectMetadataModule,
],
providers: [AiRouterService],
exports: [AiRouterService],
})
@@ -14,6 +14,9 @@ import { type ModelId } from 'src/engine/core-modules/ai/constants/ai-models.con
import { AI_TELEMETRY_CONFIG } from 'src/engine/core-modules/ai/constants/ai-telemetry.const';
import { AiModelRegistryService } from 'src/engine/core-modules/ai/services/ai-model-registry.service';
import { AgentEntity } from 'src/engine/metadata-modules/agent/agent.entity';
import { isWorkflowRelatedObject } from 'src/engine/metadata-modules/agent/utils/is-workflow-related-object.util';
import { ObjectMetadataService } from 'src/engine/metadata-modules/object-metadata/object-metadata.service';
import { DATA_MANIPULATOR_AGENT } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-agents/agents/data-manipulator-agent';
import { HELPER_AGENT } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-agents/agents/helper-agent';
export interface AiRouterContext {
@@ -41,6 +44,7 @@ export class AiRouterService {
@InjectRepository(AgentEntity)
private readonly agentRepository: Repository<AgentEntity>,
private readonly aiModelRegistryService: AiModelRegistryService,
private readonly objectMetadataService: ObjectMetadataService,
) {}
async routeMessage(
@@ -88,7 +92,12 @@ export class AiRouterService {
)?.text || '';
const model = this.getRouterModel(routerModel);
const agentDescriptions = this.buildAgentDescriptions(availableAgents);
const workspaceObjectsList =
await this.buildWorkspaceObjectsList(workspaceId);
const agentDescriptions = this.buildAgentDescriptions(
availableAgents,
workspaceObjectsList,
);
const systemPrompt = this.buildRouterSystemPrompt(agentDescriptions);
const userPrompt = this.buildRouterUserPrompt(
@@ -193,9 +202,55 @@ export class AiRouterService {
return registeredModel.model;
}
private buildAgentDescriptions(agents: AgentEntity[]): string {
private async buildWorkspaceObjectsList(
workspaceId: string,
): Promise<string> {
try {
const objects = await this.objectMetadataService.findManyWithinWorkspace(
workspaceId,
{
where: { isActive: true, isSystem: false },
},
);
const filteredObjects = objects.filter(
(obj) => !isWorkflowRelatedObject(obj),
);
if (filteredObjects.length === 0) {
return '';
}
return filteredObjects
.map((obj) => `- ${obj.labelSingular} (${obj.nameSingular})`)
.join('\n');
} catch (error) {
this.logger.warn('Failed to build workspace objects list:', error);
return '';
}
}
private buildAgentDescriptions(
agents: AgentEntity[],
workspaceObjectsList: string,
): string {
return agents
.map((agent) => `- ${agent.label} (${agent.id}): ${agent.description}`)
.map((agent) => {
const baseDescription = `- ${agent.label} (${agent.id}): ${agent.description}`;
if (
agent.standardId === DATA_MANIPULATOR_AGENT.standardId &&
workspaceObjectsList
) {
return `${baseDescription}
Available workspace objects:
${workspaceObjectsList}`;
}
return baseDescription;
})
.join('\n');
}
@@ -6,17 +6,21 @@ export const DATA_MANIPULATOR_AGENT: StandardAgentDefinition = {
name: 'data-manipulator',
label: 'Data Manipulator',
description:
'AI agent specialized in creating, updating, and managing data across all objects',
'AI agent specialized in exploring, reading, creating, updating, and managing data across all objects',
icon: 'IconEdit',
applicationId: null,
prompt: `You are a Data Manipulator Agent specialized in helping users create, update, and manage data in Twenty.
prompt: `You are a Data Manipulator Agent specialized in helping users explore and manage data in Twenty.
Your capabilities include:
- Creating new records across all standard and custom objects
- Searching and filtering records across all standard and custom objects
- Sorting records by any field using orderBy parameter
- Creating new records across all objects
- Updating existing records based on user requirements
- Managing relationships between records (linking companies to people, etc.)
- Managing relationships between records
- Bulk operations on multiple records
- Data cleanup and organization tasks
- Explaining relationships between different records and objects
- Providing insights about data patterns and trends
- Helping users find specific information quickly
## Important Constraints:
- You have READ and WRITE access to all object records
@@ -25,11 +29,19 @@ Your capabilities include:
- You CANNOT modify workspace settings or permissions
## Best Practices:
- For "top N" or "largest/smallest" queries, ALWAYS use the orderBy parameter with appropriate sorting direction
- Always confirm destructive or bulk operations before executing
- Ask clarifying questions to ensure you understand the user's intent
- Validate data before creating or updating records
- Maintain data consistency and referential integrity
- Provide clear feedback about what operations were performed
- Help users understand their data schema and available fields
## Sorting Examples:
- Top 10 companies by employees: orderBy: [{"employees": "DescNullsLast"}] with limit: 10
- Oldest records first: orderBy: [{"createdAt": "AscNullsFirst"}]
- Sort by name alphabetically: orderBy: [{"name": "AscNullsFirst"}]
- Direction values MUST be: "AscNullsFirst", "AscNullsLast", "DescNullsFirst", or "DescNullsLast"
## When Creating Records:
- Ask about required fields if not provided
@@ -49,7 +61,7 @@ Your capabilities include:
- Help standardize data formats across records
- Recommend best practices for data entry
Be helpful, careful, and always prioritize data integrity while executing user requests efficiently.`,
Be helpful, thorough, and always prioritize data integrity while executing user requests efficiently.`,
modelId: 'auto',
responseFormat: {},
isCustom: false,
@@ -1,60 +0,0 @@
import { type StandardAgentDefinition } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-agents/types/standard-agent-definition.interface';
import { DATA_NAVIGATOR_ROLE } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-roles/roles/data-navigator-role';
export const DATA_NAVIGATOR_AGENT: StandardAgentDefinition = {
standardId: '20202020-0002-0001-0001-000000000002',
name: 'data-navigator',
label: 'Data Navigator',
description:
'AI agent specialized in exploring and reading data across all objects',
icon: 'IconSearch',
applicationId: null,
prompt: `You are a Data Navigator Agent specialized in helping users explore and understand their data in Twenty.
Your capabilities include:
- Searching and filtering records across all standard and custom objects
- Sorting records by any field using orderBy parameter (CRITICAL for "top N" queries)
- Explaining relationships between different records and objects
- Providing insights about data patterns and trends
- Helping users find specific information quickly
- Answering questions about data structure and relationships
## Important Constraints:
- You have READ-ONLY access to data
- You CANNOT create, update, or delete any records
- You CANNOT access workflow-related objects (workflows, workflow versions, workflow runs, etc.)
- When users request modifications, politely explain your read-only limitations
## Best Practices:
- For "top N" or "largest/smallest" queries, ALWAYS use the orderBy parameter with appropriate sorting direction
- Ask clarifying questions to understand what data the user is looking for
- Provide clear, structured information when presenting data
- Explain the context and relationships between records
- Suggest useful filters or queries to refine searches
- Help users understand their data schema and available fields
## Sorting Examples - EXACT FORMAT REQUIRED:
- Top 10 companies by employees: orderBy: [{"employees": "DescNullsLast"}] with limit: 10
- Oldest records first: orderBy: [{"createdAt": "AscNullsFirst"}]
- Sort by name alphabetically: orderBy: [{"name": "AscNullsFirst"}]
- Multiple sort criteria: orderBy: [{"priority": "DescNullsLast"}, {"createdAt": "AscNullsFirst"}]
CRITICAL: Direction values MUST be exactly one of: "AscNullsFirst", "AscNullsLast", "DescNullsFirst", "DescNullsLast"
- Use "DescNullsLast" for descending (NOT "desc", "DESC", or "descending")
- Use "AscNullsFirst" for ascending (NOT "asc", "ASC", or "ascending")
## When Helping Users:
- For queries about "top", "largest", "highest", "best" → ALWAYS use DescNullsLast orderBy
- For queries about "bottom", "smallest", "lowest" → ALWAYS use AscNullsFirst orderBy
- Be proactive in suggesting related data that might be useful
- Explain any patterns or anomalies you notice in the data
- Provide context about record counts, date ranges, and relationships
- Guide users on how to effectively navigate their workspace data
Be helpful, thorough, and always prioritize helping users understand and navigate their data effectively.`,
modelId: 'auto',
responseFormat: {},
isCustom: false,
standardRoleId: DATA_NAVIGATOR_ROLE.standardId,
modelConfiguration: {},
};
@@ -1,12 +1,10 @@
import { DATA_MANIPULATOR_AGENT } from './agents/data-manipulator-agent';
import { DATA_NAVIGATOR_AGENT } from './agents/data-navigator-agent';
import { HELPER_AGENT } from './agents/helper-agent';
import { WORKFLOW_BUILDER_AGENT } from './agents/workflow-builder-agent';
import { type StandardAgentDefinition } from './types/standard-agent-definition.interface';
export const standardAgentDefinitions = [
WORKFLOW_BUILDER_AGENT,
DATA_NAVIGATOR_AGENT,
DATA_MANIPULATOR_AGENT,
HELPER_AGENT,
] as const satisfies StandardAgentDefinition[];
@@ -1,12 +1,10 @@
import { ADMIN_ROLE } from './roles/admin-role';
import { DATA_MANIPULATOR_ROLE } from './roles/data-manipulator-role';
import { DATA_NAVIGATOR_ROLE } from './roles/data-navigator-role';
import { WORKFLOW_MANAGER_ROLE } from './roles/workflow-manager-role';
import { type StandardRoleDefinition } from './types/standard-role-definition.interface';
export const standardRoleDefinitions = [
ADMIN_ROLE,
WORKFLOW_MANAGER_ROLE,
DATA_NAVIGATOR_ROLE,
DATA_MANIPULATOR_ROLE,
] as const satisfies StandardRoleDefinition[];
@@ -1,19 +0,0 @@
import { type StandardRoleDefinition } from 'src/engine/workspace-manager/workspace-sync-metadata/standard-roles/types/standard-role-definition.interface';
export const DATA_NAVIGATOR_ROLE: StandardRoleDefinition = {
standardId: '20202020-0001-0001-0001-000000000003',
label: 'Data Navigator',
description: 'Read-only access to all object records',
icon: 'IconSearch',
isEditable: false,
canUpdateAllSettings: false,
canAccessAllTools: false,
canReadAllObjectRecords: true,
canUpdateAllObjectRecords: false,
canSoftDeleteAllObjectRecords: false,
canDestroyAllObjectRecords: false,
canBeAssignedToUsers: false,
canBeAssignedToAgents: true,
canBeAssignedToApiKeys: false,
applicationId: null, // TODO: Replace with Twenty application ID
};
@@ -90,7 +90,7 @@ describe('roles permissions', () => {
expect(resp.status).toBe(200);
expect(resp.body.errors).toBeUndefined();
expect(resp.body.data.getRoles).toHaveLength(7);
expect(resp.body.data.getRoles.length).toBeGreaterThanOrEqual(5);
const roles = resp.body.data.getRoles;
const guestRole = roles.find((role: any) => role.label === 'Guest');