@vantageos/vantage-crm-mcp 0.1.0

package/dist/mcp-server/tools/customObjects.js

@@ -0,0 +1,235 @@
+"use strict";
+/**
+ * VantageCRM MCP — Custom Objects tools (7 tools)
+ *
+ * Tools: add_custom_object, list_custom_objects, create_record, update_record,
+ *        delete_record, list_records, search_records
+ *
+ * Scope: admin for DDL (add_custom_object), write/read for DML
+ * Ref: spec §3.7
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CUSTOM_OBJECT_TOOLS = void 0;
+exports.add_custom_object = add_custom_object;
+exports.list_custom_objects = list_custom_objects;
+exports.create_record = create_record;
+exports.update_record = update_record;
+exports.delete_record = delete_record;
+exports.list_records = list_records;
+exports.search_records = search_records;
+const zod_1 = require("zod");
+const server_1 = require("convex/server");
+const convexClient_1 = require("../lib/convexClient");
+// ---------------------------------------------------------------------------
+// Zod schemas
+// ---------------------------------------------------------------------------
+const AddCustomObjectSchema = zod_1.z.object({
+    workspaceId: zod_1.z.string().min(1),
+    objectType: zod_1.z.string().min(1).max(100).regex(/^[a-z0-9_]+$/, 'Type must be snake_case'),
+    label: zod_1.z.string().min(1).max(200),
+    labelPlural: zod_1.z.string().min(1).max(200),
+    description: zod_1.z.string().max(1000).optional(),
+    fields: zod_1.z.array(zod_1.z.object({
+        key: zod_1.z.string().min(1),
+        label: zod_1.z.string().min(1),
+        fieldType: zod_1.z.string().min(1),
+        required: zod_1.z.boolean().default(false),
+    })).optional(),
+});
+const ListCustomObjectsSchema = zod_1.z.object({
+    workspaceId: zod_1.z.string().min(1),
+});
+const CreateRecordSchema = zod_1.z.object({
+    workspaceId: zod_1.z.string().min(1),
+    objectType: zod_1.z.string().min(1),
+    fields: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
+    relatedContactId: zod_1.z.string().optional(),
+    relatedDealId: zod_1.z.string().optional(),
+    relatedCompanyId: zod_1.z.string().optional(),
+});
+const UpdateRecordSchema = zod_1.z.object({
+    recordId: zod_1.z.string().min(1),
+    fields: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
+});
+const DeleteRecordSchema = zod_1.z.object({
+    recordId: zod_1.z.string().min(1),
+});
+const ListRecordsSchema = zod_1.z.object({
+    workspaceId: zod_1.z.string().min(1),
+    objectType: zod_1.z.string().min(1),
+    limit: zod_1.z.number().int().min(1).max(100).default(20),
+});
+const SearchRecordsSchema = zod_1.z.object({
+    workspaceId: zod_1.z.string().min(1),
+    objectType: zod_1.z.string().min(1),
+    query: zod_1.z.string().min(1).max(200),
+    limit: zod_1.z.number().int().min(1).max(50).default(10),
+});
+// ---------------------------------------------------------------------------
+// Handlers
+// ---------------------------------------------------------------------------
+async function add_custom_object(rawArgs) {
+    const args = AddCustomObjectSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => (0, convexClient_1.getConvexClient)().mutation(server_1.anyApi.crm.customObjects.defineCustomObject, {
+        workspaceId: args.workspaceId,
+        objectType: args.objectType,
+        label: args.label,
+        labelPlural: args.labelPlural,
+        description: args.description,
+        fields: args.fields,
+    }));
+}
+async function list_custom_objects(rawArgs) {
+    const args = ListCustomObjectsSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => (0, convexClient_1.getConvexClient)().query(server_1.anyApi.crm.customObjects.listCustomObjectDefinitions, {
+        workspaceId: args.workspaceId,
+    }));
+}
+async function create_record(rawArgs) {
+    const args = CreateRecordSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => (0, convexClient_1.getConvexClient)().mutation(server_1.anyApi.crm.customObjects.createCustomObjectRecord, {
+        workspaceId: args.workspaceId,
+        objectType: args.objectType,
+        fields: args.fields,
+        relatedContactId: args.relatedContactId,
+        relatedDealId: args.relatedDealId,
+        relatedCompanyId: args.relatedCompanyId,
+    }));
+}
+async function update_record(rawArgs) {
+    const args = UpdateRecordSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => (0, convexClient_1.getConvexClient)().mutation(server_1.anyApi.crm.customObjects.updateCustomObjectRecord, {
+        recordId: args.recordId,
+        fields: args.fields,
+    }));
+}
+async function delete_record(rawArgs) {
+    const args = DeleteRecordSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => (0, convexClient_1.getConvexClient)().mutation(server_1.anyApi.crm.customObjects.archiveCustomObjectRecord, {
+        recordId: args.recordId,
+    }));
+}
+async function list_records(rawArgs) {
+    const args = ListRecordsSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => (0, convexClient_1.getConvexClient)().query(server_1.anyApi.crm.customObjects.listCustomObjectRecords, {
+        workspaceId: args.workspaceId,
+        objectType: args.objectType,
+        limit: args.limit,
+    }));
+}
+async function search_records(rawArgs) {
+    const args = SearchRecordsSchema.parse(rawArgs);
+    // Client-side filter — no Convex search index for custom objects in V0.1.0
+    return (0, convexClient_1.withEnvelope)(async () => {
+        const all = await (0, convexClient_1.getConvexClient)().query(server_1.anyApi.crm.customObjects.listCustomObjectRecords, {
+            workspaceId: args.workspaceId,
+            objectType: args.objectType,
+            limit: 200,
+        });
+        const q = args.query.toLowerCase();
+        return all
+            .filter((r) => JSON.stringify(r['fields'] ?? {}).toLowerCase().includes(q))
+            .slice(0, args.limit);
+    });
+}
+// ---------------------------------------------------------------------------
+// Tool definitions
+// ---------------------------------------------------------------------------
+exports.CUSTOM_OBJECT_TOOLS = [
+    {
+        name: 'add_custom_object',
+        description: 'DDL: define a new custom object type (admin only)',
+        requiredScope: 'admin',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                workspaceId: { type: 'string' },
+                objectType: { type: 'string', description: 'snake_case type key' },
+                label: { type: 'string' },
+                labelPlural: { type: 'string' },
+                description: { type: 'string' },
+                fields: { type: 'array', items: { type: 'object' } },
+            },
+            required: ['workspaceId', 'objectType', 'label', 'labelPlural'],
+        },
+    },
+    {
+        name: 'list_custom_objects',
+        description: 'List custom object type definitions for a workspace',
+        requiredScope: 'read',
+        inputSchema: {
+            type: 'object',
+            properties: { workspaceId: { type: 'string' } },
+            required: ['workspaceId'],
+        },
+    },
+    {
+        name: 'create_record',
+        description: 'DML: create a custom object record',
+        requiredScope: 'write',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                workspaceId: { type: 'string' },
+                objectType: { type: 'string' },
+                fields: { type: 'object' },
+                relatedContactId: { type: 'string' },
+                relatedDealId: { type: 'string' },
+                relatedCompanyId: { type: 'string' },
+            },
+            required: ['workspaceId', 'objectType', 'fields'],
+        },
+    },
+    {
+        name: 'update_record',
+        description: 'Update a custom object record',
+        requiredScope: 'write',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                recordId: { type: 'string' },
+                fields: { type: 'object' },
+            },
+            required: ['recordId', 'fields'],
+        },
+    },
+    {
+        name: 'delete_record',
+        description: 'Soft delete a custom object record',
+        requiredScope: 'write',
+        inputSchema: {
+            type: 'object',
+            properties: { recordId: { type: 'string' } },
+            required: ['recordId'],
+        },
+    },
+    {
+        name: 'list_records',
+        description: 'List custom object records by type',
+        requiredScope: 'read',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                workspaceId: { type: 'string' },
+                objectType: { type: 'string' },
+                limit: { type: 'number' },
+            },
+            required: ['workspaceId', 'objectType'],
+        },
+    },
+    {
+        name: 'search_records',
+        description: 'Full-text search custom object records',
+        requiredScope: 'read',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                workspaceId: { type: 'string' },
+                objectType: { type: 'string' },
+                query: { type: 'string' },
+                limit: { type: 'number' },
+            },
+            required: ['workspaceId', 'objectType', 'query'],
+        },
+    },
+];

package/dist/mcp-server/tools/deals.js

@@ -0,0 +1,297 @@
+"use strict";
+/**
+ * VantageCRM MCP — Deals tools (8 tools)
+ *
+ * Tools: create_deal, get_deal, update_deal, list_deals, search_deals,
+ *        delete_deal, move_deal_stage, forecast_pipeline
+ *
+ * Scope: read for queries, write for mutations
+ * Ref: spec §3.4
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEAL_TOOLS = void 0;
+exports.create_deal = create_deal;
+exports.get_deal = get_deal;
+exports.update_deal = update_deal;
+exports.list_deals = list_deals;
+exports.search_deals = search_deals;
+exports.delete_deal = delete_deal;
+exports.move_deal_stage = move_deal_stage;
+exports.forecast_pipeline = forecast_pipeline;
+const zod_1 = require("zod");
+const api_1 = require("../../convex/_generated/api");
+const convexClient_1 = require("../lib/convexClient");
+// ---------------------------------------------------------------------------
+// Zod schemas
+// ---------------------------------------------------------------------------
+const CreateDealSchema = zod_1.z.object({
+    workspaceId: zod_1.z.string().min(1),
+    title: zod_1.z.string().min(1).max(200),
+    stage: zod_1.z.string().min(1).max(100),
+    value: zod_1.z.number().min(0).optional(),
+    currency: zod_1.z.string().length(3).default('USD'),
+    probability: zod_1.z.number().min(0).max(100).optional(),
+    contactId: zod_1.z.string().optional(),
+    companyId: zod_1.z.string().optional(),
+    expectedCloseDate: zod_1.z.number().optional(),
+    description: zod_1.z.string().max(5000).optional(),
+    tags: zod_1.z.array(zod_1.z.string()).max(20).optional(),
+    customFields: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
+});
+const GetDealSchema = zod_1.z.object({
+    dealId: zod_1.z.string().min(1),
+});
+const UpdateDealSchema = zod_1.z.object({
+    dealId: zod_1.z.string().min(1),
+    title: zod_1.z.string().min(1).max(200).optional(),
+    stage: zod_1.z.string().optional(),
+    value: zod_1.z.number().min(0).optional(),
+    probability: zod_1.z.number().min(0).max(100).optional(),
+    contactId: zod_1.z.string().optional(),
+    companyId: zod_1.z.string().optional(),
+    expectedCloseDate: zod_1.z.number().optional(),
+    description: zod_1.z.string().max(5000).optional(),
+    tags: zod_1.z.array(zod_1.z.string()).max(20).optional(),
+    customFields: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
+});
+const ListDealsSchema = zod_1.z.object({
+    workspaceId: zod_1.z.string().min(1),
+    stage: zod_1.z.string().optional(),
+    contactId: zod_1.z.string().optional(),
+    companyId: zod_1.z.string().optional(),
+    limit: zod_1.z.number().int().min(1).max(100).default(20),
+});
+const SearchDealsSchema = zod_1.z.object({
+    workspaceId: zod_1.z.string().min(1),
+    query: zod_1.z.string().min(1).max(200),
+    limit: zod_1.z.number().int().min(1).max(50).default(10),
+});
+const DeleteDealSchema = zod_1.z.object({
+    dealId: zod_1.z.string().min(1),
+});
+const MoveDealStageSchema = zod_1.z.object({
+    dealId: zod_1.z.string().min(1),
+    newStage: zod_1.z.string().min(1),
+    probability: zod_1.z.number().min(0).max(100).optional(),
+});
+const ForecastPipelineSchema = zod_1.z.object({
+    workspaceId: zod_1.z.string().min(1),
+});
+// ---------------------------------------------------------------------------
+// Handlers
+// ---------------------------------------------------------------------------
+async function create_deal(rawArgs) {
+    const args = CreateDealSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (0, convexClient_1.getConvexClient)().mutation(api_1.api.crm.deals.create, {
+        workspaceId: args.workspaceId,
+        title: args.title,
+        stage: args.stage,
+        value: args.value,
+        currency: args.currency,
+        probability: args.probability,
+        contactId: args.contactId,
+        companyId: args.companyId,
+        expectedCloseDate: args.expectedCloseDate,
+        description: args.description,
+        tags: args.tags,
+        customFields: args.customFields,
+    }));
+}
+async function get_deal(rawArgs) {
+    const args = GetDealSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (0, convexClient_1.getConvexClient)().query(api_1.api.crm.deals.get, {
+        dealId: args.dealId,
+    }));
+}
+async function update_deal(rawArgs) {
+    const args = UpdateDealSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (0, convexClient_1.getConvexClient)().mutation(api_1.api.crm.deals.update, {
+        dealId: args.dealId,
+        title: args.title,
+        stage: args.stage,
+        value: args.value,
+        probability: args.probability,
+        contactId: args.contactId,
+        companyId: args.companyId,
+        expectedCloseDate: args.expectedCloseDate,
+        description: args.description,
+        tags: args.tags,
+        customFields: args.customFields,
+    }));
+}
+async function list_deals(rawArgs) {
+    const args = ListDealsSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (0, convexClient_1.getConvexClient)().query(api_1.api.crm.deals.list, {
+        workspaceId: args.workspaceId,
+        stage: args.stage,
+        contactId: args.contactId,
+        companyId: args.companyId,
+        limit: args.limit,
+    }));
+}
+async function search_deals(rawArgs) {
+    const args = SearchDealsSchema.parse(rawArgs);
+    // Convex layer does not expose a standalone search query for deals yet — filter client-side
+    return (0, convexClient_1.withEnvelope)(async () => {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const all = await (0, convexClient_1.getConvexClient)().query(api_1.api.crm.deals.list, {
+            workspaceId: args.workspaceId,
+            limit: 200,
+        });
+        const q = args.query.toLowerCase();
+        return all
+            .filter((d) => String(d['title'] ?? '').toLowerCase().includes(q) ||
+            String(d['searchableText'] ?? '').toLowerCase().includes(q))
+            .slice(0, args.limit);
+    });
+}
+async function delete_deal(rawArgs) {
+    const args = DeleteDealSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (0, convexClient_1.getConvexClient)().mutation(api_1.api.crm.deals.remove, {
+        dealId: args.dealId,
+    }));
+}
+async function move_deal_stage(rawArgs) {
+    const args = MoveDealStageSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (0, convexClient_1.getConvexClient)().mutation(api_1.api.crm.deals.moveStage, {
+        dealId: args.dealId,
+        newStage: args.newStage,
+        probability: args.probability,
+    }));
+}
+async function forecast_pipeline(rawArgs) {
+    const args = ForecastPipelineSchema.parse(rawArgs);
+    return (0, convexClient_1.withEnvelope)(() => 
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    (0, convexClient_1.getConvexClient)().query(api_1.api.crm.deals.forecast, {
+        workspaceId: args.workspaceId,
+    }));
+}
+// ---------------------------------------------------------------------------
+// Tool definitions
+// ---------------------------------------------------------------------------
+exports.DEAL_TOOLS = [
+    {
+        name: 'create_deal',
+        description: 'Create a deal in the CRM pipeline',
+        requiredScope: 'write',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                workspaceId: { type: 'string' },
+                title: { type: 'string' },
+                stage: { type: 'string' },
+                value: { type: 'number' },
+                currency: { type: 'string' },
+                probability: { type: 'number' },
+                contactId: { type: 'string' },
+                companyId: { type: 'string' },
+                expectedCloseDate: { type: 'number' },
+                description: { type: 'string' },
+            },
+            required: ['workspaceId', 'title', 'stage'],
+        },
+    },
+    {
+        name: 'get_deal',
+        description: 'Retrieve a deal by ID',
+        requiredScope: 'read',
+        inputSchema: {
+            type: 'object',
+            properties: { dealId: { type: 'string' } },
+            required: ['dealId'],
+        },
+    },
+    {
+        name: 'update_deal',
+        description: 'Update deal fields',
+        requiredScope: 'write',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                dealId: { type: 'string' },
+                title: { type: 'string' },
+                stage: { type: 'string' },
+                value: { type: 'number' },
+                probability: { type: 'number' },
+            },
+            required: ['dealId'],
+        },
+    },
+    {
+        name: 'list_deals',
+        description: 'List deals by workspace/stage/contact/company',
+        requiredScope: 'read',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                workspaceId: { type: 'string' },
+                stage: { type: 'string' },
+                contactId: { type: 'string' },
+                companyId: { type: 'string' },
+                limit: { type: 'number' },
+            },
+            required: ['workspaceId'],
+        },
+    },
+    {
+        name: 'search_deals',
+        description: 'Full-text search deals by title',
+        requiredScope: 'read',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                workspaceId: { type: 'string' },
+                query: { type: 'string' },
+                limit: { type: 'number' },
+            },
+            required: ['workspaceId', 'query'],
+        },
+    },
+    {
+        name: 'delete_deal',
+        description: 'Soft delete a deal (isArchived=true)',
+        requiredScope: 'write',
+        inputSchema: {
+            type: 'object',
+            properties: { dealId: { type: 'string' } },
+            required: ['dealId'],
+        },
+    },
+    {
+        name: 'move_deal_stage',
+        description: 'Move a deal to a new stage with optional probability override (OQ-2)',
+        requiredScope: 'write',
+        inputSchema: {
+            type: 'object',
+            properties: {
+                dealId: { type: 'string' },
+                newStage: { type: 'string' },
+                probability: { type: 'number', minimum: 0, maximum: 100 },
+            },
+            required: ['dealId', 'newStage'],
+        },
+    },
+    {
+        name: 'forecast_pipeline',
+        description: 'Compute weighted pipeline value (Σ value × probability) for a workspace',
+        requiredScope: 'read',
+        inputSchema: {
+            type: 'object',
+            properties: { workspaceId: { type: 'string' } },
+            required: ['workspaceId'],
+        },
+    },
+];