Skip to content

The open alternative to Salesforce, designed for AI.

Let @DefineTool tools declare a catalog icon (#28612)

Paul Rastoinec647b28b1a2
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/services/__tests__/defined-tool-registry.service.spec.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/services/__tests__/defined-tool-registry.service.spec.ts
index 082dd210fdb..6baf41a4c4a 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/services/__tests__/defined-tool-registry.service.spec.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/services/__tests__/defined-tool-registry.service.spec.ts
@@ -40,11 +40,36 @@ class RenameWebhookTool extends BaseTool<typeof renameWebhookInputSchema> {
}
}
-const buildRenameWebhookTool = ({ isGranted }: { isGranted: boolean }) => {
- const tool = new RenameWebhookTool();
+const archiveWebhookInputSchema = z.object({ id: z.uuid() });
+
+@DefineTool({
+ name: 'archive_webhook',
+ category: ToolCategory.WEBHOOK,
+ description: 'Archive a webhook.',
+ requiredPermissionFlags: [PermissionFlagType.API_KEYS_AND_WEBHOOKS],
+ icon: 'IconWebhook',
+})
+class ArchiveWebhookTool extends BaseTool<typeof archiveWebhookInputSchema> {
+ readonly inputSchema = archiveWebhookInputSchema;
+
+ async execute({
+ input,
+ }: ToolExecuteArgs<typeof archiveWebhookInputSchema>): Promise<ToolOutput> {
+ return { success: true, message: `Webhook ${input.id} archived` };
+ }
+}
+
+const buildDefinedToolRegistryService = ({
+ tools,
+ isGranted,
+}: {
+ tools: BaseTool[];
+ isGranted: boolean;
+}) => {
const definedToolRegistryService = new DefinedToolRegistryService(
{
- getProviders: () => [{ instance: tool, metatype: RenameWebhookTool }],
+ getProviders: () =>
+ tools.map((tool) => ({ instance: tool, metatype: tool.constructor })),
} as unknown as DiscoveryService,
{
checkRolesPermissions: jest.fn().mockResolvedValue(isGranted),
@@ -53,6 +78,16 @@ const buildRenameWebhookTool = ({ isGranted }: { isGranted: boolean }) => {
definedToolRegistryService.onModuleInit();
+ return definedToolRegistryService;
+};
+
+const buildRenameWebhookTool = ({ isGranted }: { isGranted: boolean }) => {
+ const tool = new RenameWebhookTool();
+ const definedToolRegistryService = buildDefinedToolRegistryService({
+ tools: [tool],
+ isGranted,
+ });
+
const definedTool =
definedToolRegistryService.findDefinedTool('rename_webhook');
@@ -62,6 +97,38 @@ const buildRenameWebhookTool = ({ isGranted }: { isGranted: boolean }) => {
};
describe('DefinedToolRegistryService', () => {
+ describe('getAvailableDescriptors', () => {
+ it('should list a declared icon and leave it out for tools without one', async () => {
+ const definedToolRegistryService = buildDefinedToolRegistryService({
+ tools: [new RenameWebhookTool(), new ArchiveWebhookTool()],
+ isGranted: true,
+ });
+
+ const descriptors =
+ await definedToolRegistryService.getAvailableDescriptors(context, {
+ includeSchemas: false,
+ });
+
+ expect(descriptors).toStrictEqual([
+ {
+ name: 'rename_webhook',
+ label: 'Rename Webhook',
+ description: 'Rename a webhook.',
+ category: ToolCategory.WEBHOOK,
+ executionRef: { kind: 'static', toolId: 'rename_webhook' },
+ },
+ {
+ name: 'archive_webhook',
+ label: 'Archive Webhook',
+ description: 'Archive a webhook.',
+ category: ToolCategory.WEBHOOK,
+ executionRef: { kind: 'static', toolId: 'archive_webhook' },
+ icon: 'IconWebhook',
+ },
+ ]);
+ });
+ });
+
describe('execute', () => {
it('should run the tool with its parsed input when every flag is granted', async () => {
const { definedToolRegistryService, definedTool } =
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/services/defined-tool-registry.service.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/services/defined-tool-registry.service.ts
index 4596e64cf3e..23474a414aa 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/services/defined-tool-registry.service.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/services/defined-tool-registry.service.ts
@@ -75,19 +75,25 @@ export class DefinedToolRegistryService implements OnModuleInit {
return requestedTools
.filter((_, index) => isAvailableByTool[index])
- .map(({ options: { name, description, category }, inputJsonSchema }) => {
- const entry: ToolIndexEntry = {
- name,
- label: humanizeToolName(name),
- description,
- category,
- executionRef: { kind: 'static', toolId: name },
- };
-
- return includeSchemas
- ? { ...entry, inputSchema: inputJsonSchema }
- : entry;
- });
+ .map(
+ ({
+ options: { name, description, category, icon },
+ inputJsonSchema,
+ }) => {
+ const entry: ToolIndexEntry = {
+ name,
+ label: humanizeToolName(name),
+ description,
+ category,
+ executionRef: { kind: 'static', toolId: name },
+ ...(isDefined(icon) && { icon }),
+ };
+
+ return includeSchemas
+ ? { ...entry, inputSchema: inputJsonSchema }
+ : entry;
+ },
+ );
}
async execute({
diff --git a/packages/twenty-server/src/engine/core-modules/tool-provider/types/define-tool-options.type.ts b/packages/twenty-server/src/engine/core-modules/tool-provider/types/define-tool-options.type.ts
index def7a689742..3bd6b106be0 100644
--- a/packages/twenty-server/src/engine/core-modules/tool-provider/types/define-tool-options.type.ts
+++ b/packages/twenty-server/src/engine/core-modules/tool-provider/types/define-tool-options.type.ts
@@ -6,4 +6,5 @@ export type DefineToolOptions = {
category: ToolCategory;
description: string;
requiredPermissionFlags: PermissionFlagType[];
+ icon?: string;
};