Skip to content

The open alternative to Salesforce, designed for AI.

Add share_record tool to the AI chat (#27144)

Félix Malfaitfac235c0083f
diff --git a/packages/twenty-front/src/modules/ai/constants/action-tool-status-labels.constant.ts b/packages/twenty-front/src/modules/ai/constants/action-tool-status-labels.constant.ts
index c66c557679e..739b1aec432 100644
--- a/packages/twenty-front/src/modules/ai/constants/action-tool-status-labels.constant.ts
+++ b/packages/twenty-front/src/modules/ai/constants/action-tool-status-labels.constant.ts
@@ -23,4 +23,8 @@ export const ACTION_TOOL_STATUS_LABELS: Record<string, ToolStatusLabels> = {
loading: msg`Navigating in the app`,
completed: msg`Navigated in the app`,
},
+ share_record: {
+ loading: msg`Sharing record`,
+ completed: msg`Shared record`,
+ },
};
diff --git a/packages/twenty-server/src/engine/core-modules/record-share/record-share.module.ts b/packages/twenty-server/src/engine/core-modules/record-share/record-share.module.ts
index 9a0b57c24f2..cfe241f88ab 100644
--- a/packages/twenty-server/src/engine/core-modules/record-share/record-share.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/record-share/record-share.module.ts
@@ -30,6 +30,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
RecordShareStorageModule,
ShareWithService,
RecordAccessPolicyService,
+ RecordSharingService,
],
})
export class RecordShareModule {}
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/constants/action-tool-label.constant.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/constants/action-tool-label.constant.ts
index 0b76996f57a..645f89c5280 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/constants/action-tool-label.constant.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/constants/action-tool-label.constant.ts
@@ -15,6 +15,7 @@ export const ACTION_TOOL_IDS = [
'save_campaign',
'create_file_upload',
'complete_file_upload',
+ 'share_record',
] as const;
export type ActionToolId = (typeof ACTION_TOOL_IDS)[number];
@@ -53,4 +54,7 @@ export const ACTION_TOOL_LABELS: Record<ActionToolId, ActionToolLabel> = {
complete_file_upload: {
label: i18nLabel(msg`Complete File Upload`),
},
+ share_record: {
+ label: i18nLabel(msg`Share Record`),
+ },
};
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/__tests__/action-tool.provider.spec.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/__tests__/action-tool.provider.spec.ts
new file mode 100644
index 00000000000..a8ffdc1690f
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/__tests__/action-tool.provider.spec.ts
@@ -0,0 +1,119 @@
+import { type CodeInterpreterService } from 'src/engine/core-modules/code-interpreter/code-interpreter.service';
+import { type I18nService } from 'src/engine/core-modules/i18n/i18n.service';
+import { type UserWorkspaceAuthContext } from 'src/engine/core-modules/auth/types/workspace-auth-context.type';
+import { type ToolProviderContext } from 'src/engine/core-modules/tool-provider/interfaces/tool-provider-context.type';
+import { ActionToolProvider } from 'src/engine/core-modules/tool-provider/providers/action-tool.provider';
+import { type CreateCalendarEventTool } from 'src/engine/core-modules/tool/tools/calendar-tool/create-calendar-event-tool';
+import { type CodeInterpreterTool } from 'src/engine/core-modules/tool/tools/code-interpreter-tool/code-interpreter-tool';
+import { type DraftEmailTool } from 'src/engine/core-modules/tool/tools/email-tool/draft-email-tool';
+import { type FindConnectedAccountsTool } from 'src/engine/core-modules/tool/tools/email-tool/find-connected-accounts-tool';
+import { type SendEmailTool } from 'src/engine/core-modules/tool/tools/email-tool/send-email-tool';
+import { type CompleteFileUploadTool } from 'src/engine/core-modules/tool/tools/file-upload-tool/complete-file-upload-tool';
+import { type CreateFileUploadTool } from 'src/engine/core-modules/tool/tools/file-upload-tool/create-file-upload-tool';
+import { type HttpTool } from 'src/engine/core-modules/tool/tools/http-tool/http-tool';
+import { type NavigateAppTool } from 'src/engine/core-modules/tool/tools/navigate-tool/navigate-app-tool';
+import { type ExtractJsonPathsTool } from 'src/engine/core-modules/tool/tools/output-navigation-tool/extract-json-paths-tool';
+import { type SearchOutputTool } from 'src/engine/core-modules/tool/tools/output-navigation-tool/search-output-tool';
+import { type SearchHelpCenterTool } from 'src/engine/core-modules/tool/tools/search-help-center-tool/search-help-center-tool';
+import { type ShareRecordTool } from 'src/engine/core-modules/tool/tools/share-record-tool/share-record-tool';
+import { type PermissionsService } from 'src/engine/metadata-modules/permissions/permissions.service';
+import { type SaveCampaignTool } from 'src/modules/emailing/tools/save-campaign-tool';
+
+const WORKSPACE_ID = 'workspace-id';
+
+const USER_AUTH_CONTEXT = {
+ type: 'user',
+ workspace: { id: WORKSPACE_ID },
+} as UserWorkspaceAuthContext;
+
+const CONTEXT: ToolProviderContext = {
+ workspaceId: WORKSPACE_ID,
+ roleId: 'role-id',
+ rolePermissionConfig: { unionOf: ['role-id'] },
+ authContext: USER_AUTH_CONTEXT,
+ userId: 'user-id',
+ userWorkspaceId: 'user-workspace-id',
+};
+
+const buildTool = <TTool>(): TTool =>
+ ({
+ description: 'description',
+ inputSchema: {},
+ execute: jest.fn().mockResolvedValue({ success: true, message: 'done' }),
+ }) as unknown as TTool;
+
+const buildProvider = ({
+ isRecordSharingEnabled,
+}: {
+ isRecordSharingEnabled: boolean;
+}) => {
+ const shareRecordTool = {
+ ...buildTool<ShareRecordTool>(),
+ isEnabled: jest.fn().mockResolvedValue(isRecordSharingEnabled),
+ } as unknown as ShareRecordTool;
+
+ const provider = new ActionToolProvider(
+ buildTool<HttpTool>(),
+ buildTool<SendEmailTool>(),
+ buildTool<DraftEmailTool>(),
+ buildTool<FindConnectedAccountsTool>(),
+ buildTool<CreateCalendarEventTool>(),
+ buildTool<SearchHelpCenterTool>(),
+ buildTool<CreateFileUploadTool>(),
+ buildTool<CompleteFileUploadTool>(),
+ buildTool<CodeInterpreterTool>(),
+ buildTool<NavigateAppTool>(),
+ buildTool<ExtractJsonPathsTool>(),
+ buildTool<SearchOutputTool>(),
+ buildTool<SaveCampaignTool>(),
+ shareRecordTool,
+ { isEnabled: () => false } as unknown as CodeInterpreterService,
+ {
+ checkRolesPermissions: jest.fn().mockResolvedValue(false),
+ } as unknown as PermissionsService,
+ {
+ translateMessage: ({ messageId }: { messageId: string }) => messageId,
+ } as unknown as I18nService,
+ );
+
+ return { provider, shareRecordTool };
+};
+
+const getToolNames = async (provider: ActionToolProvider) =>
+ (await provider.generateDescriptors(CONTEXT, { includeSchemas: false })).map(
+ (descriptor) => descriptor.name,
+ );
+
+describe('ActionToolProvider', () => {
+ it('lists share_record when record sharing is enabled', async () => {
+ const { provider, shareRecordTool } = buildProvider({
+ isRecordSharingEnabled: true,
+ });
+
+ expect(await getToolNames(provider)).toContain('share_record');
+ expect(shareRecordTool.isEnabled).toHaveBeenCalledWith(WORKSPACE_ID);
+ });
+
+ it('hides share_record when record sharing is disabled', async () => {
+ const { provider } = buildProvider({ isRecordSharingEnabled: false });
+
+ expect(await getToolNames(provider)).not.toContain('share_record');
+ });
+
+ it('passes the auth context of the caller to share_record', async () => {
+ const { provider, shareRecordTool } = buildProvider({
+ isRecordSharingEnabled: true,
+ });
+ const args = { objectNameSingular: 'company' };
+
+ await provider.executeStaticTool('share_record', args, CONTEXT);
+
+ expect(shareRecordTool.execute).toHaveBeenCalledWith(
+ args,
+ expect.objectContaining({
+ workspaceId: WORKSPACE_ID,
+ authContext: USER_AUTH_CONTEXT,
+ }),
+ );
+ });
+});
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/action-tool.provider.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/action-tool.provider.ts
index 6fa5d60db7a..7675645a8c2 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/action-tool.provider.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/action-tool.provider.ts
@@ -33,6 +33,7 @@ import { NavigateAppTool } from 'src/engine/core-modules/tool/tools/navigate-too
import { ExtractJsonPathsTool } from 'src/engine/core-modules/tool/tools/output-navigation-tool/extract-json-paths-tool';
import { SearchOutputTool } from 'src/engine/core-modules/tool/tools/output-navigation-tool/search-output-tool';
import { SearchHelpCenterTool } from 'src/engine/core-modules/tool/tools/search-help-center-tool/search-help-center-tool';
+import { ShareRecordTool } from 'src/engine/core-modules/tool/tools/share-record-tool/share-record-tool';
import { type ToolOutput } from 'src/engine/core-modules/tool/types/tool-output.type';
import { type Tool } from 'src/engine/core-modules/tool/types/tool.type';
import { PermissionsService } from 'src/engine/metadata-modules/permissions/permissions.service';
@@ -58,6 +59,7 @@ export class ActionToolProvider implements ToolProvider {
private readonly extractJsonPathsTool: ExtractJsonPathsTool,
private readonly searchOutputTool: SearchOutputTool,
private readonly saveCampaignTool: SaveCampaignTool,
+ private readonly shareRecordTool: ShareRecordTool,
private readonly codeInterpreterService: CodeInterpreterService,
private readonly permissionsService: PermissionsService,
private readonly i18nService: I18nService,
@@ -76,6 +78,7 @@ export class ActionToolProvider implements ToolProvider {
['extract_json_paths', this.extractJsonPathsTool],
['search_output', this.searchOutputTool],
['save_campaign', this.saveCampaignTool],
+ ['share_record', this.shareRecordTool],
]);
}
@@ -229,6 +232,17 @@ export class ActionToolProvider implements ToolProvider {
),
);
+ if (await this.shareRecordTool.isEnabled(context.workspaceId)) {
+ descriptors.push(
+ this.buildDescriptor(
+ 'share_record',
+ this.shareRecordTool,
+ includeSchemas,
+ context.locale,
+ ),
+ );
+ }
+
const hasCodeInterpreterPermission =
this.codeInterpreterService.isEnabled() &&
(await this.permissionsService.checkRolesPermissions(
@@ -270,6 +284,7 @@ export class ActionToolProvider implements ToolProvider {
userWorkspaceId: context.userWorkspaceId,
threadId: context.threadId,
rolePermissionConfig: context.rolePermissionConfig,
+ authContext: context.authContext,
onCodeExecutionUpdate: context.onCodeExecutionUpdate,
});
}
diff --git a/packages/twenty-server/src/engine/core-modules/tool/tool.module.ts b/packages/twenty-server/src/engine/core-modules/tool/tool.module.ts
index 57585112aee..2d83f1f0c35 100644
--- a/packages/twenty-server/src/engine/core-modules/tool/tool.module.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool/tool.module.ts
@@ -6,6 +6,7 @@ import { FeatureFlagModule } from 'src/engine/core-modules/feature-flag/feature-
import { FileEntity } from 'src/engine/core-modules/file/entities/file.entity';
import { FileModule } from 'src/engine/core-modules/file/file.module';
import { JwtModule } from 'src/engine/core-modules/jwt/jwt.module';
+import { RecordShareModule } from 'src/engine/core-modules/record-share/record-share.module';
import { SecureHttpClientModule } from 'src/engine/core-modules/secure-http-client/secure-http-client.module';
import { CreateCalendarEventTool } from 'src/engine/core-modules/tool/tools/calendar-tool/create-calendar-event-tool';
import { CodeInterpreterTool } from 'src/engine/core-modules/tool/tools/code-interpreter-tool/code-interpreter-tool';
@@ -20,6 +21,7 @@ import { NavigateAppTool } from 'src/engine/core-modules/tool/tools/navigate-too
import { ExtractJsonPathsTool } from 'src/engine/core-modules/tool/tools/output-navigation-tool/extract-json-paths-tool';
import { SearchOutputTool } from 'src/engine/core-modules/tool/tools/output-navigation-tool/search-output-tool';
import { SearchHelpCenterTool } from 'src/engine/core-modules/tool/tools/search-help-center-tool/search-help-center-tool';
+import { ShareRecordTool } from 'src/engine/core-modules/tool/tools/share-record-tool/share-record-tool';
import { ToolOutputSpillService } from 'src/engine/core-modules/tool/services/tool-output-spill.service';
import { WorkspaceManyOrAllFlatEntityMapsCacheModule } from 'src/engine/metadata-modules/flat-entity/services/workspace-many-or-all-flat-entity-maps-cache.module';
import { ConnectedAccountMetadataModule } from 'src/engine/metadata-modules/connected-account/connected-account-metadata.module';
@@ -42,6 +44,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
FeatureFlagModule,
FileModule,
JwtModule,
+ RecordShareModule,
SecureHttpClientModule,
ObjectMetadataModule,
NavigationMenuItemModule,
@@ -62,6 +65,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
NavigateAppTool,
ExtractJsonPathsTool,
SearchOutputTool,
+ ShareRecordTool,
ToolOutputSpillService,
provideWorkspaceScopedRepository(FileEntity),
],
@@ -79,6 +83,7 @@ import { WorkspaceCacheModule } from 'src/engine/workspace-cache/workspace-cache
NavigateAppTool,
ExtractJsonPathsTool,
SearchOutputTool,
+ ShareRecordTool,
ToolOutputSpillService,
],
})
diff --git a/packages/twenty-server/src/engine/core-modules/tool/tools/share-record-tool/__tests__/share-record-tool.spec.ts b/packages/twenty-server/src/engine/core-modules/tool/tools/share-record-tool/__tests__/share-record-tool.spec.ts
new file mode 100644
index 00000000000..edca9b2aada
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/tool/tools/share-record-tool/__tests__/share-record-tool.spec.ts
@@ -0,0 +1,207 @@
+import { Test, type TestingModule } from '@nestjs/testing';
+
+import { RecordShareAccessLevel } from 'twenty-shared/types';
+
+import {
+ type UserWorkspaceAuthContext,
+ type WorkspaceAuthContext,
+} from 'src/engine/core-modules/auth/types/workspace-auth-context.type';
+import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
+import { NotFoundError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
+import {
+ RecordShareException,
+ RecordShareExceptionCode,
+} from 'src/engine/core-modules/record-share/record-share.exception';
+import { RecordSharingService } from 'src/engine/core-modules/record-share/services/record-sharing.service';
+import { ShareRecordTool } from 'src/engine/core-modules/tool/tools/share-record-tool/share-record-tool';
+import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
+
+const WORKSPACE_ID = '20202020-0000-4000-8000-000000000001';
+const COMPANY_OBJECT_METADATA_ID = '20202020-0000-4000-8000-000000000002';
+const RECORD_ID = '20202020-0000-4000-8000-000000000003';
+const WORKSPACE_MEMBER_ID = '20202020-0000-4000-8000-000000000004';
+const ROLE_ID = '20202020-0000-4000-8000-000000000005';
+
+const USER_AUTH_CONTEXT = {
+ type: 'user',
+ workspace: { id: WORKSPACE_ID },
+} as UserWorkspaceAuthContext;
+
+const FLAT_OBJECT_METADATA_MAPS = {
+ byUniversalIdentifier: {
+ company: {
+ id: COMPANY_OBJECT_METADATA_ID,
+ nameSingular: 'company',
+ namePlural: 'companies',
+ },
+ },
+};
+
+describe('ShareRecordTool', () => {
+ let tool: ShareRecordTool;
+ let isFeatureEnabled: jest.Mock;
+ let setShare: jest.Mock;
+
+ beforeEach(async () => {
+ isFeatureEnabled = jest.fn().mockResolvedValue(true);
+ setShare = jest.fn().mockResolvedValue({});
+
+ const module: TestingModule = await Test.createTestingModule({
+ providers: [
+ ShareRecordTool,
+ {
+ provide: FeatureFlagService,
+ useValue: { isFeatureEnabled },
+ },
+ {
+ provide: WorkspaceCacheService,
+ useValue: {
+ getOrRecompute: jest.fn().mockResolvedValue({
+ flatObjectMetadataMaps: FLAT_OBJECT_METADATA_MAPS,
+ }),
+ },
+ },
+ {
+ provide: RecordSharingService,
+ useValue: { setShare },
+ },
+ ],
+ }).compile();
+
+ tool = module.get(ShareRecordTool);
+ });
+
+ const execute = (
+ input: Record<string, unknown>,
+ authContext: WorkspaceAuthContext | undefined = USER_AUTH_CONTEXT,
+ ) =>
+ tool.execute(
+ { objectNameSingular: 'company', recordId: RECORD_ID, ...input },
+ { workspaceId: WORKSPACE_ID, authContext },
+ );
+
+ it('shares the record with a workspace member', async () => {
+ const result = await execute({
+ workspaceMemberId: WORKSPACE_MEMBER_ID,
+ accessLevel: RecordShareAccessLevel.READ_WRITE,
+ });
+
+ expect(result.success).toBe(true);
+ expect(setShare).toHaveBeenCalledWith({
+ objectMetadataId: COMPANY_OBJECT_METADATA_ID,
+ recordId: RECORD_ID,
+ principal: { workspaceMemberId: WORKSPACE_MEMBER_ID, roleId: undefined },
+ accessLevel: RecordShareAccessLevel.READ_WRITE,
+ authContext: USER_AUTH_CONTEXT,
+ });
+ });
+
+ it('defaults to read access when sharing with a role', async () => {
+ const result = await execute({ roleId: ROLE_ID });
+
+ expect(result.success).toBe(true);
+ expect(setShare).toHaveBeenCalledWith(
+ expect.objectContaining({
+ principal: { workspaceMemberId: undefined, roleId: ROLE_ID },
+ accessLevel: RecordShareAccessLevel.READ,
+ }),
+ );
+ });
+
+ it('treats a null principal as unset', async () => {
+ const result = await execute({
+ workspaceMemberId: WORKSPACE_MEMBER_ID,
+ roleId: null,
+ });
+
+ expect(result.success).toBe(true);
+ expect(setShare).toHaveBeenCalledWith(
+ expect.objectContaining({
+ principal: {
+ workspaceMemberId: WORKSPACE_MEMBER_ID,
+ roleId: undefined,
+ },
+ }),
+ );
+ });
+
+ it('refuses to share when record sharing is not enabled', async () => {
+ isFeatureEnabled.mockResolvedValue(false);
+
+ const result = await execute({ workspaceMemberId: WORKSPACE_MEMBER_ID });
+
+ expect(result.success).toBe(false);
+ expect(setShare).not.toHaveBeenCalled();
+ });
+
+ it.each([
+ [{}],
+ [{ workspaceMemberId: null, roleId: null }],
+ [{ workspaceMemberId: WORKSPACE_MEMBER_ID, roleId: ROLE_ID }],
+ [
+ {
+ workspaceMemberId: WORKSPACE_MEMBER_ID,
+ accessLevel: RecordShareAccessLevel.NONE,
+ },
+ ],
+ ])('rejects invalid input %j', async (input) => {
+ const result = await execute(input);
+
+ expect(result.success).toBe(false);
+ expect(setShare).not.toHaveBeenCalled();
+ });
+
+ it('refuses to share without a user', async () => {
+ const result = await execute({ workspaceMemberId: WORKSPACE_MEMBER_ID }, {
+ type: 'apiKey',
+ } as WorkspaceAuthContext);
+
+ expect(result.success).toBe(false);
+ expect(setShare).not.toHaveBeenCalled();
+ });
+
+ it('fails on an unknown object', async () => {
+ const result = await execute({
+ objectNameSingular: 'unknown',
+ workspaceMemberId: WORKSPACE_MEMBER_ID,
+ });
+
+ expect(result.success).toBe(false);
+ expect(result.error).toContain('unknown');
+ expect(setShare).not.toHaveBeenCalled();
+ });
+
+ it('reports record sharing errors as a failed output', async () => {
+ setShare.mockRejectedValueOnce(
+ new RecordShareException(
+ 'shareWith names a role that does not belong to this workspace',
+ RecordShareExceptionCode.INVALID_SHARE_WITH,
+ ),
+ );
+
+ const result = await execute({ roleId: ROLE_ID });
+
+ expect(result.success).toBe(false);
+ expect(result.error).toContain('does not belong to this workspace');
+ });
+
+ it('rethrows internal record sharing errors', async () => {
+ const internalError = new RecordShareException(
+ 'Transaction scope mismatch',
+ RecordShareExceptionCode.TRANSACTION_SCOPE_WORKSPACE_MISMATCH,
+ );
+
+ setShare.mockRejectedValueOnce(internalError);
+
+ await expect(execute({ roleId: ROLE_ID })).rejects.toBe(internalError);
+ });
+
+ it('reports a record the caller cannot manage as a failed output', async () => {
+ setShare.mockRejectedValueOnce(new NotFoundError('Record not found'));
+
+ const result = await execute({ workspaceMemberId: WORKSPACE_MEMBER_ID });
+
+ expect(result.success).toBe(false);
+ expect(result.error).toContain('not allowed to manage its sharing');
+ });
+});
diff --git a/packages/twenty-server/src/engine/core-modules/tool/tools/share-record-tool/share-record-tool.schema.ts b/packages/twenty-server/src/engine/core-modules/tool/tools/share-record-tool/share-record-tool.schema.ts
new file mode 100644
index 00000000000..009b8881591
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/tool/tools/share-record-tool/share-record-tool.schema.ts
@@ -0,0 +1,46 @@
+import { RecordShareAccessLevel } from 'twenty-shared/types';
+import { isDefined } from 'twenty-shared/utils';
+import { z } from 'zod';
+
+export const ShareRecordToolInputZodSchema = z
+ .object({
+ objectNameSingular: z
+ .string()
+ .describe(
+ 'The singular name of the object the record belongs to (e.g. "company", "person", "opportunity")',
+ ),
+ recordId: z.string().uuid().describe('The id of the record to share'),
+ workspaceMemberId: z
+ .string()
+ .uuid()
+ .nullish()
+ .describe(
+ 'The id of the workspace member to share the record with. Find it with find_many_workspace_members. Set either workspaceMemberId or roleId, not both.',
+ ),
+ roleId: z
+ .string()
+ .uuid()
+ .nullish()
+ .describe(
+ 'The id of the role whose members the record is shared with. Find it with list_roles. Set either workspaceMemberId or roleId, not both.',
+ ),
+ accessLevel: z
+ .enum([
+ RecordShareAccessLevel.READ,
+ RecordShareAccessLevel.READ_WRITE,
+ RecordShareAccessLevel.FULL,
+ ])
+ .default(RecordShareAccessLevel.READ)
+ .describe(
+ 'READ to view the record, READ_WRITE to also edit it, FULL to also manage who it is shared with. Defaults to READ.',
+ ),
+ })
+ .refine(
+ ({ workspaceMemberId, roleId }) =>
+ isDefined(workspaceMemberId) !== isDefined(roleId),
+ { message: 'Set exactly one of workspaceMemberId or roleId' },
+ );
+
+export type ShareRecordToolInput = z.infer<
+ typeof ShareRecordToolInputZodSchema
+>;
diff --git a/packages/twenty-server/src/engine/core-modules/tool/tools/share-record-tool/share-record-tool.ts b/packages/twenty-server/src/engine/core-modules/tool/tools/share-record-tool/share-record-tool.ts
new file mode 100644
index 00000000000..cc428db992e
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/tool/tools/share-record-tool/share-record-tool.ts
@@ -0,0 +1,149 @@
+import { Injectable } from '@nestjs/common';
+
+import { FeatureFlagKey } from 'twenty-shared/types';
+import { isDefined } from 'twenty-shared/utils';
+
+import { isUserAuthContext } from 'src/engine/core-modules/auth/guards/is-user-auth-context.guard';
+import { FeatureFlagService } from 'src/engine/core-modules/feature-flag/services/feature-flag.service';
+import { NotFoundError } from 'src/engine/core-modules/graphql/utils/graphql-errors.util';
+import {
+ RecordShareException,
+ RecordShareExceptionCode,
+} from 'src/engine/core-modules/record-share/record-share.exception';
+import { RecordSharingService } from 'src/engine/core-modules/record-share/services/record-sharing.service';
+import { ShareRecordToolInputZodSchema } from 'src/engine/core-modules/tool/tools/share-record-tool/share-record-tool.schema';
+import { type ToolExecutionContext } from 'src/engine/core-modules/tool/types/tool-execution-context.type';
+import { type ToolInput } from 'src/engine/core-modules/tool/types/tool-input.type';
+import { type ToolOutput } from 'src/engine/core-modules/tool/types/tool-output.type';
+import { type Tool } from 'src/engine/core-modules/tool/types/tool.type';
+import { getObjectMetadataIdByName } from 'src/engine/metadata-modules/flat-object-metadata/utils/get-object-metadata-id-by-name.util';
+import { WorkspaceCacheService } from 'src/engine/workspace-cache/services/workspace-cache.service';
+
+const FAILURE_MESSAGE = 'Failed to share record';
+
+@Injectable()
+export class ShareRecordTool implements Tool {
+ description =
+ 'Share a record with a workspace member or with every member of a role, at a READ, READ_WRITE or FULL access level. Sharing again with the same member or role replaces their access level. Only works on records whose object supports record-level sharing, and only when the caller can manage the sharing of that record.';
+
+ inputSchema = ShareRecordToolInputZodSchema;
+
+ constructor(
+ private readonly featureFlagService: FeatureFlagService,
+ private readonly workspaceCacheService: WorkspaceCacheService,
+ private readonly recordSharingService: RecordSharingService,
+ ) {}
+
+ isEnabled(workspaceId: string): Promise<boolean> {
+ return this.featureFlagService.isFeatureEnabled(
+ FeatureFlagKey.IS_RECORD_LEVEL_SHARING_ENABLED,
+ workspaceId,
+ );
+ }
+
+ async execute(
+ parameters: ToolInput,
+ context: ToolExecutionContext,
+ ): Promise<ToolOutput> {
+ if (!(await this.isEnabled(context.workspaceId))) {
+ return {
+ success: false,
+ message: FAILURE_MESSAGE,
+ error: 'Record sharing is not enabled in this workspace',
+ };
+ }
+
+ const parseResult = ShareRecordToolInputZodSchema.safeParse(parameters);
+
+ if (!parseResult.success) {
+ return {
+ success: false,
+ message: FAILURE_MESSAGE,
+ error: parseResult.error.message,
+ };
+ }
+
+ const { authContext } = context;
+
+ if (!isDefined(authContext) || !isUserAuthContext(authContext)) {
+ return {
+ success: false,
+ message: FAILURE_MESSAGE,
+ error: 'Sharing a record requires a signed-in user',
+ };
+ }
+
+ const {
+ objectNameSingular,
+ recordId,
+ workspaceMemberId,
+ roleId,
+ accessLevel,
+ } = parseResult.data;
+
+ const { flatObjectMetadataMaps } =
+ await this.workspaceCacheService.getOrRecompute(context.workspaceId, [
+ 'flatObjectMetadataMaps',
+ ]);
+
+ const objectMetadataId = getObjectMetadataIdByName({
+ flatObjectMetadataMaps,
+ objectName: objectNameSingular,
+ });
+
+ if (!isDefined(objectMetadataId)) {
+ return {
+ success: false,
+ message: FAILURE_MESSAGE,
+ error: `Object "${objectNameSingular}" not found`,
+ };
+ }
+
+ try {
+ await this.recordSharingService.setShare({
+ objectMetadataId,
+ recordId,
+ principal: {
+ workspaceMemberId: workspaceMemberId ?? undefined,
+ roleId: roleId ?? undefined,
+ },
+ accessLevel,
+ authContext,
+ });
+ } catch (error) {
+ if (
+ error instanceof RecordShareException &&
+ error.code === RecordShareExceptionCode.INVALID_SHARE_WITH
+ ) {
+ return {
+ success: false,
+ message: FAILURE_MESSAGE,
+ error: error.message,
+ };
+ }
+
+ if (error instanceof NotFoundError) {
+ return {
+ success: false,
+ message: FAILURE_MESSAGE,
+ error:
+ 'Record not found, its object does not support record-level sharing, or you are not allowed to manage its sharing',
+ };
+ }
+
+ throw error;
+ }
+
+ return {
+ success: true,
+ message: `Shared ${objectNameSingular} record with ${isDefined(workspaceMemberId) ? 'workspace member' : 'role'} at ${accessLevel} access`,
+ result: {
+ objectNameSingular,
+ recordId,
+ workspaceMemberId,
+ roleId,
+ accessLevel,
+ },
+ };
+ }
+}
diff --git a/packages/twenty-server/src/engine/core-modules/tool/types/tool-execution-context.type.ts b/packages/twenty-server/src/engine/core-modules/tool/types/tool-execution-context.type.ts
index 205f57c2f53..28e5d90c36b 100644
--- a/packages/twenty-server/src/engine/core-modules/tool/types/tool-execution-context.type.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool/types/tool-execution-context.type.ts
@@ -1,3 +1,4 @@
+import { type WorkspaceAuthContext } from 'src/engine/core-modules/auth/types/workspace-auth-context.type';
import { type CodeExecutionStreamEmitter } from 'src/engine/core-modules/tool-provider/interfaces/code-execution-stream-emitter.type';
import { type RolePermissionConfig } from 'src/engine/twenty-orm/types/role-permission-config.type';
@@ -7,5 +8,6 @@ export type ToolExecutionContext = {
userWorkspaceId?: string;
threadId?: string;
rolePermissionConfig?: RolePermissionConfig;
+ authContext?: WorkspaceAuthContext;
onCodeExecutionUpdate?: CodeExecutionStreamEmitter;
};
diff --git a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/constants/workflow-agent-excluded-tool-names.const.ts b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/constants/workflow-agent-excluded-tool-names.const.ts
index 94f4beb8bd6..4fddd9b49c0 100644
--- a/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/constants/workflow-agent-excluded-tool-names.const.ts
+++ b/packages/twenty-server/src/engine/metadata-modules/ai/ai-agent-execution/constants/workflow-agent-excluded-tool-names.const.ts
@@ -5,4 +5,6 @@ export const WORKFLOW_AGENT_EXCLUDED_TOOL_NAMES = [
'navigate_app',
'create_file_upload',
'complete_file_upload',
+ // Sharing checks the triggering user's permissions, not the narrower agent role
+ 'share_record',
] as const satisfies readonly ActionToolId[];