Skip to content

The open alternative to Salesforce, designed for AI.

fix(twenty-server): resolve standardOverrides description in MCP CRUD tool schemas (#23562) (#23606)

Shinu Cherian295dbb0d0e87
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/database-tool.provider.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/database-tool.provider.ts
index 6886abbe75b..ac7339176f8 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/providers/database-tool.provider.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/providers/database-tool.provider.ts
@@ -1,5 +1,6 @@
import { Injectable } from '@nestjs/common';
+import { SOURCE_LOCALE } from 'twenty-shared/translations';
import { camelToSnakeCase, isDefined } from 'twenty-shared/utils';
import { canObjectBeManagedByAutomation } from 'twenty-shared/workflow';
@@ -8,6 +9,7 @@ import { type GenerateDescriptorOptions } from 'src/engine/core-modules/tool-pro
import { type ToolProviderContext } from 'src/engine/core-modules/tool-provider/interfaces/tool-provider-context.type';
import { type ToolProvider } from 'src/engine/core-modules/tool-provider/interfaces/tool-provider.interface';
import { getCrudToolLabels } from 'src/engine/core-modules/tool-provider/utils/get-crud-tool-label.util';
+import { resolveEffectiveFieldDescription } from 'src/engine/core-modules/tool-provider/utils/resolve-effective-field-description.util';
import { getFlatFieldsFromFlatObjectMetadata } from 'src/engine/api/graphql/workspace-schema-builder/utils/get-flat-fields-for-flat-object-metadata.util';
import { generateCreateManyRecordInputSchema } from 'src/engine/core-modules/record-crud/utils/generate-create-many-record-input-schema.util';
@@ -125,6 +127,10 @@ export class DatabaseToolProvider implements ToolProvider {
flatObjectMetadataMaps.byUniversalIdentifier,
);
+ const i18nInstance = this.i18nService.getI18nInstance(
+ context.locale ?? SOURCE_LOCALE,
+ );
+
for (const flatObject of allFlatObjects) {
const permission = objectPermissions[flatObject.id];
const explicitPermission = explicitPermissionByObjectId.get(
@@ -159,7 +165,17 @@ export class DatabaseToolProvider implements ToolProvider {
}
const fields = includeSchemas
- ? getFlatFieldsFromFlatObjectMetadata(flatObject, flatFieldMetadataMaps)
+ ? getFlatFieldsFromFlatObjectMetadata(
+ flatObject,
+ flatFieldMetadataMaps,
+ ).map((flatFieldMetadata) => ({
+ ...flatFieldMetadata,
+ description: resolveEffectiveFieldDescription({
+ flatFieldMetadata,
+ locale: context.locale,
+ i18nInstance,
+ }),
+ }))
: [];
const objectMetadata = { ...flatObject, fields };
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/utils/__tests__/resolve-effective-field-description.util.spec.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/utils/__tests__/resolve-effective-field-description.util.spec.ts
new file mode 100644
index 00000000000..4f907a6ab3e
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/utils/__tests__/resolve-effective-field-description.util.spec.ts
@@ -0,0 +1,109 @@
+import { generateMessageId } from 'twenty-shared/i18n';
+import { SOURCE_LOCALE } from 'twenty-shared/translations';
+import { FieldMetadataType } from 'twenty-shared/types';
+
+import { resolveEffectiveFieldDescription } from 'src/engine/core-modules/tool-provider/utils/resolve-effective-field-description.util';
+import { getFlatFieldMetadataMock } from 'src/engine/metadata-modules/flat-field-metadata/__mocks__/get-flat-field-metadata.mock';
+import { type MessageIdTranslator } from 'src/engine/metadata-modules/utils/message-id-translator.type';
+import { TWENTY_STANDARD_APPLICATION } from 'src/engine/workspace-manager/twenty-standard-application/constants/twenty-standard-applications';
+
+const BASE_DESCRIPTION = 'Task due date';
+const OVERRIDDEN_DESCRIPTION =
+ 'Stored in UTC; users dictate local time, convert before writing';
+
+const buildTranslator = (
+ catalog: Record<string, string> = {},
+): MessageIdTranslator => ({
+ _: (messageId) => catalog[messageId] ?? messageId,
+});
+
+const untranslated = buildTranslator();
+
+const getStandardFlatFieldMetadata = (
+ overrides?: Parameters<typeof getFlatFieldMetadataMock>[0]['overrides'],
+) =>
+ getFlatFieldMetadataMock({
+ universalIdentifier: 'due-at-field',
+ objectMetadataId: 'task-object',
+ type: FieldMetadataType.DATE_TIME,
+ name: 'dueAt',
+ description: BASE_DESCRIPTION,
+ applicationUniversalIdentifier:
+ TWENTY_STANDARD_APPLICATION.universalIdentifier,
+ overrides,
+ });
+
+describe('resolveEffectiveFieldDescription', () => {
+ it('should return the override when a standard field description was customized', () => {
+ const result = resolveEffectiveFieldDescription({
+ flatFieldMetadata: getStandardFlatFieldMetadata({
+ description: OVERRIDDEN_DESCRIPTION,
+ }),
+ locale: SOURCE_LOCALE,
+ i18nInstance: untranslated,
+ });
+
+ expect(result).toBe(OVERRIDDEN_DESCRIPTION);
+ });
+
+ it('should return the base description when the override was cleared', () => {
+ const result = resolveEffectiveFieldDescription({
+ flatFieldMetadata: getStandardFlatFieldMetadata({ description: null }),
+ locale: SOURCE_LOCALE,
+ i18nInstance: untranslated,
+ });
+
+ expect(result).toBe(BASE_DESCRIPTION);
+ });
+
+ it('should return the base description when the field carries no override', () => {
+ const result = resolveEffectiveFieldDescription({
+ flatFieldMetadata: getStandardFlatFieldMetadata(),
+ locale: SOURCE_LOCALE,
+ i18nInstance: untranslated,
+ });
+
+ expect(result).toBe(BASE_DESCRIPTION);
+ });
+
+ it('should return the locale translation of a standard field description', () => {
+ const result = resolveEffectiveFieldDescription({
+ flatFieldMetadata: getStandardFlatFieldMetadata(),
+ locale: 'fr-FR',
+ i18nInstance: buildTranslator({
+ [generateMessageId(BASE_DESCRIPTION)]: "Date d'échéance",
+ }),
+ });
+
+ expect(result).toBe("Date d'échéance");
+ });
+
+ it('should return the override translation for the requested locale', () => {
+ const result = resolveEffectiveFieldDescription({
+ flatFieldMetadata: getStandardFlatFieldMetadata({
+ description: OVERRIDDEN_DESCRIPTION,
+ translations: { 'fr-FR': { description: 'Stocké en UTC' } },
+ }),
+ locale: 'fr-FR',
+ i18nInstance: untranslated,
+ });
+
+ expect(result).toBe('Stocké en UTC');
+ });
+
+ it('should return the description as written for a custom field', () => {
+ const result = resolveEffectiveFieldDescription({
+ flatFieldMetadata: getFlatFieldMetadataMock({
+ universalIdentifier: 'activity-type-field',
+ objectMetadataId: 'task-object',
+ type: FieldMetadataType.TEXT,
+ name: 'activityType',
+ description: 'Our own custom text',
+ }),
+ locale: SOURCE_LOCALE,
+ i18nInstance: untranslated,
+ });
+
+ expect(result).toBe('Our own custom text');
+ });
+});
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/utils/resolve-effective-field-description.util.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/utils/resolve-effective-field-description.util.ts
new file mode 100644
index 00000000000..4a6d826b420
--- /dev/null
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/utils/resolve-effective-field-description.util.ts
@@ -0,0 +1,27 @@
+import { type APP_LOCALES } from 'twenty-shared/translations';
+
+import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
+import { belongsToTwentyStandardApp } from 'src/engine/metadata-modules/utils/belongs-to-twenty-standard-app.util';
+import { type MessageIdTranslator } from 'src/engine/metadata-modules/utils/message-id-translator.type';
+import { resolveEffectiveEntityProperty } from 'src/engine/metadata-modules/utils/resolve-effective-entity-property.util';
+
+export const resolveEffectiveFieldDescription = ({
+ flatFieldMetadata,
+ locale,
+ i18nInstance,
+}: {
+ flatFieldMetadata: FlatFieldMetadata;
+ locale: keyof typeof APP_LOCALES | undefined;
+ i18nInstance: MessageIdTranslator;
+}): string =>
+ resolveEffectiveEntityProperty({
+ metadataName: 'fieldMetadata',
+ baseValue: flatFieldMetadata.description,
+ overrides: flatFieldMetadata.overrides ?? undefined,
+ property: 'description',
+ i18nContext: {
+ locale,
+ i18nInstance,
+ isStandardApp: belongsToTwentyStandardApp(flatFieldMetadata),
+ },
+ });