@outlit/tools 0.2.1 → 0.3.0

package/README.md

@@ -0,0 +1,28 @@
+# @outlit/tools
+
+Customer intelligence tool contracts and API client helpers for Outlit agents.
+
+This package mirrors the public tool gateway contracts used by Outlit CLI, Pi, and agent integrations. The hosted remote MCP server implementation does not live in this repository; discover runtime MCP metadata from the canonical Outlit endpoints below.
+
+Outlit is the real-time understanding of every customer, the infrastructure agents use to automate customer operations.
+
+## Canonical Docs
+
+- Tool gateway API docs: <https://docs.outlit.ai/api-reference/tools>
+- API overview: <https://docs.outlit.ai/api-reference/introduction>
+- OpenAPI spec: <https://docs.outlit.ai/openapi.json>
+- MCP integration docs: <https://docs.outlit.ai/ai-integrations/mcp>
+- MCP server metadata: <https://mcp.outlit.ai/.well-known/mcp/server.json>
+- MCP server card: <https://mcp.outlit.ai/.well-known/mcp/server-card.json>
+- Official MCP Registry listing: <https://registry.modelcontextprotocol.io/v0.1/servers?search=ai.outlit/outlit>
+- Agent-facing docs index: <https://docs.outlit.ai/llms.txt>
+
+## When to use this package
+
+Install `@outlit/tools` when you are building a custom agent, server-side integration, or API client that calls the Outlit tool gateway directly and needs typed tool contracts.
+
+Use the hosted remote MCP server instead when you are connecting an MCP client such as Claude Desktop, Cursor, Codex, or another agent runtime. Use `@outlit/cli` for terminal workflows, and use `@outlit/pi` when building Pi agents that need Outlit tool and skill guidance.
+
+```bash
+npm install @outlit/tools
+```

package/dist/index.cjs

@@ -53,7 +53,8 @@ __export(src_exports, {
   timelineTimeframes: () => timelineTimeframes,
   unsupportedCustomerFactTypes: () => unsupportedCustomerFactTypes,
   userJourneyStages: () => userJourneyStages,
-  userListOrderFields: () => userListOrderFields
+  userListOrderFields: () => userListOrderFields,
+  workspaceUserListOrderFields: () => workspaceUserListOrderFields
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -61,6 +62,7 @@ module.exports = __toCommonJS(src_exports);
 var customerToolNames = [
   "outlit_list_customers",
   "outlit_list_users",
+  "outlit_list_workspace_users",
   "outlit_get_customer",
   "outlit_get_timeline",
   "outlit_list_facts",
@@ -77,7 +79,8 @@ var customerSourceTypes = [
   "CALL",
   "CALENDAR_EVENT",
   "SUPPORT_TICKET",
-  "OPPORTUNITY"
+  "OPPORTUNITY",
+  "SLACK"
 ];
 var customerSourceTypeAliases = ["CRM", "CRM_OPPORTUNITY"];
 var customerSourceTypeInputs = [
@@ -86,17 +89,25 @@ var customerSourceTypeInputs = [
   "CALENDAR_EVENT",
   "SUPPORT_TICKET",
   "OPPORTUNITY",
+  "SLACK",
   "CRM",
   "CRM_OPPORTUNITY"
 ];
 var customerToolContracts = {
   outlit_list_customers: {
     toolName: "outlit_list_customers",
+    title: "List Customers",
     description: "Browse and filter customers. Use this to find customers by billing status, activity recency, revenue, or name. Returns a paginated list with summary info (MRR, last activity, status).",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
       type: "object",
       properties: {
+        activatedSince: {
+          description: "Filter customers activated at or after this ISO-8601 datetime",
+          type: "string",
+          format: "date-time",
+          pattern: "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
+        },
         billingStatus: {
           description: "Filter by billing status",
           type: "string",
@@ -149,6 +160,20 @@ var customerToolContracts = {
           type: "string",
           maxLength: 500
         },
+        ownerId: {
+          description: "Filter customers by internal owner user ID",
+          type: "string",
+          maxLength: 500
+        },
+        ownerEmail: {
+          description: "Filter customers by internal owner email address",
+          type: "string",
+          maxLength: 500
+        },
+        hasOwner: {
+          description: "Filter customers by whether they have an owner",
+          type: "boolean"
+        },
         limit: {
           description: "Results per page (max 1000)",
           default: 50,
@@ -178,6 +203,7 @@ var customerToolContracts = {
   },
   outlit_list_users: {
     toolName: "outlit_list_users",
+    title: "List Users",
     description: "Browse and filter users. Use this to find users by journey stage, activity recency, customer, or email/name. Returns a paginated list with activity info.",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
@@ -257,8 +283,63 @@ var customerToolContracts = {
       additionalProperties: false
     }
   },
+  outlit_list_workspace_users: {
+    toolName: "outlit_list_workspace_users",
+    title: "List Workspace Users",
+    description: "Browse internal workspace users such as CSMs, managers, account owners, and admins. Use this to discover who owns customers before composing dynamic reports across account books.",
+    inputSchema: {
+      $schema: "https://json-schema.org/draft/2020-12/schema",
+      type: "object",
+      properties: {
+        search: {
+          description: "Search internal workspace users by name, email, title, role, or territory",
+          type: "string",
+          maxLength: 500
+        },
+        role: {
+          description: "Filter internal workspace users by role metadata when available",
+          type: "string",
+          maxLength: 100
+        },
+        managerEmail: {
+          description: "Filter internal workspace users by manager email metadata when available",
+          type: "string",
+          maxLength: 500
+        },
+        hasOwnedCustomers: {
+          description: "When true, return only workspace users who own at least one customer",
+          type: "boolean"
+        },
+        limit: {
+          description: "Results per page (max 1000)",
+          default: 50,
+          type: "number",
+          minimum: 1,
+          maximum: 1e3
+        },
+        cursor: {
+          description: "Pagination cursor from previous response",
+          type: "string"
+        },
+        orderBy: {
+          description: "Field to order workspace users by",
+          default: "owned_customer_count",
+          type: "string",
+          enum: ["name", "email", "owned_customer_count"]
+        },
+        orderDirection: {
+          description: "Sort direction",
+          default: "desc",
+          type: "string",
+          enum: ["asc", "desc"]
+        }
+      },
+      additionalProperties: false
+    }
+  },
   outlit_get_customer: {
     toolName: "outlit_get_customer",
+    title: "Get Customer",
     description: "Get full details for a single customer. Use this when you already know which customer you want to inspect. Optionally include related data (users, revenue, recent activity, engagement metrics).",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
@@ -289,6 +370,7 @@ var customerToolContracts = {
   },
   outlit_get_timeline: {
     toolName: "outlit_get_timeline",
+    title: "Get Customer Timeline",
     description: "Get the chronological activity timeline for a customer. Use this to see what happened and when \u2014 emails, calls, Slack messages, billing events, etc. Supports channel and date filtering.",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
@@ -299,20 +381,20 @@ var customerToolContracts = {
           description: "Customer ID or domain"
         },
         channels: {
-          description: "Filter by event channel (e.g., EMAIL, SLACK, CALL, CALENDAR)",
+          description: "Filter by event channel. Use values such as PRODUCT, COMMUNICATION, MEETING, CRM, BILLING, SUPPORT, IDENTITY, DOCUMENT, or SYSTEM.",
           type: "array",
           items: {
             type: "string",
             enum: [
-              "SDK",
-              "EMAIL",
-              "SLACK",
-              "CALL",
-              "CALENDAR",
+              "PRODUCT",
+              "COMMUNICATION",
+              "MEETING",
               "CRM",
               "BILLING",
               "SUPPORT",
-              "INTERNAL"
+              "IDENTITY",
+              "DOCUMENT",
+              "SYSTEM"
             ]
           }
         },
@@ -358,6 +440,7 @@ var customerToolContracts = {
   },
   outlit_list_facts: {
     toolName: "outlit_list_facts",
+    title: "List Customer Facts",
     description: "List structured facts known about a customer. Use filters like status, sourceTypes, factTypes, factCategories, and date bounds to narrow the result set. For topic-specific retrieval, use outlit_search_customer_context instead.",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
@@ -447,6 +530,7 @@ var customerToolContracts = {
   },
   outlit_get_fact: {
     toolName: "outlit_get_fact",
+    title: "Get Customer Fact",
     description: "Get one exact fact by ID. Returns the canonical fact shape and optionally expands requested related data such as evidence.",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
@@ -474,6 +558,7 @@ var customerToolContracts = {
   },
   outlit_get_source: {
     toolName: "outlit_get_source",
+    title: "Get Source",
     description: "Get one exact source record by generic sourceType and sourceId. Use this when you already know the concrete underlying source you want to inspect.",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
@@ -495,6 +580,7 @@ var customerToolContracts = {
   },
   outlit_list_sources: {
     toolName: "outlit_list_sources",
+    title: "List Sources",
     description: "List concrete source records deterministically. Use this instead of semantic search when you need enumerated calls, emails, calendar events, support tickets, or opportunities.",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
@@ -558,7 +644,8 @@ var customerToolContracts = {
   },
   outlit_search_customer_context: {
     toolName: "outlit_search_customer_context",
-    description: "Search across all known customer context using a natural-language query. Returns grouped artifact-level results for matching sources and facts. Omit customer to search across all customers in the organization.",
+    title: "Search Customer Context",
+    description: "Search across all known customer context using a natural-language query. Returns ranked artifact-level discovery previews with at most two matching excerpts per source or fact. Use outlit_get_source with a returned sourceType and sourceId when you need the canonical source contents. Omit customer to search across all customers in the organization.",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
       type: "object",
@@ -615,6 +702,7 @@ var customerToolContracts = {
   },
   outlit_query: {
     toolName: "outlit_query",
+    title: "Run SQL Query",
     description: "Execute read-only SQL queries against your analytics views.\n\nAvailable views:\n- activity: Customer activity events (event_name, event_type, event_channel, customer_id, occurred_at, properties, ...)\n- customers: Customer attributes (customer_id, domain, name, billing_status, plan, mrr_cents, traits, ...)\n- users: User attributes (user_id, email, name, customer_id, traits, ...)\n- revenue: Revenue snapshots over time (customer_id, snapshot_date, mrr_cents, ...)\n\nAll queries are automatically filtered to your organization's data.\nOnly SELECT queries are allowed.\nProperties and traits are JSON strings; inspect schemas and examples before filtering nested values.\n\nExample queries:\n- SELECT event_name, count(*) FROM activity GROUP BY 1 ORDER BY 2 DESC LIMIT 10\n- SELECT billing_status, sum(mrr_cents)/100 as mrr FROM customers GROUP BY 1\n- SELECT * FROM activity WHERE customer_id = 'cust_123' ORDER BY occurred_at DESC LIMIT 50",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
@@ -638,6 +726,7 @@ var customerToolContracts = {
   },
   outlit_schema: {
     toolName: "outlit_schema",
+    title: "Get SQL Schema",
     description: "Get schemas for available analytics views.\n\nUse this to discover column names, types, and descriptions before writing SQL queries.\nReturns column definitions and example queries for each view.",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
@@ -654,6 +743,7 @@ var customerToolContracts = {
   },
   outlit_send_notification: {
     toolName: "outlit_send_notification",
+    title: "Send Notification",
     description: "Send or post a notification. Use only when the user explicitly asks you to send, post, or notify. Slack is the default notifier when destinations are omitted.",
     inputSchema: {
       $schema: "https://json-schema.org/draft/2020-12/schema",
@@ -698,34 +788,15 @@ var customerToolContracts = {
           minLength: 1,
           maxLength: 240
         },
-        destinations: {
-          description: "Optional explicit notification destinations. Omit to use the default notifier.",
+        destinationIds: {
+          description: "Optional NotificationDestination ids. Omit to use the default notifier.",
           minItems: 1,
           maxItems: 10,
           type: "array",
           items: {
-            type: "object",
-            properties: {
-              provider: {
-                description: "Notification provider",
-                type: "string",
-                enum: ["slack"]
-              },
-              channelId: {
-                description: "Provider-specific destination channel ID",
-                type: "string",
-                minLength: 1,
-                maxLength: 240
-              },
-              label: {
-                description: "Optional destination label",
-                type: "string",
-                minLength: 1,
-                maxLength: 120
-              }
-            },
-            required: ["provider"],
-            additionalProperties: false
+            type: "string",
+            format: "uuid",
+            pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
           }
         }
       },
@@ -831,15 +902,15 @@ var customerTimeframes = ["7d", "14d", "30d", "90d"];
 var notificationProviderValues = ["slack"];
 var notificationSeverityValues = ["low", "medium", "high"];
 var timelineChannels = [
-  "SDK",
-  "EMAIL",
-  "SLACK",
-  "CALL",
-  "CALENDAR",
+  "PRODUCT",
+  "COMMUNICATION",
+  "MEETING",
   "CRM",
   "BILLING",
   "SUPPORT",
-  "INTERNAL"
+  "IDENTITY",
+  "DOCUMENT",
+  "SYSTEM"
 ];
 var timelineTimeframes = ["7d", "14d", "30d", "90d", "all"];
 var userJourneyStages = [
@@ -850,8 +921,9 @@ var userJourneyStages = [
   "INACTIVE"
 ];
 var userListOrderFields = ["last_activity_at", "first_seen_at", "email"];
+var workspaceUserListOrderFields = ["name", "email", "owned_customer_count"];
 var schemaTables = ["activity", "customers", "users", "revenue"];
-var customerToolContractHash = "5016d146842452855bfdd9ecc8f6be1a122125d0c392ceff315aeb2e44fefc7f";
+var customerToolContractHash = "f1f06ac1d3fb5131095ac7047f5871f47942b0f5efcb1229151b52475bf93816";
 var customerToolNameSet = new Set(customerToolNames);
 var customerSourceTypeSet = new Set(customerSourceTypes);
 var customerSourceTypeAliasMap = /* @__PURE__ */ new Map([
@@ -975,7 +1047,7 @@ function createOutlitClient(options) {
         const text = await response.text();
         throw new Error(`API error (${response.status}): ${text}`);
       }
-      return response.json();
+      return await response.json();
     }
   };
 }
@@ -987,6 +1059,7 @@ var actionToolNames = [
 var defaultAgentToolNames = [
   "outlit_list_customers",
   "outlit_list_users",
+  "outlit_list_workspace_users",
   "outlit_get_customer",
   "outlit_get_timeline",
   "outlit_list_facts",
@@ -1039,6 +1112,7 @@ var allCustomerToolNames = customerToolNames;
   timelineTimeframes,
   unsupportedCustomerFactTypes,
   userJourneyStages,
-  userListOrderFields
+  userListOrderFields,
+  workspaceUserListOrderFields
 });
 //# sourceMappingURL=index.cjs.map