Skip to content

The open alternative to Salesforce, designed for AI.

fix(mcp): stop requiring defaulted fields in create tool schemas (#27345)

UDIT_SINGH@076dcede794287
diff --git a/packages/twenty-server/src/engine/core-modules/open-api/utils/components.utils.ts b/packages/twenty-server/src/engine/core-modules/open-api/utils/components.utils.ts
index a592a5f0509..616bac36642 100644
--- a/packages/twenty-server/src/engine/core-modules/open-api/utils/components.utils.ts
+++ b/packages/twenty-server/src/engine/core-modules/open-api/utils/components.utils.ts
@@ -34,6 +34,7 @@ import { type AllFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/
import { findFlatEntityByIdInFlatEntityMaps } from 'src/engine/metadata-modules/flat-entity/utils/find-flat-entity-by-id-in-flat-entity-maps.util';
import { findManyFlatEntityByIdInFlatEntityMapsOrThrow } from 'src/engine/metadata-modules/flat-entity/utils/find-many-flat-entity-by-id-in-flat-entity-maps-or-throw.util';
import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
+import { isFlatFieldMetadataRequiredOnCreate } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-flat-field-metadata-required-on-create.util';
import { type FlatObjectMetadata } from 'src/engine/metadata-modules/flat-object-metadata/types/flat-object-metadata.type';
import { type ObjectMetadataEntity } from 'src/engine/metadata-modules/object-metadata/object-metadata.entity';
import { convertObjectMetadataToSchemaProperties } from 'src/engine/utils/convert-object-metadata-to-schema-properties.util';
@@ -53,7 +54,7 @@ const getSchemaComponentsExample = (
flatFieldMetadatas: FlatFieldMetadata[],
): OpenApiExample => {
return flatFieldMetadatas.reduce((node, field) => {
- if (!field.isNullable && field.defaultValue === null) {
+ if (isFlatFieldMetadataRequiredOnCreate(field)) {
return {
...node,
[field.name]: generateRandomFieldValue({
@@ -177,7 +178,7 @@ const getRequiredFields = (
flatFieldMetadatas: FlatFieldMetadata[],
): string[] => {
return flatFieldMetadatas.reduce((required, field) => {
- if (!field.isNullable && field.defaultValue === null) {
+ if (isFlatFieldMetadataRequiredOnCreate(field)) {
required.push(field.name);
return required;
diff --git a/packages/twenty-server/src/engine/core-modules/record-crud/json-schemas/__tests__/record-properties.json-schema.spec.ts b/packages/twenty-server/src/engine/core-modules/record-crud/json-schemas/__tests__/record-properties.json-schema.spec.ts
index d23f8c68462..a9bb294378d 100644
--- a/packages/twenty-server/src/engine/core-modules/record-crud/json-schemas/__tests__/record-properties.json-schema.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/record-crud/json-schemas/__tests__/record-properties.json-schema.spec.ts
@@ -30,7 +30,7 @@ const FIELDS = [
];
describe('generateRecordPropertiesJsonSchema', () => {
- it('should describe writable fields and require the non-nullable ones', () => {
+ it('should describe writable fields and require the non-nullable ones without a default value', () => {
expect(
generateRecordPropertiesJsonSchema({
objectMetadata: { fields: FIELDS },
@@ -65,4 +65,40 @@ describe('generateRecordPropertiesJsonSchema', () => {
}).properties,
).not.toHaveProperty('name');
});
+
+ it('should not require non-nullable fields that have a default value', () => {
+ expect(
+ generateRecordPropertiesJsonSchema({
+ objectMetadata: {
+ fields: [
+ getToolSchemaFieldMock({
+ name: 'name',
+ type: FieldMetadataType.TEXT,
+ isNullable: false,
+ defaultValue: null,
+ }),
+ getToolSchemaFieldMock({
+ name: 'stage',
+ type: FieldMetadataType.SELECT,
+ isNullable: false,
+ defaultValue: "'NEW'",
+ }),
+ getToolSchemaFieldMock({
+ name: 'position',
+ type: FieldMetadataType.POSITION,
+ isNullable: false,
+ defaultValue: 0,
+ }),
+ getToolSchemaFieldMock({
+ name: 'isAutomaticallyAssigned',
+ type: FieldMetadataType.BOOLEAN,
+ isNullable: false,
+ defaultValue: false,
+ }),
+ ],
+ },
+ definitions: {},
+ }).required,
+ ).toEqual(['name']);
+ });
});
diff --git a/packages/twenty-server/src/engine/core-modules/record-crud/json-schemas/record-properties.json-schema.ts b/packages/twenty-server/src/engine/core-modules/record-crud/json-schemas/record-properties.json-schema.ts
index 1bac1c798a9..eb172b2a2a1 100644
--- a/packages/twenty-server/src/engine/core-modules/record-crud/json-schemas/record-properties.json-schema.ts
+++ b/packages/twenty-server/src/engine/core-modules/record-crud/json-schemas/record-properties.json-schema.ts
@@ -16,6 +16,7 @@ import { referenceJsonSchemaDefinition } from 'src/engine/core-modules/record-cr
import { toToolJsonSchema } from 'src/engine/core-modules/record-crud/utils/to-tool-json-schema.util';
import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
import { isFlatFieldMetadataOfType } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-flat-field-metadata-of-type.util';
+import { isFlatFieldMetadataRequiredOnCreate } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-flat-field-metadata-required-on-create.util';
import { isMorphOrRelationFlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-morph-or-relation-flat-field-metadata.util';
import { computeMorphOrRelationFieldJoinColumnName } from 'src/engine/metadata-modules/field-metadata/utils/compute-morph-or-relation-field-join-column-name.util';
import { isManyToOneFlatFieldMetadata } from 'src/engine/twenty-orm/utils/is-many-to-one-flat-field-metadata.util';
@@ -178,7 +179,7 @@ export const generateRecordPropertiesJsonSchema = ({
continue;
}
- const isRequired = !field.isNullable && !isPartial;
+ const isRequired = !isPartial && isFlatFieldMetadataRequiredOnCreate(field);
if (isMorphOrRelationFlatFieldMetadata(field)) {
if (!isManyToOneFlatFieldMetadata(field)) {
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/is-flat-field-metadata-required-on-create.util.spec.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/is-flat-field-metadata-required-on-create.util.spec.ts
new file mode 100644
index 00000000000..7697d33a420
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/__tests__/is-flat-field-metadata-required-on-create.util.spec.ts
@@ -0,0 +1,33 @@
+import { isFlatFieldMetadataRequiredOnCreate } from 'src/engine/metadata-modules/flat-field-metadata/utils/is-flat-field-metadata-required-on-create.util';
+
+describe('isFlatFieldMetadataRequiredOnCreate', () => {
+ it('should require a non-nullable field without a default value', () => {
+ expect(
+ isFlatFieldMetadataRequiredOnCreate({
+ isNullable: false,
+ defaultValue: null,
+ }),
+ ).toBe(true);
+ });
+
+ it.each([0, false, "''"])(
+ 'should not require a non-nullable field with the default value %p',
+ (defaultValue) => {
+ expect(
+ isFlatFieldMetadataRequiredOnCreate({
+ isNullable: false,
+ defaultValue,
+ }),
+ ).toBe(false);
+ },
+ );
+
+ it.each([true, null])(
+ 'should not require a field whose isNullable is %p',
+ (isNullable) => {
+ expect(
+ isFlatFieldMetadataRequiredOnCreate({ isNullable, defaultValue: null }),
+ ).toBe(false);
+ },
+ );
+});
diff --git a/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/is-flat-field-metadata-required-on-create.util.ts b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/is-flat-field-metadata-required-on-create.util.ts
new file mode 100644
index 00000000000..1d6bfd63783
--- /dev/null
+++ b/packages/twenty-server/src/engine/metadata-modules/flat-field-metadata/utils/is-flat-field-metadata-required-on-create.util.ts
@@ -0,0 +1,9 @@
+import { isDefined } from 'twenty-shared/utils';
+
+import { type FlatFieldMetadata } from 'src/engine/metadata-modules/flat-field-metadata/types/flat-field-metadata.type';
+
+export const isFlatFieldMetadataRequiredOnCreate = (
+ flatFieldMetadata: Pick<FlatFieldMetadata, 'isNullable' | 'defaultValue'>,
+): boolean =>
+ flatFieldMetadata.isNullable === false &&
+ !isDefined(flatFieldMetadata.defaultValue);
diff --git a/packages/twenty-server/test/integration/ai/suites/__snapshots__/mcp-database-tool-input-schemas.integration-spec.ts.snap b/packages/twenty-server/test/integration/ai/suites/__snapshots__/mcp-database-tool-input-schemas.integration-spec.ts.snap
index 51266a158e0..0006b69496b 100644
--- a/packages/twenty-server/test/integration/ai/suites/__snapshots__/mcp-database-tool-input-schemas.integration-spec.ts.snap
+++ b/packages/twenty-server/test/integration/ai/suites/__snapshots__/mcp-database-tool-input-schemas.integration-spec.ts.snap
@@ -40,9 +40,6 @@ exports[`MCP database tool input schemas should list the input schemas of the no
"type": "string",
},
},
- "required": [
- "position",
- ],
"type": "object",
},
"maxItems": 20,
@@ -93,9 +90,6 @@ exports[`MCP database tool input schemas should list the input schemas of the no
"type": "string",
},
},
- "required": [
- "position",
- ],
"type": "object",
}
`;
@@ -1220,9 +1214,6 @@ exports[`MCP database tool input schemas should list the input schemas of the no
"type": "string",
},
},
- "required": [
- "position",
- ],
"type": "object",
},
"maxItems": 20,
@@ -1470,9 +1461,6 @@ exports[`MCP database tool input schemas should list the input schemas of the pe
"type": "object",
},
},
- "required": [
- "position",
- ],
"type": "object",
},
"maxItems": 20,
@@ -1716,9 +1704,6 @@ exports[`MCP database tool input schemas should list the input schemas of the pe
"type": "object",
},
},
- "required": [
- "position",
- ],
"type": "object",
}
`;
@@ -7280,9 +7265,6 @@ exports[`MCP database tool input schemas should list the input schemas of the pe
"type": "object",
},
},
- "required": [
- "position",
- ],
"type": "object",
},
"maxItems": 20,
@@ -7367,9 +7349,6 @@ exports[`MCP database tool input schemas should list the input schemas of the su
"type": "string",
},
},
- "required": [
- "position",
- ],
"type": "object",
},
"maxItems": 20,
@@ -7450,9 +7429,6 @@ exports[`MCP database tool input schemas should list the input schemas of the su
"type": "string",
},
},
- "required": [
- "position",
- ],
"type": "object",
}
`;
@@ -9890,9 +9866,6 @@ exports[`MCP database tool input schemas should list the input schemas of the su
"type": "string",
},
},
- "required": [
- "position",
- ],
"type": "object",
},
"maxItems": 20,