@trylighthouse/mcp-server 0.1.0 → 0.1.1

package/build/index.js

@@ -126,13 +126,11 @@ server.registerTool("lighthouse_crm_get_attribute", {
     description: "Get a single custom field definition by its field_permalink.",
     inputSchema: {
         field_permalink: z.string().describe("Field permalink (unique key) of the attribute"),
-        entity_type: z.enum(["company", "person", "deal"]).optional().describe("Record type context"),
+        entity_type: z.enum(["company", "person", "deal"]).describe("Record type (required)"),
     },
 }, async (params) => {
     try {
-        const res = await api.get(`/attributes/${params.field_permalink}`, {
-            entity_type: params.entity_type,
-        });
+        const res = await api.get(`/attributes/${params.entity_type}/${params.field_permalink}`);
         return text(res);
     }
     catch (e) {
@@ -142,15 +140,16 @@ server.registerTool("lighthouse_crm_get_attribute", {
 server.registerTool("lighthouse_crm_create_attribute", {
     title: "Create CRM Attribute",
     description: "Create a new custom field in your CRM workspace. " +
-        "Common types: short_text, long_text, number, currency, date, select, multi_select, boolean, url, email, phone, rating.",
+        "Types: text, number, currency, percentage, date, datetimez, select, multi_select, status, checkbox, url, email, phone, rating, record, multi_record, user, multi_user.",
     inputSchema: {
-        name: z.string().describe("Display name for the field"),
+        label: z.string().describe("Display label for the field"),
         entity_type: z.enum(["company", "person", "deal"]).describe("Record type this field belongs to"),
-        data_type: z.string().describe("Field type (short_text, long_text, number, currency, date, select, multi_select, boolean, url, email, phone, rating)"),
+        data_type: z.string().describe("Field type (text, number, currency, percentage, date, datetimez, select, multi_select, status, checkbox, url, email, phone, rating, record, multi_record, user, multi_user)"),
+        record_type: z.enum(["company", "person", "deal"]).optional().describe("For record/multi_record fields: which record type to link to"),
         options: z
             .array(z.record(z.unknown()))
             .optional()
-            .describe("For select/multi_select fields: array of {value, label} option objects"),
+            .describe("For select/multi_select/status fields: array of {value, label} option objects"),
     },
 }, async (params) => {
     try {
@@ -163,16 +162,47 @@ server.registerTool("lighthouse_crm_create_attribute", {
 });
 server.registerTool("lighthouse_crm_update_attribute", {
     title: "Update CRM Attribute",
-    description: "Update a custom field's name or configuration.",
+    description: "Update a custom field's label or configuration.",
     inputSchema: {
         field_permalink: z.string().describe("Field permalink of the attribute to update"),
-        entity_type: z.enum(["company", "person", "deal"]).optional().describe("Record type context"),
-        name: z.string().optional().describe("New display name"),
+        entity_type: z.enum(["company", "person", "deal"]).describe("Record type (required)"),
+        label: z.string().optional().describe("New display label"),
+    },
+}, async (params) => {
+    try {
+        const { field_permalink, entity_type, ...body } = params;
+        const res = await api.patch(`/attributes/${entity_type}/${field_permalink}`, body);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_crm_delete_attribute", {
+    title: "Delete CRM Attribute",
+    description: "Delete (archive) a custom field. Only custom fields can be deleted, not system fields.",
+    inputSchema: {
+        field_permalink: z.string().describe("Field permalink of the attribute to delete"),
+        entity_type: z.enum(["company", "person", "deal"]).describe("Record type (required)"),
     },
 }, async (params) => {
     try {
-        const { field_permalink, ...body } = params;
-        const res = await api.patch(`/attributes/${field_permalink}`, body);
+        const res = await api.delete(`/attributes/${params.entity_type}/${params.field_permalink}`);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_crm_get_color_palette", {
+    title: "Get Color Palette",
+    description: "Get the available color palette for select/multi_select/status field options. " +
+        "Returns an array of {hex_code, label} objects. " +
+        "Use this to discover valid hex color codes when creating or updating select options.",
+    inputSchema: {},
+}, async () => {
+    try {
+        const res = await api.get("/attributes/colors");
         return text(res);
     }
     catch (e) {
@@ -185,12 +215,12 @@ server.registerTool("lighthouse_crm_list_options", {
     description: "Get select/multi_select field options. " +
         "Use this to discover available values for select fields before setting them on records.",
     inputSchema: {
-        field_permalink: z.string().optional().describe("Filter by field permalink"),
-        entity_type: z.enum(["company", "person", "deal"]).optional().describe("Filter by record type"),
+        entity_type: z.enum(["company", "person", "deal"]).describe("Record type"),
+        field_permalink: z.string().describe("Field permalink of the select/multi_select field"),
     },
 }, async (params) => {
     try {
-        const res = await api.get("/options", params);
+        const res = await api.get(`/options/${params.entity_type}/${params.field_permalink}`);
         return text(res);
     }
     catch (e) {
@@ -199,17 +229,34 @@ server.registerTool("lighthouse_crm_list_options", {
 });
 server.registerTool("lighthouse_crm_create_option", {
     title: "Create CRM Field Option",
-    description: "Add a new option value to a select/multi_select field.",
+    description: "Add a new option to a select/multi_select field. The option value is auto-generated from the label. Returns the updated list of options for the field.",
     inputSchema: {
+        entity_type: z.enum(["company", "person", "deal"]).describe("Record type"),
         field_permalink: z.string().describe("Field permalink of the select/multi_select field"),
+        label: z.string().describe("Option display label"),
+        color: z.string().optional().describe("Option color (hex code from palette, auto-assigned if omitted)"),
+    },
+}, async (params) => {
+    try {
+        const { entity_type, field_permalink, ...body } = params;
+        const res = await api.post(`/options/${entity_type}/${field_permalink}`, body);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_crm_delete_option", {
+    title: "Delete CRM Field Option",
+    description: "Delete an option value from a select/multi_select field. Cannot delete system default options.",
+    inputSchema: {
         entity_type: z.enum(["company", "person", "deal"]).describe("Record type"),
-        value: z.string().describe("Option value (stored value)"),
-        label: z.string().describe("Option label (display text)"),
-        color: z.string().optional().describe("Option color (hex code)"),
+        field_permalink: z.string().describe("Field permalink of the select/multi_select field"),
+        value: z.string().describe("Option value to delete"),
     },
 }, async (params) => {
     try {
-        const res = await api.post("/options", params);
+        const res = await api.delete(`/options/${params.entity_type}/${params.field_permalink}/${params.value}`);
         return text(res);
     }
     catch (e) {
@@ -340,7 +387,7 @@ server.registerTool("lighthouse_crm_create_list", {
     description: "Create a new CRM list to organize records.",
     inputSchema: {
         name: z.string().describe("List name"),
-        entity_type: z.enum(["company", "person", "deal"]).describe("Record type for this list"),
+        type: z.enum(["company", "person", "deal"]).describe("Record type for this list"),
     },
 }, async (params) => {
     try {
@@ -474,8 +521,8 @@ server.registerTool("lighthouse_crm_list_notes", {
     title: "List Notes",
     description: "Get notes for a CRM record.",
     inputSchema: {
-        record_id: z.string().uuid().describe("Record ID to get notes for"),
-        record_type: z.enum(["company", "person", "deal"]).describe("Record type"),
+        record_id: z.string().uuid().optional().describe("Record ID to filter notes by (optional — omit to list all notes)"),
+        record_type: z.enum(["company", "person", "deal"]).optional().describe("Record type (required if record_id is provided)"),
         limit: z.number().min(1).max(100).default(25),
         offset: z.number().min(0).default(0),
     },
@@ -729,6 +776,7 @@ server.registerTool("lighthouse_crm_create_view", {
         view_type: z.enum(["table", "kanban"]).default("table").describe("View layout type"),
         grouped_by: z.string().optional().describe("Field key to group by (required for kanban views)"),
         sharing: z.enum(["private", "workspace"]).default("private").describe("Visibility"),
+        team_ids: z.array(z.string().uuid()).optional().describe("Team UUIDs to share the view with. Replaces any existing team shares."),
     },
 }, async (params) => {
     try {
@@ -751,6 +799,7 @@ server.registerTool("lighthouse_crm_update_view", {
         view_type: z.enum(["table", "kanban"]).optional(),
         grouped_by: z.string().optional().describe("Field key to group by (required for kanban views)"),
         sharing: z.enum(["private", "workspace"]).optional(),
+        team_ids: z.array(z.string().uuid()).optional().describe("Team UUIDs to share the view with. Replaces any existing team shares."),
     },
 }, async (params) => {
     try {
@@ -945,6 +994,325 @@ server.registerTool("lighthouse_discovery_search_people", {
         return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
     }
 });
+// ─── Reports: Dashboards ─────────────────────────────────
+const WIDGET_CONFIG_DESCRIPTION = "Widget config object. Structure depends on report_type: " +
+    "STANDARD: {data_source:'companies'|'deals'|'people', report_type:'standard', " +
+    "dimension:{field:'<field_key>', is_custom_field:boolean, time_grouping?:'day'|'week'|'month'|'quarter'|'year'}, " +
+    "measure:{aggregation:'COUNT'|'SUM'|'AVG'|'MIN'|'MAX', field:'*'|'<field_key>', is_custom_field:boolean}, " +
+    "segment_by?:{field:'<field_key>', is_custom_field:boolean}, " +
+    "filter?:{operator:'AND'|'OR', conditions:[...], groups:[...]}, " +
+    "date_range?:{type:'relative', relative_period:'all_time'|'last_7_days'|'last_30_days'|'last_90_days'|'this_month'|'last_month'|'this_quarter'|'last_quarter'|'this_year'|'last_year'} " +
+    "OR {type:'absolute', start_date:'YYYY-MM-DD', end_date:'YYYY-MM-DD'}, " +
+    "included_stages?:['value1','value2'], show_axis_labels?:boolean, show_zeros?:boolean, sort_by_stage_order?:boolean}. " +
+    "FUNNEL: {report_type:'funnel', entity_type:'company'|'deal'|'person', stage_field:'<field_key>', " +
+    "included_stages?:['stage1','stage2'], date_range?:{...}, filter?:{...}}. " +
+    "HISTORICAL: {report_type:'stage_changes', entity_type:'company'|'deal'|'person', " +
+    "field_permalink:'<field_key>', time_grouping?:'day'|'week'|'month'|'quarter'|'year', date_range?:{...}}. " +
+    "ALWAYS call lighthouse_crm_get_attributes first to discover valid field keys for dimension, measure, and stage_field.";
+server.registerTool("lighthouse_reports_list_dashboards", {
+    title: "List Dashboards",
+    description: "List all report dashboards accessible to the current user. " +
+        "Returns dashboards you own, workspace-shared dashboards, and team-shared dashboards.",
+    inputSchema: {},
+}, async () => {
+    try {
+        const res = await api.get("/dashboards");
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_reports_create_dashboard", {
+    title: "Create Dashboard",
+    description: "Create a new report dashboard. Dashboards contain report widgets (charts, tables, KPIs). " +
+        "Requires reports.create permission.",
+    inputSchema: {
+        name: z.string().describe("Dashboard name"),
+        description: z.string().optional().describe("Dashboard description"),
+        sharing: z
+            .enum(["private", "workspace"])
+            .default("private")
+            .describe("Visibility: 'private' (only you) or 'workspace' (all members)"),
+        team_ids: z
+            .array(z.string().uuid())
+            .optional()
+            .describe("Team IDs to share this dashboard with"),
+    },
+}, async (params) => {
+    try {
+        const res = await api.post("/dashboards", params);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_reports_get_dashboard", {
+    title: "Get Dashboard",
+    description: "Get a single dashboard by ID with all its widgets.",
+    inputSchema: {
+        id: z.string().uuid().describe("Dashboard ID"),
+    },
+}, async (params) => {
+    try {
+        const res = await api.get(`/dashboards/${params.id}`);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_reports_update_dashboard", {
+    title: "Update Dashboard",
+    description: "Update a dashboard's name, description, or sharing. Only the dashboard owner can update.",
+    inputSchema: {
+        id: z.string().uuid().describe("Dashboard ID"),
+        name: z.string().optional().describe("New dashboard name"),
+        description: z.string().optional().describe("New description"),
+        sharing: z.enum(["private", "workspace"]).optional().describe("New visibility setting"),
+    },
+}, async (params) => {
+    try {
+        const { id, ...body } = params;
+        const res = await api.patch(`/dashboards/${id}`, body);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_reports_delete_dashboard", {
+    title: "Delete Dashboard",
+    description: "Permanently delete a dashboard and all its widgets. Only the dashboard owner can delete.",
+    inputSchema: {
+        id: z.string().uuid().describe("Dashboard ID"),
+    },
+}, async (params) => {
+    try {
+        const res = await api.delete(`/dashboards/${params.id}`);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_reports_refresh_dashboard", {
+    title: "Refresh Dashboard Data",
+    description: "Refresh/fetch report data for all widgets in a dashboard. " +
+        "Returns a map of { widget_id: report_data } for each widget.",
+    inputSchema: {
+        id: z.string().uuid().describe("Dashboard ID"),
+    },
+}, async (params) => {
+    try {
+        const res = await api.post(`/dashboards/${params.id}/refresh`);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+// ─── Reports: Widgets ────────────────────────────────────
+server.registerTool("lighthouse_reports_list_widgets", {
+    title: "List Dashboard Widgets",
+    description: "Get all widgets for a dashboard.",
+    inputSchema: {
+        id: z.string().uuid().describe("Dashboard ID"),
+    },
+}, async (params) => {
+    try {
+        const res = await api.get(`/dashboards/${params.id}/widgets`);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_reports_create_widget", {
+    title: "Create Report Widget",
+    description: "Create a report widget (chart/table/KPI) on a dashboard. " +
+        "WORKFLOW: 1) Call lighthouse_crm_get_attributes to discover field keys for the entity type, " +
+        "2) Build a config object using those keys, 3) Create the widget. " +
+        "Widget types: bar, line, pie, table, kpi, funnel, area. " +
+        "Report types: standard (aggregate by field), funnel (pipeline conversion), stage_changes (historical transitions).",
+    inputSchema: {
+        dashboard_id: z.string().uuid().describe("Dashboard ID to add widget to"),
+        name: z.string().describe("Widget/report name"),
+        widget_type: z
+            .enum(["bar", "line", "pie", "table", "kpi", "funnel", "area"])
+            .describe("Visualization type"),
+        config: z.record(z.unknown()).describe(WIDGET_CONFIG_DESCRIPTION),
+        position: z
+            .record(z.unknown())
+            .optional()
+            .describe("Grid position: {x: number, y: number, w: number, h: number}"),
+    },
+}, async (params) => {
+    try {
+        const { dashboard_id, ...body } = params;
+        const res = await api.post(`/dashboards/${dashboard_id}/widgets`, body);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_reports_update_widget", {
+    title: "Update Report Widget",
+    description: "Update a report widget's name, type, config, or position. " +
+        "Only provide fields you want to change — others are preserved.",
+    inputSchema: {
+        dashboard_id: z.string().uuid().describe("Dashboard ID"),
+        widget_id: z.string().uuid().describe("Widget ID"),
+        name: z.string().optional().describe("New widget name"),
+        widget_type: z
+            .enum(["bar", "line", "pie", "table", "kpi", "funnel", "area"])
+            .optional()
+            .describe("New visualization type"),
+        config: z.record(z.unknown()).optional().describe(WIDGET_CONFIG_DESCRIPTION),
+        position: z.record(z.unknown()).optional().describe("New grid position: {x, y, w, h}"),
+    },
+}, async (params) => {
+    try {
+        const { dashboard_id, widget_id, ...body } = params;
+        const res = await api.patch(`/dashboards/${dashboard_id}/widgets/${widget_id}`, body);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_reports_delete_widget", {
+    title: "Delete Report Widget",
+    description: "Permanently delete a report widget from a dashboard.",
+    inputSchema: {
+        dashboard_id: z.string().uuid().describe("Dashboard ID"),
+        widget_id: z.string().uuid().describe("Widget ID"),
+    },
+}, async (params) => {
+    try {
+        const res = await api.delete(`/dashboards/${params.dashboard_id}/widgets/${params.widget_id}`);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_reports_get_widget_data", {
+    title: "Get Widget Report Data",
+    description: "Fetch the aggregated report data for a specific widget. " +
+        "Returns the computed data based on the widget's config (dimensions, measures, segments, filters). " +
+        "For standard reports: array of {dimension, measure, segment?} rows. " +
+        "For funnel reports: array of {stage, count} rows. " +
+        "For historical reports: array of {period, from_stage, to_stage, transition_count} rows.",
+    inputSchema: {
+        dashboard_id: z.string().uuid().describe("Dashboard ID"),
+        widget_id: z.string().uuid().describe("Widget ID"),
+    },
+}, async (params) => {
+    try {
+        const res = await api.get(`/dashboards/${params.dashboard_id}/widgets/${params.widget_id}/data`);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+// ─── Sharing: Dashboard Teams ─────────────────────────────
+server.registerTool("lighthouse_reports_share_dashboard_with_teams", {
+    title: "Share Dashboard with Teams",
+    description: "Grant team-level access to a dashboard. Only the dashboard owner can share. " +
+        "Use lighthouse_workspace_list_teams to find team IDs first. " +
+        "Requires reports.edit permission.",
+    inputSchema: {
+        id: z.string().uuid().describe("Dashboard ID"),
+        team_ids: z.array(z.string().uuid()).describe("Array of team UUIDs to grant access to"),
+    },
+}, async (params) => {
+    try {
+        const { id, ...body } = params;
+        const res = await api.post(`/dashboards/${id}/teams`, body);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_reports_revoke_dashboard_from_teams", {
+    title: "Revoke Dashboard Team Access",
+    description: "Revoke team-level access from a dashboard. Only the dashboard owner can revoke. " +
+        "Requires reports.edit permission.",
+    inputSchema: {
+        id: z.string().uuid().describe("Dashboard ID"),
+        team_ids: z.array(z.string().uuid()).describe("Array of team UUIDs to revoke access from"),
+    },
+}, async (params) => {
+    try {
+        const { id, ...body } = params;
+        const res = await api.delete(`/dashboards/${id}/teams`, body);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+// ─── Sharing: View Teams ──────────────────────────────────
+server.registerTool("lighthouse_crm_share_view_with_teams", {
+    title: "Share View with Teams",
+    description: "Grant team-level access to a CRM view. Only the view owner can share. " +
+        "Use lighthouse_workspace_list_teams to find team IDs first. " +
+        "Requires views.share permission.",
+    inputSchema: {
+        id: z.string().uuid().describe("View ID"),
+        team_ids: z.array(z.string().uuid()).describe("Array of team UUIDs to grant access to"),
+    },
+}, async (params) => {
+    try {
+        const { id, ...body } = params;
+        const res = await api.post(`/views/${id}/teams`, body);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_crm_revoke_view_from_teams", {
+    title: "Revoke View Team Access",
+    description: "Revoke team-level access from a CRM view. Only the view owner can revoke. " +
+        "Requires views.share permission.",
+    inputSchema: {
+        id: z.string().uuid().describe("View ID"),
+        team_ids: z.array(z.string().uuid()).describe("Array of team UUIDs to revoke access from"),
+    },
+}, async (params) => {
+    try {
+        const { id, ...body } = params;
+        const res = await api.delete(`/views/${id}/teams`, body);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
+server.registerTool("lighthouse_crm_update_view_sharing", {
+    title: "Update View Sharing Status",
+    description: "Change a CRM view's sharing visibility. Setting to 'private' also removes all team permissions. " +
+        "Only the view owner can change sharing. Requires views.share permission.",
+    inputSchema: {
+        id: z.string().uuid().describe("View ID"),
+        sharing: z.enum(["private", "workspace"]).describe("New sharing visibility"),
+    },
+}, async (params) => {
+    try {
+        const { id, ...body } = params;
+        const res = await api.patch(`/views/${id}/sharing`, body);
+        return text(res);
+    }
+    catch (e) {
+        return err(`Failed: ${e instanceof Error ? e.message : String(e)}`);
+    }
+});
 // ─── Start ───────────────────────────────────────────────
 async function main() {
     const transport = new StdioServerTransport();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trylighthouse/mcp-server",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "MCP server for the Lighthouse CRM API",
   "type": "module",
   "bin": {