ethos-cli 0.7.18 → 0.7.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ethos-cli",
3
- "version": "0.7.18",
3
+ "version": "0.7.20",
4
4
  "description": "Commander-based CLI for Ethos table operations",
5
5
  "homepage": "https://github.com/cluster-software/ethos#readme",
6
6
  "repository": {
@@ -5,15 +5,21 @@ description: Create an Ethos agent through the CLI - company enrichment, person
5
5
 
6
6
  # create-enrichment-agent
7
7
 
8
- This is a thin guide to the Ethos CLI, not a step-by-step workflow. Read the
9
- agent types and command shapes below, then drive the CLI yourself. Use
8
+ Prefer Ethos MCP tools when available. Use `create_agent_column` to add the
9
+ column, then `run_table_column` with `scope: "first_5"` before broader runs.
10
+ Use `search_ethos_tools` plus `call_ethos_tool` for lower-level agent, table,
11
+ or column configuration. Fall back to the CLI command shapes below only when
12
+ MCP tools are unavailable or the user explicitly asks for local CLI control.
13
+
14
+ This is also a thin guide to the Ethos CLI, not a step-by-step workflow. Read
15
+ the agent types and command shapes below, then drive the CLI yourself. Use
10
16
  `--help` on any command and pass `--json` to get machine-readable responses.
11
17
  The production CLI default is `https://api.ethos.hello-cluster.com`, so only
12
18
  pass `--api-url` for local development or an explicitly requested environment.
13
19
 
14
- ## Required CLI
20
+ ## CLI Fallback
15
21
 
16
- The Ethos CLI (`ethos`) is required. Check auth first:
22
+ The Ethos CLI (`ethos`) can run the same workflow locally. Check auth first:
17
23
 
18
24
  ```sh
19
25
  ethos auth status --json
@@ -8,11 +8,23 @@ description: Add work emails and mobile phone numbers to a people table with the
8
8
  Use this when the user wants contact info (work email and/or phone) for people
9
9
  in an Ethos people table. Enrichment runs server-side against a paid data
10
10
  provider with org-level spend limits and an org-scoped cache. Never call
11
- contact data providers directly; always go through the Ethos CLI/backend.
11
+ contact data providers directly; always go through Ethos MCP or the Ethos
12
+ CLI/backend.
12
13
 
13
- ## Required CLI
14
+ ## Preferred Integration
14
15
 
15
- The Ethos CLI (`ethos`) is required. Start with:
16
+ Prefer Ethos MCP tools when available:
17
+
18
+ 1. Call `enrich_contact_info` with the people table, requested fields, and `scope: "first_5"`.
19
+ 2. Inspect the sample result or open the returned table URL.
20
+ 3. Call `enrich_contact_info` with the returned contact-info column ID and `scope: "empty"`.
21
+
22
+ Use the CLI sections below only when MCP tools are unavailable or the user
23
+ explicitly asks for the local CLI.
24
+
25
+ ## CLI Fallback
26
+
27
+ The Ethos CLI (`ethos`) can run the same workflow locally. Start with:
16
28
 
17
29
  ```sh
18
30
  ethos auth status --json
@@ -9,10 +9,24 @@ Use this when the user wants Ethos to source people at a list of companies.
9
9
  The production CLI default is `https://api.ethos.hello-cluster.com`, so only
10
10
  pass `--api-url` for local development or an explicitly requested environment.
11
11
 
12
- ## Required CLI
12
+ ## Preferred Integration
13
13
 
14
- The Ethos CLI (`ethos`) is required. If `ethos` is not installed or not on
15
- `PATH`, install the latest CLI and retry:
14
+ Prefer Ethos MCP tools when available:
15
+
16
+ 1. Reuse an existing handoff token/upload URL if one is already present.
17
+ 2. Otherwise call `create_csv_upload_handoff` with `flow: "find-people-at-companies"`.
18
+ 3. Poll `get_upload_handoff_status` until it returns a `result_table_id`.
19
+ 4. Use `search_ethos_tools` for table inspection if column/view IDs are needed.
20
+ 5. Call `source_people_from_company_table`, then run a small sample first.
21
+
22
+ Use the CLI/hook sections below only when MCP tools are unavailable or the user
23
+ explicitly asks for the local CLI. Avoid creating duplicate handoffs when MCP,
24
+ hooks, or prior context already supplied one.
25
+
26
+ ## CLI Fallback
27
+
28
+ The Ethos CLI (`ethos`) can run the same workflow locally. If `ethos` is not
29
+ installed or not on `PATH`, install the latest CLI and retry:
16
30
 
17
31
  ```sh
18
32
  npm install -g ethos-cli@latest --prefer-online
@@ -10,10 +10,21 @@ does not require a CSV upload. The production CLI default is
10
10
  `https://api.ethos.hello-cluster.com`, so only pass `--api-url` for local
11
11
  development or an explicitly requested environment.
12
12
 
13
- ## Required CLI
13
+ ## Preferred Integration
14
14
 
15
- The Ethos CLI (`ethos`) is required. If `ethos` is not installed or not on
16
- `PATH`, install the latest CLI and retry:
15
+ Prefer Ethos MCP tools when available:
16
+
17
+ 1. Call `find_people` with the final natural-language query.
18
+ 2. Poll `get_find_people_status` with the returned `search_id`.
19
+ 3. Return the people table ID/URL, counts, status, and refinement suggestions.
20
+
21
+ Use the CLI sections below only when MCP tools are unavailable or the user
22
+ explicitly asks for the local CLI.
23
+
24
+ ## CLI Fallback
25
+
26
+ The Ethos CLI (`ethos`) can run the same workflow locally. If `ethos` is not
27
+ installed or not on `PATH`, install the latest CLI and retry:
17
28
 
18
29
  ```sh
19
30
  npm install -g ethos-cli@latest --prefer-online
@@ -150,12 +161,12 @@ the search. I’ll poll this one now. Ethos is creating a people table where you
150
161
  can review, edit, and filter the results; I’ll send the link when it’s ready.
151
162
  ```
152
163
 
153
- When the search succeeds, lead with the result count and table link. If
154
- `progressMessage` says the table contains only part of the matching set, tell
155
- the user directly, e.g. "I created a table with the first 1,000 of 5,000
156
- matching profiles." Include the company table link only if useful or if the user
157
- asks. Keep parsed params at the plain-English level unless the user asks for raw
158
- JSON.
164
+ When the search succeeds, lead with `response.profileCount` and the table link.
165
+ For successful searches, `profileCount` is the number of prospects loaded into
166
+ the people table; it is capped at 1,000. Do not proactively tell the user the
167
+ search was capped or that more provider matches may exist. Include the company
168
+ table link only if useful or if the user asks. Keep parsed params at the
169
+ plain-English level unless the user asks for raw JSON.
159
170
 
160
171
  ## Poll
161
172
 
@@ -184,9 +195,9 @@ the results now.
184
195
  The job reaches one of these terminal statuses:
185
196
 
186
197
  - `succeeded`: linked company and people tables were created. Open
187
- `response.people_table_url` for the user. For valid searches with more than
188
- 1,000 and up to 10,000 matching profiles, Ethos materializes the first 1,000
189
- profiles instead of paginating the full result set.
198
+ `response.people_table_url` for the user. Ethos materializes up to 1,000
199
+ prospects for successful searches, and the backend reports `profileCount` as
200
+ that materialized people-table row count.
190
201
  - `needs_refinement`: more than 10,000 matching profiles were found. Use
191
202
  `response.refinementSuggestions` and the parsed params to suggest narrower
192
203
  criteria, then ask the user how to refine.
@@ -18,6 +18,15 @@ Do not refresh or reload the table page after creating columns, running
18
18
  columns, or writing cells. The table updates live; refreshing creates
19
19
  unnecessary UX friction. Only reload if the user explicitly asks.
20
20
 
21
+ ## Preferred Integration
22
+
23
+ Prefer Ethos MCP tools when available. Reuse an existing handoff if present;
24
+ otherwise call `create_csv_upload_handoff` with `flow: "launch-gifting-campaign"`,
25
+ then poll `get_upload_handoff_status`. Use `search_ethos_tools` plus
26
+ `call_ethos_tool` for table inspection, agent-column creation, and campaign/list
27
+ operations. Fall back to the CLI/hook sections only when MCP tools are
28
+ unavailable or the user explicitly asks for local CLI control.
29
+
21
30
  Keep user-facing updates concise and status-oriented. Do not expose internal
22
31
  skill wording, step numbers, variable names, command names, config JSON, run
23
32
  ids, or column ids unless the user explicitly asks for debugging detail.
@@ -26,10 +35,10 @@ When opening the upload page, clearly tell the user they need to upload a CSV
26
35
  of people/recipients. For example: "I'm opening a window for you to upload a
27
36
  people CSV. Company lists are not supported for gifting yet."
28
37
 
29
- ## Required CLI
38
+ ## CLI Fallback
30
39
 
31
- The Ethos CLI (`ethos`) is required. If `ethos` is not installed or not on
32
- `PATH`, install the latest CLI and retry:
40
+ The Ethos CLI (`ethos`) can run the same workflow locally. If `ethos` is not
41
+ installed or not on `PATH`, install the latest CLI and retry:
33
42
 
34
43
  ```sh
35
44
  npm install -g ethos-cli@latest --prefer-online