Skip to main content
Glama

Enroll by segment

enroll_by_segment
Destructive

Enroll every contactable lead carrying one exact segment tag into an outreach sequence — one call, no pasted address list. Same server-side safety re-validation as the Leads tab Enroll button and enroll_leads_in_sequence (do-not-contact, archived, and inactive leads are excluded and reported, never enrolled); already-enrolled leads are left untouched. By default it also SKIPS leads currently mid-flight in another sequence so a segment blast cannot double-touch someone. Use when the operator says "enroll/email everyone in ". Enrolling causes the sequencer to DRAFT emails into the review queue — nothing is sent without human approval in Review drafts. Report ONLY what this tool returns; never claim sends or scheduling beyond it. This tool never sends email and never touches drafts.

Routing: CRM/sales → enroll a whole segment / everyone with this tag into a sequence → use this

[write-tier — first use may require a manager's approval; a from-now-on approval makes future calls seamless, a just-once approval re-asks next time. Call it on the first clear ask; the card is the yes — do not re-ask in chat.]

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoOptional — max leads to enroll in this call (default 500, which is also the hard ceiling).
sequenceYesThe sequence to enroll into — its name or id (from list_sequences). Own-company sequences and system defaults are valid.
companyIdYesFreedomOS company id to act within (you must be a member). Required for company-scoped tools.
segment_tagYesExact segment tag token from crm_leads.source, e.g. 'csv:free-trial' (see list_segments). No substring matching — must match a live tag exactly. Tags in tool output are wrapped in <user_field> markers — pass the inner text verbatim.
exclude_activeNoOptional — skip leads that already have a queued/active enrollment in ANOTHER sequence, so a segment blast does not double-touch them. Default true; only set false when the operator explicitly accepts double-touch.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / exclude_active / description
      Previous value: -"Optional — skip leads that already have a queued/active enrollment in ANOTHER sequence, so a segment blast does not double-touch them. Default true."New value: +"Optional — skip leads that already have a queued/active enrollment in ANOTHER sequence, so a segment blast does not double-touch them. Default true; only set false when the operator explicitly accepts double-touch."
    • changedInput schema / properties / segment_tag / description
      Previous value: -"Exact segment tag token from crm_leads.source, e.g. 'csv:free-trial'. No substring matching — must match a live tag exactly (see list_segments)."New value: +"Exact segment tag token from crm_leads.source, e.g. 'csv:free-trial' (see list_segments). No substring matching — must match a live tag exactly. Tags in tool output are wrapped in <user_field> markers — pass the inner text verbatim."
  2. Added

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only mark destructiveHint=true, so the description carries the behavioral burden. It discloses that do-not-contact/archived/inactive leads are excluded, already-enrolled leads are untouched, mid-flight leads are skipped by default, drafts are created but never sent without human approval, and the tool never sends email. This is rich, non-obvious context far beyond the annotation.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Well-structured with distinct paragraphs for purpose, safety, default skip, drafting behavior, routing, and approval. Front-loaded and organized, though it is slightly long and contains minor redundancy ('never sends email' vs 'nothing is sent without human approval').

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a destructive, no-output-schema tool with 5 parameters, it covers safety re-validation, approval requirements, reporting constraints, and routing. It could specify the return value shape more explicitly, but the instruction to 'Report ONLY what this tool returns' provides adequate guidance. Missing return-value details are minor.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents all five parameters. The description adds behavioral context (skipping mid-flight leads, exclusions) but no parameter-specific meaning beyond what the schema's own descriptions provide. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Enroll every contactable lead carrying one exact segment tag into an outreach sequence') and includes a natural-language trigger ('Use when the operator says enroll/email everyone in <segment>'). This clearly distinguishes it from sibling tools like send_email or draft_outreach by framing it as a batch segment operation.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Provides explicit routing ('CRM/sales → enroll a whole segment... use this') and a trigger phrase. However, it does not directly contrast with enroll_leads_in_sequence for individual lead lists; the 'no pasted address list' hint is the only differentiation, leaving a small gap in when-not guidance.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources