Skip to main content
Glama

List candidate segments

list_segments
Read-onlyIdempotent

[Candidates] List the company's candidate segments (dynamic, by rules, or static lists) with their size, or with segment_id one segment in full: rules, analytics and linked positions. list_candidates segment_id lists a segment's members.

Every argument in full, with examples: get_tool_reference.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_segments"
  }
}

Input Schema

NameRequiredDescriptionDefault
llm_modelNoYour model id, e.g. "claude-opus-4-8"; "unknown" if unsure. For analytics.
segment_idNoSegment id (a segment `id` from list_segments).
merchant_idNoOptional merchant to scope to. Admins and sub-merchant operators only; other callers always use their token's merchant.
conversation_idNoThe conversation_id this server returned earlier in this conversation, unchanged, including after later user messages. Omit it if you have none. Recorded for the server developer's analytics.

Output Schema

NameRequiredDescriptionDefault
dataYes
_mcp_instructionsNoServer-issued metadata for this conversation.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / segment_id / description
      Previous value: -"Segment id (profile_interview_segment.id)."New value: +"Segment id (a segment `id` from list_segments)."
  2. Changed58 schema fields changed
    • addedInput schema / properties / llm_model
      Added value: +{
      +  "description": "Your model id, e.g. \"claude-opus-4-8\"; \"unknown\" if unsure. For analytics.",
      +  "type": "string"
      +}
    • removedInput schema / properties / merchant_id / example
      Removed value: -"28106cba-1c27-4e53-b149-32113e5e8e31"
    • changedInput schema / properties / segment_id / description
      Previous value: -"Segment id (profile_interview_segment.id). With it, the answer holds that one segment with its rules, analytics and position links."New value: +"Segment id (profile_interview_segment.id)."
    • removedOutput schema / properties / data / description
      Removed value: -"Segments, last changed first; with segment_id, that one segment."
    • removedOutput schema / properties / data / items / properties / analytics / description
      Removed value: -"With segment_id only: counts over the members."
    • removedOutput schema / properties / data / items / properties / analytics / properties / applied_by_month / description
      Removed value: -"Applications of members in the last 12 months."
    • removedOutput schema / properties / data / items / properties / analytics / properties / applied_by_month / items / properties / count / description
      Removed value: -"Applications that month."
    • removedOutput schema / properties / data / items / properties / analytics / properties / applied_by_month / items / properties / month / description
      Removed value: -"YYYY-MM."
    • removedOutput schema / properties / data / items / properties / analytics / properties / applied_by_month / items / properties / month / example
      Removed value: -"2026-10"
    • removedOutput schema / properties / data / items / properties / analytics / properties / auto_tags / description
      Removed value: -"Members by automatic tag (recent_applicant, completed_interview, no_show, inactive_90d, ...)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / auto_tags / items / properties / count / description
      Removed value: -"Members with it."
    • removedOutput schema / properties / data / items / properties / analytics / properties / auto_tags / items / properties / key / description
      Removed value: -"The value (null: unknown)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_country / description
      Removed value: -"Members by country code."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_country / items / properties / count / description
      Removed value: -"Members with it."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_country / items / properties / key / description
      Removed value: -"The value (null: unknown)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_position / description
      Removed value: -"The 20 positions and interviews with the most members."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_position / items / properties / count / description
      Removed value: -"Members who applied or were invited."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_position / items / properties / id / description
      Removed value: -"Position id (position_def_set.id) or interview id (interview_def_set.id)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_position / items / properties / name / description
      Removed value: -"Its name."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_source / description
      Removed value: -"Members by source channel."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_source / items / properties / count / description
      Removed value: -"Members with it."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_source / items / properties / key / description
      Removed value: -"The value (null: unknown)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_status / description
      Removed value: -"Members by application status (invited, in_progress, completed, accepted, rejected, hired, declined, archived)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_status / items / properties / count / description
      Removed value: -"Members with it."
    • removedOutput schema / properties / data / items / properties / analytics / properties / by_status / items / properties / key / description
      Removed value: -"The value (null: unknown)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / reachable_email / description
      Removed value: -"Members who can be e-mailed (consent and address)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / reachable_sms / description
      Removed value: -"Members who can get a text message."
    • removedOutput schema / properties / data / items / properties / analytics / properties / recent_actions / description
      Removed value: -"The last 20 bulk actions run on this segment (read only)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / recent_actions / items / properties / created_at / description
      Removed value: -"When it started (ISO 8601)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / recent_actions / items / properties / done / description
      Removed value: -"Done."
    • removedOutput schema / properties / data / items / properties / analytics / properties / recent_actions / items / properties / failed / description
      Removed value: -"Failed."
    • removedOutput schema / properties / data / items / properties / analytics / properties / recent_actions / items / properties / finished_at / description
      Removed value: -"When it finished (ISO 8601)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / recent_actions / items / properties / id / description
      Removed value: -"Bulk action id (profile_interview_bulk_action.id)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / recent_actions / items / properties / kind / description
      Removed value: -"What the action did (invite, email, sms, whatsapp, tag, ...)."
    • removedOutput schema / properties / data / items / properties / analytics / properties / recent_actions / items / properties / skipped / description
      Removed value: -"Skipped."
    • removedOutput schema / properties / data / items / properties / analytics / properties / recent_actions / items / properties / status / description
      Removed value: -"Its state."
    • removedOutput schema / properties / data / items / properties / analytics / properties / recent_actions / items / properties / total / description
      Removed value: -"Candidates it covered."
    • removedOutput schema / properties / data / items / properties / analytics / properties / size / description
      Removed value: -"Members visible to you."
    • removedOutput schema / properties / data / items / properties / created_at / description
      Removed value: -"Created (ISO 8601)."
    • removedOutput schema / properties / data / items / properties / created_by_name / description
      Removed value: -"Who made it."
    • removedOutput schema / properties / data / items / properties / description / description
      Removed value: -"Description."
    • removedOutput schema / properties / data / items / properties / id / description
      Removed value: -"Segment id (profile_interview_segment.id)."
    • removedOutput schema / properties / data / items / properties / kind / description
      Removed value: -"dynamic: members are the candidates matching the rules now; static: a fixed list of candidates."
    • removedOutput schema / properties / data / items / properties / last_action_at / description
      Removed value: -"When a bulk action last ran on it (ISO 8601)."
    • removedOutput schema / properties / data / items / properties / links / description
      Removed value: -"With segment_id only: positions and interviews this segment feeds for re-engagement (read only; empty without the segments_v2 switch)."
    • removedOutput schema / properties / data / items / properties / links / items / properties / created_at / description
      Removed value: -"When the link was made (ISO 8601)."
    • removedOutput schema / properties / data / items / properties / links / items / properties / def_id / description
      Removed value: -"Position id (position_def_set.id) or interview id (interview_def_set.id)."
    • removedOutput schema / properties / data / items / properties / links / items / properties / def_kind / description
      Removed value: -"What def_id is."
    • removedOutput schema / properties / data / items / properties / links / items / properties / def_name / description
      Removed value: -"Its name."
    • removedOutput schema / properties / data / items / properties / links / items / properties / def_status / description
      Removed value: -"Its status."
    • removedOutput schema / properties / data / items / properties / links / items / properties / id / description
      Removed value: -"Link id (profile_interview_segment_position_link.id)."
    • removedOutput schema / properties / data / items / properties / links / items / properties / mode / description
      Removed value: -"Re-engagement mode: approval (a recruiter approves each invitation) or automatic."
    • removedOutput schema / properties / data / items / properties / member_count / description
      Removed value: -"Members visible to you."
    • removedOutput schema / properties / data / items / properties / name / description
      Removed value: -"Segment name."
    • removedOutput schema / properties / data / items / properties / rules / description
      Removed value: -"With segment_id only: the rules of a dynamic segment (static segments have none)."
    • removedOutput schema / properties / data / items / properties / rules / properties / match / description
      Removed value: -"all: a candidate matches every rule; any: at least one."
    • removedOutput schema / properties / data / items / properties / rules / properties / rules / description
      Removed value: -"Up to 20 rules, each { field, op, values | value | days | from | to }, as merchant-candidate-list (rules) accepts them; for example { \"field\": \"tag\", \"op\": \"any\", \"values\": [\"<tag id>\"] }."
    • removedOutput schema / properties / data / items / properties / updated_at / description
      Removed value: -"Last changed (ISO 8601)."
  3. Added

TDQS

A3.8/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=true, so the safety profile is covered. The description adds that the response shape changes with segment_id (sizes vs. full rules/analytics/positions), which is genuine behavioral context, but it says nothing about volume, paging, or the analytics-recording side effect of llm_model/conversation_id.

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?

Two tight sentences with the listing behavior front-loaded, followed by the segment_id variant and the sibling hand-off. The closing pointer to get_tool_reference is short and useful, though it is slightly boilerplate relative to the core content.

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

Completeness4/5

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

An output schema exists, so return values need not be spelled out, and the description covers both operating modes plus the sibling needed for member listing. Only edge concerns such as segment-list size or scoping via merchant_id are unaddressed, which is minor for a read-only four-parameter tool.

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

Parameters4/5

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

Schema coverage is 100%, so the parameter documentation baseline is 3, and the description goes beyond the schema by explaining that segment_id switches the tool from a listing into a full single-segment retrieval. That clarifies intent for the one semantically load-bearing optional parameter rather than merely restating its type.

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

Purpose4/5

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

Uses a specific verb (List) and a clearly bounded resource (candidate segments, including dynamic/rule-based/static variants) and explains the dual-mode behavior: no segment_id returns sizes, with segment_id returns rules, analytics and linked positions. It also names list_candidates as the tool for members, so the agent can distinguish it from that sibling, though its relationship to manage_segment is left implicit.

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?

Gives clear conditional routing: call it bare to enumerate segments with sizes, pass segment_id to get one segment in full, and use list_candidates with segment_id to get members. That is a concrete use/alternative mapping, but there is no explicit when-not-to-use or guidance against the write-oriented manage_segment.

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.