profound-mcp 0.2.1

package/tools/reports/sentiment-reports.mjs

@@ -0,0 +1,160 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { maybeFilter } from 'profound-mcp/filtering';
+import { asTextContentResult } from 'profound-mcp/tools/types';
+export const metadata = {
+    resource: 'reports',
+    operation: 'write',
+    tags: [],
+    httpMethod: 'post',
+    httpPath: '/v1/reports/sentiment',
+    operationId: 'query_sentiment_v1_reports_sentiment_post',
+};
+export const tool = {
+    name: 'sentiment_reports',
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nGet citations for a given category.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/report_response',\n  $defs: {\n    report_response: {\n      type: 'object',\n      title: 'Response',\n      description: 'Base response model for reports.',\n      properties: {\n        data: {\n          type: 'array',\n          title: 'Data',\n          items: {\n            $ref: '#/$defs/report_result'\n          }\n        },\n        info: {\n          $ref: '#/$defs/report_info'\n        }\n      },\n      required: [        'data',\n        'info'\n      ]\n    },\n    report_result: {\n      type: 'object',\n      title: 'Result',\n      description: 'Base model for report results.',\n      properties: {\n        dimensions: {\n          type: 'array',\n          title: 'Dimensions',\n          items: {\n            type: 'string'\n          }\n        },\n        metrics: {\n          type: 'array',\n          title: 'Metrics',\n          items: {\n            type: 'number'\n          }\n        }\n      },\n      required: [        'dimensions',\n        'metrics'\n      ]\n    },\n    report_info: {\n      type: 'object',\n      title: 'Info',\n      description: 'Base model for report information.',\n      properties: {\n        total_rows: {\n          type: 'integer',\n          title: 'Total Rows'\n        },\n        query: {\n          type: 'object',\n          title: 'Query',\n          additionalProperties: true\n        }\n      },\n      required: [        'total_rows'\n      ]\n    }\n  }\n}\n```",
+    inputSchema: {
+        type: 'object',
+        properties: {
+            category_id: {
+                type: 'string',
+                title: 'Category Id',
+            },
+            end_date: {
+                type: 'string',
+                title: 'End Date',
+                description: 'End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.',
+                format: 'date-time',
+            },
+            metrics: {
+                type: 'array',
+                title: 'Metrics',
+                items: {
+                    type: 'string',
+                    enum: ['positive', 'negative'],
+                },
+            },
+            start_date: {
+                type: 'string',
+                title: 'Start Date',
+                description: 'Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.',
+                format: 'date-time',
+            },
+            date_interval: {
+                type: 'string',
+                title: 'Date Interval',
+                description: 'Date interval for the report. (only used with date dimension)',
+                enum: ['day', 'week', 'month', 'year'],
+            },
+            dimensions: {
+                type: 'array',
+                title: 'Dimensions',
+                description: 'Dimensions to group the report by.',
+                items: {
+                    type: 'string',
+                    enum: ['theme', 'date', 'region', 'topic', 'model', 'asset_name', 'tag', 'prompt'],
+                },
+            },
+            filters: {
+                type: 'array',
+                title: 'Filters',
+                description: 'List of filters to apply to the report. Each filter has an operator, field, and value.',
+                items: {
+                    type: 'object',
+                    title: "Filter[Literal['asset_name', 'theme', 'region', 'topic', 'model', 'tag']]",
+                    properties: {
+                        field: {
+                            type: 'string',
+                            title: 'Field',
+                            enum: ['asset_name', 'theme', 'region', 'topic', 'model', 'tag'],
+                        },
+                        operator: {
+                            type: 'string',
+                            title: 'Operator',
+                            enum: [
+                                'is',
+                                'not_is',
+                                'in',
+                                'not_in',
+                                'contains',
+                                'not_contains',
+                                'contains_case_insensitive',
+                                'not_contains_case_insensitive',
+                                'matches',
+                            ],
+                        },
+                        value: {
+                            anyOf: [
+                                {
+                                    type: 'string',
+                                    title: 'FilterStringValue',
+                                },
+                                {
+                                    type: 'array',
+                                    title: 'FilterStringListValue',
+                                    items: {
+                                        type: 'string',
+                                    },
+                                },
+                                {
+                                    type: 'integer',
+                                    title: 'FilterIntegerValue',
+                                },
+                                {
+                                    type: 'array',
+                                    title: 'FilterIntegerListValue',
+                                    items: {
+                                        type: 'integer',
+                                    },
+                                },
+                            ],
+                            title: 'Value',
+                            description: 'Value for the filter. Can be a single value or a list of depending on the operator.',
+                        },
+                    },
+                    required: ['field', 'operator', 'value'],
+                },
+            },
+            order_by: {
+                type: 'object',
+                title: 'Order By',
+                description: "\nCustom ordering of the report results.\n\nThe order is a record of key-value pairs where:\n- key is the field to order by, which can be a metric or dimension\n- value is the direction of the order, either 'asc' for ascending or 'desc' for descending.\n\nWhen not specified, the default order is the first metric in the query descending.\n        ",
+                additionalProperties: true,
+            },
+            pagination: {
+                $ref: '#/$defs/pagination',
+            },
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
+        },
+        required: ['category_id', 'end_date', 'metrics', 'start_date'],
+        $defs: {
+            pagination: {
+                type: 'object',
+                title: 'Pagination',
+                description: 'Report pagination model.',
+                properties: {
+                    limit: {
+                        type: 'integer',
+                        title: 'Limit',
+                        description: 'Maximum number of results to return. Default is 10,000, maximum is 50,000.',
+                    },
+                    offset: {
+                        type: 'integer',
+                        title: 'Offset',
+                        description: 'Offset for the results. Used for pagination.',
+                    },
+                },
+            },
+        },
+    },
+    annotations: {},
+};
+export const handler = async (client, args) => {
+    const { jq_filter, ...body } = args;
+    return asTextContentResult(await maybeFilter(jq_filter, await client.reports.sentiment(body)));
+};
+export default { metadata, tool, handler };
+//# sourceMappingURL=sentiment-reports.mjs.map

package/tools/reports/sentiment-reports.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"sentiment-reports.mjs","sourceRoot":"","sources":["../../src/tools/reports/sentiment-reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE,MAAM,wBAAwB;OAC7C,EAAY,mBAAmB,EAAE,MAAM,0BAA0B;AAKxE,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,SAAS;IACnB,SAAS,EAAE,OAAO;IAClB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,MAAM;IAClB,QAAQ,EAAE,uBAAuB;IACjC,WAAW,EAAE,2CAA2C;CACzD,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,mBAAmB;IACzB,WAAW,EACT,yqDAAyqD;IAC3qD,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,aAAa;aACrB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,UAAU;gBACjB,WAAW,EACT,gGAAgG;gBAClG,MAAM,EAAE,WAAW;aACpB;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,SAAS;gBAChB,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC;iBAC/B;aACF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,YAAY;gBACnB,WAAW,EACT,kGAAkG;gBACpG,MAAM,EAAE,WAAW;aACpB;YACD,aAAa,EAAE;gBACb,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,eAAe;gBACtB,WAAW,EAAE,+DAA+D;gBAC5E,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC;aACvC;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,oCAAoC;gBACjD,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,QAAQ,CAAC;iBACnF;aACF;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,SAAS;gBAChB,WAAW,EAAE,wFAAwF;gBACrG,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,2EAA2E;oBAClF,UAAU,EAAE;wBACV,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,KAAK,EAAE,OAAO;4BACd,IAAI,EAAE,CAAC,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC;yBACjE;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ;4BACd,KAAK,EAAE,UAAU;4BACjB,IAAI,EAAE;gCACJ,IAAI;gCACJ,QAAQ;gCACR,IAAI;gCACJ,QAAQ;gCACR,UAAU;gCACV,cAAc;gCACd,2BAA2B;gCAC3B,+BAA+B;gCAC/B,SAAS;6BACV;yBACF;wBACD,KAAK,EAAE;4BACL,KAAK,EAAE;gCACL;oCACE,IAAI,EAAE,QAAQ;oCACd,KAAK,EAAE,mBAAmB;iCAC3B;gCACD;oCACE,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE,uBAAuB;oCAC9B,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;qCACf;iCACF;gCACD;oCACE,IAAI,EAAE,SAAS;oCACf,KAAK,EAAE,oBAAoB;iCAC5B;gCACD;oCACE,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE,wBAAwB;oCAC/B,KAAK,EAAE;wCACL,IAAI,EAAE,SAAS;qCAChB;iCACF;6BACF;4BACD,KAAK,EAAE,OAAO;4BACd,WAAW,EACT,qFAAqF;yBACxF;qBACF;oBACD,QAAQ,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC;iBACzC;aACF;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,UAAU;gBACjB,WAAW,EACT,8VAA8V;gBAChW,oBAAoB,EAAE,IAAI;aAC3B;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,oBAAoB;aAC3B;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;QACD,QAAQ,EAAE,CAAC,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC;QAC9D,KAAK,EAAE;YACL,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,0BAA0B;gBACvC,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,OAAO;wBACd,WAAW,EAAE,4EAA4E;qBAC1F;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,QAAQ;wBACf,WAAW,EAAE,8CAA8C;qBAC5D;iBACF;aACF;SACF;KACF;IACD,WAAW,EAAE,EAAE;CAChB,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAE,MAAgB,EAAE,IAAyC,EAAE,EAAE;IAC3F,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IAC3C,OAAO,mBAAmB,CAAC,MAAM,WAAW,CAAC,SAAS,EAAE,MAAM,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AACjG,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}

package/tools/reports/visibility-reports.d.mts

@@ -0,0 +1,45 @@
+import { Metadata } from 'profound-mcp/tools/types';
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import Profound from 'profoundai';
+export declare const metadata: Metadata;
+export declare const tool: Tool;
+export declare const handler: (client: Profound, args: Record<string, unknown> | undefined) => Promise<import("profound-mcp/tools/types").ToolCallResult>;
+declare const _default: {
+    metadata: Metadata;
+    tool: {
+        [x: string]: unknown;
+        name: string;
+        inputSchema: {
+            [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: unknown;
+            } | undefined;
+            required?: string[] | undefined;
+        };
+        title?: string | undefined;
+        description?: string | undefined;
+        outputSchema?: {
+            [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: unknown;
+            } | undefined;
+            required?: string[] | undefined;
+        } | undefined;
+        annotations?: {
+            [x: string]: unknown;
+            title?: string | undefined;
+            readOnlyHint?: boolean | undefined;
+            destructiveHint?: boolean | undefined;
+            idempotentHint?: boolean | undefined;
+            openWorldHint?: boolean | undefined;
+        } | undefined;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+    };
+    handler: (client: Profound, args: Record<string, unknown> | undefined) => Promise<import("profound-mcp/tools/types").ToolCallResult>;
+};
+export default _default;
+//# sourceMappingURL=visibility-reports.d.mts.map

package/tools/reports/visibility-reports.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visibility-reports.d.mts","sourceRoot":"","sources":["../../src/tools/reports/visibility-reports.ts"],"names":[],"mappings":"OAGO,EAAE,QAAQ,EAAuB,MAAM,0BAA0B;OAEjE,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,QAAQ,MAAM,YAAY;AAEjC,eAAO,MAAM,QAAQ,EAAE,QAOtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAoJlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAU,QAAQ,QAAQ,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,+DAGxF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAHoC,QAAQ,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAKzF,wBAA2C"}

package/tools/reports/visibility-reports.d.ts

@@ -0,0 +1,45 @@
+import { Metadata } from 'profound-mcp/tools/types';
+import { Tool } from '@modelcontextprotocol/sdk/types.js';
+import Profound from 'profoundai';
+export declare const metadata: Metadata;
+export declare const tool: Tool;
+export declare const handler: (client: Profound, args: Record<string, unknown> | undefined) => Promise<import("profound-mcp/tools/types").ToolCallResult>;
+declare const _default: {
+    metadata: Metadata;
+    tool: {
+        [x: string]: unknown;
+        name: string;
+        inputSchema: {
+            [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: unknown;
+            } | undefined;
+            required?: string[] | undefined;
+        };
+        title?: string | undefined;
+        description?: string | undefined;
+        outputSchema?: {
+            [x: string]: unknown;
+            type: "object";
+            properties?: {
+                [x: string]: unknown;
+            } | undefined;
+            required?: string[] | undefined;
+        } | undefined;
+        annotations?: {
+            [x: string]: unknown;
+            title?: string | undefined;
+            readOnlyHint?: boolean | undefined;
+            destructiveHint?: boolean | undefined;
+            idempotentHint?: boolean | undefined;
+            openWorldHint?: boolean | undefined;
+        } | undefined;
+        _meta?: {
+            [x: string]: unknown;
+        } | undefined;
+    };
+    handler: (client: Profound, args: Record<string, unknown> | undefined) => Promise<import("profound-mcp/tools/types").ToolCallResult>;
+};
+export default _default;
+//# sourceMappingURL=visibility-reports.d.ts.map

package/tools/reports/visibility-reports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"visibility-reports.d.ts","sourceRoot":"","sources":["../../src/tools/reports/visibility-reports.ts"],"names":[],"mappings":"OAGO,EAAE,QAAQ,EAAuB,MAAM,0BAA0B;OAEjE,EAAE,IAAI,EAAE,MAAM,oCAAoC;OAClD,QAAQ,MAAM,YAAY;AAEjC,eAAO,MAAM,QAAQ,EAAE,QAOtB,CAAC;AAEF,eAAO,MAAM,IAAI,EAAE,IAoJlB,CAAC;AAEF,eAAO,MAAM,OAAO,GAAU,QAAQ,QAAQ,EAAE,MAAM,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,+DAGxF,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;sBAHoC,QAAQ,QAAQ,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS;;AAKzF,wBAA2C"}

package/tools/reports/visibility-reports.js

@@ -0,0 +1,164 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handler = exports.tool = exports.metadata = void 0;
+const filtering_1 = require("profound-mcp/filtering");
+const types_1 = require("profound-mcp/tools/types");
+exports.metadata = {
+    resource: 'reports',
+    operation: 'write',
+    tags: [],
+    httpMethod: 'post',
+    httpPath: '/v1/reports/visibility',
+    operationId: 'query_visibility_v1_reports_visibility_post',
+};
+exports.tool = {
+    name: 'visibility_reports',
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nQuery visibility report.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/report_response',\n  $defs: {\n    report_response: {\n      type: 'object',\n      title: 'Response',\n      description: 'Base response model for reports.',\n      properties: {\n        data: {\n          type: 'array',\n          title: 'Data',\n          items: {\n            $ref: '#/$defs/report_result'\n          }\n        },\n        info: {\n          $ref: '#/$defs/report_info'\n        }\n      },\n      required: [        'data',\n        'info'\n      ]\n    },\n    report_result: {\n      type: 'object',\n      title: 'Result',\n      description: 'Base model for report results.',\n      properties: {\n        dimensions: {\n          type: 'array',\n          title: 'Dimensions',\n          items: {\n            type: 'string'\n          }\n        },\n        metrics: {\n          type: 'array',\n          title: 'Metrics',\n          items: {\n            type: 'number'\n          }\n        }\n      },\n      required: [        'dimensions',\n        'metrics'\n      ]\n    },\n    report_info: {\n      type: 'object',\n      title: 'Info',\n      description: 'Base model for report information.',\n      properties: {\n        total_rows: {\n          type: 'integer',\n          title: 'Total Rows'\n        },\n        query: {\n          type: 'object',\n          title: 'Query',\n          additionalProperties: true\n        }\n      },\n      required: [        'total_rows'\n      ]\n    }\n  }\n}\n```",
+    inputSchema: {
+        type: 'object',
+        properties: {
+            category_id: {
+                type: 'string',
+                title: 'Category Id',
+            },
+            end_date: {
+                type: 'string',
+                title: 'End Date',
+                description: 'End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.',
+                format: 'date-time',
+            },
+            metrics: {
+                type: 'array',
+                title: 'Metrics',
+                items: {
+                    type: 'string',
+                    enum: ['share_of_voice', 'mentions_count', 'visibility_score'],
+                },
+            },
+            start_date: {
+                type: 'string',
+                title: 'Start Date',
+                description: 'Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.',
+                format: 'date-time',
+            },
+            date_interval: {
+                type: 'string',
+                title: 'Date Interval',
+                description: 'Date interval for the report. (only used with date dimension)',
+                enum: ['day', 'week', 'month', 'year'],
+            },
+            dimensions: {
+                type: 'array',
+                title: 'Dimensions',
+                description: 'Dimensions to group the report by.',
+                items: {
+                    type: 'string',
+                    enum: ['date', 'region', 'topic', 'model', 'asset_name', 'prompt', 'tag'],
+                },
+            },
+            filters: {
+                type: 'array',
+                title: 'Filters',
+                description: 'List of filters to apply to the report. Each filter has an operator, field, and value.',
+                items: {
+                    type: 'object',
+                    title: "Filter[Literal['region', 'topic', 'model', 'asset_name', 'prompt', 'tag']]",
+                    properties: {
+                        field: {
+                            type: 'string',
+                            title: 'Field',
+                            enum: ['region', 'topic', 'model', 'asset_name', 'prompt', 'tag'],
+                        },
+                        operator: {
+                            type: 'string',
+                            title: 'Operator',
+                            enum: [
+                                'is',
+                                'not_is',
+                                'in',
+                                'not_in',
+                                'contains',
+                                'not_contains',
+                                'contains_case_insensitive',
+                                'not_contains_case_insensitive',
+                                'matches',
+                            ],
+                        },
+                        value: {
+                            anyOf: [
+                                {
+                                    type: 'string',
+                                    title: 'FilterStringValue',
+                                },
+                                {
+                                    type: 'array',
+                                    title: 'FilterStringListValue',
+                                    items: {
+                                        type: 'string',
+                                    },
+                                },
+                                {
+                                    type: 'integer',
+                                    title: 'FilterIntegerValue',
+                                },
+                                {
+                                    type: 'array',
+                                    title: 'FilterIntegerListValue',
+                                    items: {
+                                        type: 'integer',
+                                    },
+                                },
+                            ],
+                            title: 'Value',
+                            description: 'Value for the filter. Can be a single value or a list of depending on the operator.',
+                        },
+                    },
+                    required: ['field', 'operator', 'value'],
+                },
+            },
+            order_by: {
+                type: 'object',
+                title: 'Order By',
+                description: "\nCustom ordering of the report results.\n\nThe order is a record of key-value pairs where:\n- key is the field to order by, which can be a metric or dimension\n- value is the direction of the order, either 'asc' for ascending or 'desc' for descending.\n\nWhen not specified, the default order is the first metric in the query descending.\n        ",
+                additionalProperties: true,
+            },
+            pagination: {
+                $ref: '#/$defs/pagination',
+            },
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
+        },
+        required: ['category_id', 'end_date', 'metrics', 'start_date'],
+        $defs: {
+            pagination: {
+                type: 'object',
+                title: 'Pagination',
+                description: 'Report pagination model.',
+                properties: {
+                    limit: {
+                        type: 'integer',
+                        title: 'Limit',
+                        description: 'Maximum number of results to return. Default is 10,000, maximum is 50,000.',
+                    },
+                    offset: {
+                        type: 'integer',
+                        title: 'Offset',
+                        description: 'Offset for the results. Used for pagination.',
+                    },
+                },
+            },
+        },
+    },
+    annotations: {},
+};
+const handler = async (client, args) => {
+    const { jq_filter, ...body } = args;
+    return (0, types_1.asTextContentResult)(await (0, filtering_1.maybeFilter)(jq_filter, await client.reports.visibility(body)));
+};
+exports.handler = handler;
+exports.default = { metadata: exports.metadata, tool: exports.tool, handler: exports.handler };
+//# sourceMappingURL=visibility-reports.js.map

package/tools/reports/visibility-reports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"visibility-reports.js","sourceRoot":"","sources":["../../src/tools/reports/visibility-reports.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,sDAAqD;AACrD,oDAAyE;AAK5D,QAAA,QAAQ,GAAa;IAChC,QAAQ,EAAE,SAAS;IACnB,SAAS,EAAE,OAAO;IAClB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,MAAM;IAClB,QAAQ,EAAE,wBAAwB;IAClC,WAAW,EAAE,6CAA6C;CAC3D,CAAC;AAEW,QAAA,IAAI,GAAS;IACxB,IAAI,EAAE,oBAAoB;IAC1B,WAAW,EACT,8pDAA8pD;IAChqD,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,aAAa;aACrB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,UAAU;gBACjB,WAAW,EACT,gGAAgG;gBAClG,MAAM,EAAE,WAAW;aACpB;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,SAAS;gBAChB,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,kBAAkB,CAAC;iBAC/D;aACF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,YAAY;gBACnB,WAAW,EACT,kGAAkG;gBACpG,MAAM,EAAE,WAAW;aACpB;YACD,aAAa,EAAE;gBACb,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,eAAe;gBACtB,WAAW,EAAE,+DAA+D;gBAC5E,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC;aACvC;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,oCAAoC;gBACjD,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAK,CAAC;iBAC1E;aACF;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,SAAS;gBAChB,WAAW,EAAE,wFAAwF;gBACrG,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,4EAA4E;oBACnF,UAAU,EAAE;wBACV,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,KAAK,EAAE,OAAO;4BACd,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAK,CAAC;yBAClE;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ;4BACd,KAAK,EAAE,UAAU;4BACjB,IAAI,EAAE;gCACJ,IAAI;gCACJ,QAAQ;gCACR,IAAI;gCACJ,QAAQ;gCACR,UAAU;gCACV,cAAc;gCACd,2BAA2B;gCAC3B,+BAA+B;gCAC/B,SAAS;6BACV;yBACF;wBACD,KAAK,EAAE;4BACL,KAAK,EAAE;gCACL;oCACE,IAAI,EAAE,QAAQ;oCACd,KAAK,EAAE,mBAAmB;iCAC3B;gCACD;oCACE,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE,uBAAuB;oCAC9B,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;qCACf;iCACF;gCACD;oCACE,IAAI,EAAE,SAAS;oCACf,KAAK,EAAE,oBAAoB;iCAC5B;gCACD;oCACE,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE,wBAAwB;oCAC/B,KAAK,EAAE;wCACL,IAAI,EAAE,SAAS;qCAChB;iCACF;6BACF;4BACD,KAAK,EAAE,OAAO;4BACd,WAAW,EACT,qFAAqF;yBACxF;qBACF;oBACD,QAAQ,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC;iBACzC;aACF;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,UAAU;gBACjB,WAAW,EACT,8VAA8V;gBAChW,oBAAoB,EAAE,IAAI;aAC3B;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,oBAAoB;aAC3B;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;QACD,QAAQ,EAAE,CAAC,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC;QAC9D,KAAK,EAAE;YACL,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,0BAA0B;gBACvC,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,OAAO;wBACd,WAAW,EAAE,4EAA4E;qBAC1F;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,QAAQ;wBACf,WAAW,EAAE,8CAA8C;qBAC5D;iBACF;aACF;SACF;KACF;IACD,WAAW,EAAE,EAAE;CAChB,CAAC;AAEK,MAAM,OAAO,GAAG,KAAK,EAAE,MAAgB,EAAE,IAAyC,EAAE,EAAE;IAC3F,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IAC3C,OAAO,IAAA,2BAAmB,EAAC,MAAM,IAAA,uBAAW,EAAC,SAAS,EAAE,MAAM,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClG,CAAC,CAAC;AAHW,QAAA,OAAO,WAGlB;AAEF,kBAAe,EAAE,QAAQ,EAAR,gBAAQ,EAAE,IAAI,EAAJ,YAAI,EAAE,OAAO,EAAP,eAAO,EAAE,CAAC"}

package/tools/reports/visibility-reports.mjs

@@ -0,0 +1,160 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { maybeFilter } from 'profound-mcp/filtering';
+import { asTextContentResult } from 'profound-mcp/tools/types';
+export const metadata = {
+    resource: 'reports',
+    operation: 'write',
+    tags: [],
+    httpMethod: 'post',
+    httpPath: '/v1/reports/visibility',
+    operationId: 'query_visibility_v1_reports_visibility_post',
+};
+export const tool = {
+    name: 'visibility_reports',
+    description: "When using this tool, always use the `jq_filter` parameter to reduce the response size and improve performance.\n\nOnly omit if you're sure you don't need the data.\n\nQuery visibility report.\n\n# Response Schema\n```json\n{\n  $ref: '#/$defs/report_response',\n  $defs: {\n    report_response: {\n      type: 'object',\n      title: 'Response',\n      description: 'Base response model for reports.',\n      properties: {\n        data: {\n          type: 'array',\n          title: 'Data',\n          items: {\n            $ref: '#/$defs/report_result'\n          }\n        },\n        info: {\n          $ref: '#/$defs/report_info'\n        }\n      },\n      required: [        'data',\n        'info'\n      ]\n    },\n    report_result: {\n      type: 'object',\n      title: 'Result',\n      description: 'Base model for report results.',\n      properties: {\n        dimensions: {\n          type: 'array',\n          title: 'Dimensions',\n          items: {\n            type: 'string'\n          }\n        },\n        metrics: {\n          type: 'array',\n          title: 'Metrics',\n          items: {\n            type: 'number'\n          }\n        }\n      },\n      required: [        'dimensions',\n        'metrics'\n      ]\n    },\n    report_info: {\n      type: 'object',\n      title: 'Info',\n      description: 'Base model for report information.',\n      properties: {\n        total_rows: {\n          type: 'integer',\n          title: 'Total Rows'\n        },\n        query: {\n          type: 'object',\n          title: 'Query',\n          additionalProperties: true\n        }\n      },\n      required: [        'total_rows'\n      ]\n    }\n  }\n}\n```",
+    inputSchema: {
+        type: 'object',
+        properties: {
+            category_id: {
+                type: 'string',
+                title: 'Category Id',
+            },
+            end_date: {
+                type: 'string',
+                title: 'End Date',
+                description: 'End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.',
+                format: 'date-time',
+            },
+            metrics: {
+                type: 'array',
+                title: 'Metrics',
+                items: {
+                    type: 'string',
+                    enum: ['share_of_voice', 'mentions_count', 'visibility_score'],
+                },
+            },
+            start_date: {
+                type: 'string',
+                title: 'Start Date',
+                description: 'Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.',
+                format: 'date-time',
+            },
+            date_interval: {
+                type: 'string',
+                title: 'Date Interval',
+                description: 'Date interval for the report. (only used with date dimension)',
+                enum: ['day', 'week', 'month', 'year'],
+            },
+            dimensions: {
+                type: 'array',
+                title: 'Dimensions',
+                description: 'Dimensions to group the report by.',
+                items: {
+                    type: 'string',
+                    enum: ['date', 'region', 'topic', 'model', 'asset_name', 'prompt', 'tag'],
+                },
+            },
+            filters: {
+                type: 'array',
+                title: 'Filters',
+                description: 'List of filters to apply to the report. Each filter has an operator, field, and value.',
+                items: {
+                    type: 'object',
+                    title: "Filter[Literal['region', 'topic', 'model', 'asset_name', 'prompt', 'tag']]",
+                    properties: {
+                        field: {
+                            type: 'string',
+                            title: 'Field',
+                            enum: ['region', 'topic', 'model', 'asset_name', 'prompt', 'tag'],
+                        },
+                        operator: {
+                            type: 'string',
+                            title: 'Operator',
+                            enum: [
+                                'is',
+                                'not_is',
+                                'in',
+                                'not_in',
+                                'contains',
+                                'not_contains',
+                                'contains_case_insensitive',
+                                'not_contains_case_insensitive',
+                                'matches',
+                            ],
+                        },
+                        value: {
+                            anyOf: [
+                                {
+                                    type: 'string',
+                                    title: 'FilterStringValue',
+                                },
+                                {
+                                    type: 'array',
+                                    title: 'FilterStringListValue',
+                                    items: {
+                                        type: 'string',
+                                    },
+                                },
+                                {
+                                    type: 'integer',
+                                    title: 'FilterIntegerValue',
+                                },
+                                {
+                                    type: 'array',
+                                    title: 'FilterIntegerListValue',
+                                    items: {
+                                        type: 'integer',
+                                    },
+                                },
+                            ],
+                            title: 'Value',
+                            description: 'Value for the filter. Can be a single value or a list of depending on the operator.',
+                        },
+                    },
+                    required: ['field', 'operator', 'value'],
+                },
+            },
+            order_by: {
+                type: 'object',
+                title: 'Order By',
+                description: "\nCustom ordering of the report results.\n\nThe order is a record of key-value pairs where:\n- key is the field to order by, which can be a metric or dimension\n- value is the direction of the order, either 'asc' for ascending or 'desc' for descending.\n\nWhen not specified, the default order is the first metric in the query descending.\n        ",
+                additionalProperties: true,
+            },
+            pagination: {
+                $ref: '#/$defs/pagination',
+            },
+            jq_filter: {
+                type: 'string',
+                title: 'jq Filter',
+                description: 'A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide ".results[].name".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).',
+            },
+        },
+        required: ['category_id', 'end_date', 'metrics', 'start_date'],
+        $defs: {
+            pagination: {
+                type: 'object',
+                title: 'Pagination',
+                description: 'Report pagination model.',
+                properties: {
+                    limit: {
+                        type: 'integer',
+                        title: 'Limit',
+                        description: 'Maximum number of results to return. Default is 10,000, maximum is 50,000.',
+                    },
+                    offset: {
+                        type: 'integer',
+                        title: 'Offset',
+                        description: 'Offset for the results. Used for pagination.',
+                    },
+                },
+            },
+        },
+    },
+    annotations: {},
+};
+export const handler = async (client, args) => {
+    const { jq_filter, ...body } = args;
+    return asTextContentResult(await maybeFilter(jq_filter, await client.reports.visibility(body)));
+};
+export default { metadata, tool, handler };
+//# sourceMappingURL=visibility-reports.mjs.map

package/tools/reports/visibility-reports.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"visibility-reports.mjs","sourceRoot":"","sources":["../../src/tools/reports/visibility-reports.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE,MAAM,wBAAwB;OAC7C,EAAY,mBAAmB,EAAE,MAAM,0BAA0B;AAKxE,MAAM,CAAC,MAAM,QAAQ,GAAa;IAChC,QAAQ,EAAE,SAAS;IACnB,SAAS,EAAE,OAAO;IAClB,IAAI,EAAE,EAAE;IACR,UAAU,EAAE,MAAM;IAClB,QAAQ,EAAE,wBAAwB;IAClC,WAAW,EAAE,6CAA6C;CAC3D,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAS;IACxB,IAAI,EAAE,oBAAoB;IAC1B,WAAW,EACT,8pDAA8pD;IAChqD,WAAW,EAAE;QACX,IAAI,EAAE,QAAQ;QACd,UAAU,EAAE;YACV,WAAW,EAAE;gBACX,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,aAAa;aACrB;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,UAAU;gBACjB,WAAW,EACT,gGAAgG;gBAClG,MAAM,EAAE,WAAW;aACpB;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,SAAS;gBAChB,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,kBAAkB,CAAC;iBAC/D;aACF;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,YAAY;gBACnB,WAAW,EACT,kGAAkG;gBACpG,MAAM,EAAE,WAAW;aACpB;YACD,aAAa,EAAE;gBACb,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,eAAe;gBACtB,WAAW,EAAE,+DAA+D;gBAC5E,IAAI,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC;aACvC;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,oCAAoC;gBACjD,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAK,CAAC;iBAC1E;aACF;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,SAAS;gBAChB,WAAW,EAAE,wFAAwF;gBACrG,KAAK,EAAE;oBACL,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,4EAA4E;oBACnF,UAAU,EAAE;wBACV,KAAK,EAAE;4BACL,IAAI,EAAE,QAAQ;4BACd,KAAK,EAAE,OAAO;4BACd,IAAI,EAAE,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,QAAQ,EAAE,KAAK,CAAC;yBAClE;wBACD,QAAQ,EAAE;4BACR,IAAI,EAAE,QAAQ;4BACd,KAAK,EAAE,UAAU;4BACjB,IAAI,EAAE;gCACJ,IAAI;gCACJ,QAAQ;gCACR,IAAI;gCACJ,QAAQ;gCACR,UAAU;gCACV,cAAc;gCACd,2BAA2B;gCAC3B,+BAA+B;gCAC/B,SAAS;6BACV;yBACF;wBACD,KAAK,EAAE;4BACL,KAAK,EAAE;gCACL;oCACE,IAAI,EAAE,QAAQ;oCACd,KAAK,EAAE,mBAAmB;iCAC3B;gCACD;oCACE,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE,uBAAuB;oCAC9B,KAAK,EAAE;wCACL,IAAI,EAAE,QAAQ;qCACf;iCACF;gCACD;oCACE,IAAI,EAAE,SAAS;oCACf,KAAK,EAAE,oBAAoB;iCAC5B;gCACD;oCACE,IAAI,EAAE,OAAO;oCACb,KAAK,EAAE,wBAAwB;oCAC/B,KAAK,EAAE;wCACL,IAAI,EAAE,SAAS;qCAChB;iCACF;6BACF;4BACD,KAAK,EAAE,OAAO;4BACd,WAAW,EACT,qFAAqF;yBACxF;qBACF;oBACD,QAAQ,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC;iBACzC;aACF;YACD,QAAQ,EAAE;gBACR,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,UAAU;gBACjB,WAAW,EACT,8VAA8V;gBAChW,oBAAoB,EAAE,IAAI;aAC3B;YACD,UAAU,EAAE;gBACV,IAAI,EAAE,oBAAoB;aAC3B;YACD,SAAS,EAAE;gBACT,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,WAAW;gBAClB,WAAW,EACT,kWAAkW;aACrW;SACF;QACD,QAAQ,EAAE,CAAC,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,CAAC;QAC9D,KAAK,EAAE;YACL,UAAU,EAAE;gBACV,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,YAAY;gBACnB,WAAW,EAAE,0BAA0B;gBACvC,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,OAAO;wBACd,WAAW,EAAE,4EAA4E;qBAC1F;oBACD,MAAM,EAAE;wBACN,IAAI,EAAE,SAAS;wBACf,KAAK,EAAE,QAAQ;wBACf,WAAW,EAAE,8CAA8C;qBAC5D;iBACF;aACF;SACF;KACF;IACD,WAAW,EAAE,EAAE;CAChB,CAAC;AAEF,MAAM,CAAC,MAAM,OAAO,GAAG,KAAK,EAAE,MAAgB,EAAE,IAAyC,EAAE,EAAE;IAC3F,MAAM,EAAE,SAAS,EAAE,GAAG,IAAI,EAAE,GAAG,IAAW,CAAC;IAC3C,OAAO,mBAAmB,CAAC,MAAM,WAAW,CAAC,SAAS,EAAE,MAAM,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClG,CAAC,CAAC;AAEF,eAAe,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC"}