Add MCP tool to get activities

apps/api/src/app/endpoints/ai/ai.service.ts

@@ -98,10 +98,16 @@ export class AiService {
     private readonly propertyService: PropertyService
   ) {}
 
-  public static getActivitiesTableColumnNames() {
+  public static getActivitiesTableColumnNames({
-    return AiService.ACTIVITIES_TABLE_COLUMN_DEFINITIONS.map(({ name }) => {
+    withValues
+  }: {
+    withValues: boolean;
+  }) {
+    return AiService.getActivitiesTableColumnDefinitions({ withValues }).map(
+      ({ name }) => {
         return name;
-    });
+      }
+    );
   }
 
   public static getHoldingsTableColumnNames() {
@@ -110,6 +116,18 @@ export class AiService {
     });
   }
 
+  private static getActivitiesTableColumnDefinitions({
+    withValues
+  }: {
+    withValues: boolean;
+  }) {
+    return AiService.ACTIVITIES_TABLE_COLUMN_DEFINITIONS.filter(
+      ({ requiresScopeToReadValues }) => {
+        return withValues || !requiresScopeToReadValues;
+      }
+    );
+  }
+
   public async generateText({
     prompt,
     requestTimeout = this.configurationService.get('REQUEST_TIMEOUT')
@@ -173,11 +191,7 @@ export class AiService {
     });
 
     const activitiesTableColumnDefinitions =
-      AiService.ACTIVITIES_TABLE_COLUMN_DEFINITIONS.filter(
+      AiService.getActivitiesTableColumnDefinitions({ withValues });
-        ({ requiresScopeToReadValues }) => {
-          return withValues || !requiresScopeToReadValues;
-        }
-      );
 
     const activitiesTableRows = activities.map(
       ({

apps/api/src/app/endpoints/mcp/mcp.controller.ts

@@ -22,18 +22,23 @@ import { z } from 'zod';
 const GET_ACTIVITIES_PARAMETERS = z.object({
   activityTypes: z
     .array(z.enum(ActivityType))
+    .min(1)
     .optional()
     .describe('The types of the activities to get'),
   assetClasses: z
     .array(z.enum(AssetClass))
+    .min(1)
     .optional()
     .describe('The asset classes of the activities to get'),
+  holding: z
+    .object({
       dataSource: z
         .enum(DataSource)
+        .describe('The data source of the asset profile'),
+      symbol: z.string().describe('The symbol of the asset profile')
+    })
     .optional()
-    .describe(
+    .describe('The asset profile of the activities to get'),
-      'The data source of the asset profile, which only takes effect together with the symbol'
-    ),
   range: z
     .string()
     .regex(DATE_RANGE_PATTERN)
@@ -49,12 +54,6 @@ const GET_ACTIVITIES_PARAMETERS = z.object({
     .min(0)
     .optional()
     .describe('The number of activities to skip'),
-  symbol: z
-    .string()
-    .optional()
-    .describe(
-      'The symbol of the asset profile, which only takes effect together with the data source'
-    ),
   take: z
     .number()
     .int()
@@ -79,9 +78,11 @@ export class GhostfolioMcpController {
       readOnlyHint: true,
       title: 'Get activities'
     },
-    description: `Gives the activities of the portfolio, the most recent first, with these columns: ${AiService.getActivitiesTableColumnNames().join(
+    description: `Gives the activities of the portfolio, the most recent first, with these columns: ${AiService.getActivitiesTableColumnNames(
+      { withValues: false }
+    ).join(
       ', '
-    )}. The columns with a monetary value are omitted if the access does not grant to read them. At most ${MCP_MAX_ACTIVITIES} activities are given per call, hence narrow the result with the parameters or get the further activities with the skip parameter.`,
+    )}. More columns with a monetary value are added if the access grants to read them. At most ${MCP_MAX_ACTIVITIES} activities are given per call, hence narrow the result with the parameters or get the further activities with the skip parameter.`,
     name: 'get-activities',
     parameters: GET_ACTIVITIES_PARAMETERS
   })
@@ -97,10 +98,9 @@ export class GhostfolioMcpController {
     {
       activityTypes,
       assetClasses,
-      dataSource,
+      holding,
       range,
       skip,
-      symbol,
       take
     }: z.infer<typeof GET_ACTIVITIES_PARAMETERS>
   ) {
@@ -115,23 +115,55 @@ export class GhostfolioMcpController {
 
     const filtersOfAccess = filters ?? [];
 
-    const typesOfFiltersOfAccess = new Set(
+    const filtersOfTool = this.apiService.buildFiltersFromQueryParams({
-      filtersOfAccess.map(({ type }) => {
+      filterByAssetClasses: assetClasses?.join(','),
-        return type;
+      filterByDataSource: holding?.dataSource,
+      filterBySymbol: holding?.symbol
+    });
+
+    // A tool must never widen the access, hence a filter of the tool which
+    // the access does not permit gives no activity
+    const filtersOfToolOutsideAccess = filtersOfTool.filter(({ id, type }) => {
+      const filtersOfAccessOfType = filtersOfAccess.filter((filter) => {
+        return filter.type === type;
+      });
+
+      return (
+        filtersOfAccessOfType.length > 0 &&
+        !filtersOfAccessOfType.some((filter) => {
+          return filter.id === id;
         })
       );
+    });
 
-    // A filter of the tool is dropped if the access already restricts its
+    if (filtersOfToolOutsideAccess.length > 0) {
-    // type, because the filters of a type are combined with a logical or and
+      const valuesOutsideAccess = filtersOfToolOutsideAccess
-    // a tool must never widen the access
+        .map(({ id }) => {
-    const filtersOfTool = this.apiService
+          return id;
-      .buildFiltersFromQueryParams({
-        filterByAssetClasses: assetClasses?.join(','),
-        filterByDataSource: dataSource,
-        filterBySymbol: symbol
         })
-      .filter(({ type }) => {
+        .join(', ');
-        return !typesOfFiltersOfAccess.has(type);
+
+      return {
+        content: [
+          {
+            text: `No activities found. The access does not permit these values of the parameters: ${valuesOutsideAccess}.`,
+            type: 'text' as const
+          }
+        ]
+      };
+    }
+
+    const typesOfFiltersOfTool = new Set(
+      filtersOfTool.map(({ type }) => {
+        return type;
+      })
+    );
+
+    // The filters of a type are combined with a logical or, hence a filter of
+    // the tool replaces the filters of the access of the same type instead of
+    // joining them
+    const filtersOfAccessOutsideTool = filtersOfAccess.filter(({ type }) => {
+      return !typesOfFiltersOfTool.has(type);
     });
 
     const table = await this.aiService.getActivitiesTable({
@@ -139,7 +171,7 @@ export class GhostfolioMcpController {
       skip,
       startDate,
       userId,
-      filters: [...filtersOfAccess, ...filtersOfTool],
+      filters: [...filtersOfAccessOutsideTool, ...filtersOfTool],
       take: take ?? MCP_MAX_ACTIVITIES,
       types: activityTypes,
       userCurrency: userSettings.baseCurrency,

apps/api/src/app/endpoints/mcp/mcp.module.ts

@@ -26,7 +26,7 @@ import { GhostfolioMcpController } from './mcp.controller';
 
         return new McpStrategy({
           instructions:
-            'Ghostfolio is a wealth management application. The tools read the portfolio of the user who granted the access. They give no monetary value.',
+            'Ghostfolio is a wealth management application. The tools read the portfolio of the user who granted the access. They give no quantity and no monetary value (except the unit price of an activity).',
           name: 'ghostfolio',
           title: 'Ghostfolio',
           transports: [